WeFact Hosting - Payment Provider



Beschikbare functies

Op deze pagina vindt u extra documentatie over enkele beschikbare functies die vanuit uw payment provider class optioneel te gebruiken zijn. Deze functies zorgen ervoor dat u eenvoudig een integratie kunt maken en niet rechtstreeks in de database bewerking moet doen.


Alle functies kunt u vanuit de class aanroepen, zoals bijvoorbeeld: $this->getCustomerData();


getCustomerData()

Haalt de klantgegevens op van de factuur of bestelling en geeft deze terug in een object. Indien geen klantgegevens gevonden kunnen worden, geeft de functie een 'false' terug.


Resultaat bij een geslaagde actie:
object(stdClass)#8 (8) {
  ["CompanyName"] => string(7) "Demo BV"
  ["Initials"] => string(3) "ABC"
  ["SurName"] => string(8) "de Vries"
  ["Address"] => string(12) "Demostraat 1"
  ["ZipCode"] => string(7) "1234 AB"
  ["City"] => string(8) "Demostad"
  ["Country"] => string(2) "NL"
  ["EmailAddress"] => string(12) "demo@demo.nl"
}


getType($transactionID)

Aan de hand van de transactieID worden de gegevens van de factuur of bestelling opgehaald. Onderstaande variabelen zijn beschikbaar na aanroep van deze functie, mits de functie geen 'false' heeft teruggegeven.


Variabele Beschrijving
$this->Type 'invoice' of 'order', afhankelijk van het object dat betaald wordt
$this->InvoiceID ID van de factuur die betaald wordt
$this->InvoiceCode Factuurnummer
$this->OrderID ID van de bestelling die betaald wordt
$this->OrderCode Bestelnummer
$this->Paid Boolean of de factuur betaald is
$this->Amount Bedrag in notatie:  #.##


loadConf()

Na aanroepen van deze functie worden de in WeFact ingestelde parameters beschikbaar.


Variabele Beschrijving
$this->conf['PaymentMethodID'] ID van de betaalmethode
$this->conf['MerchantID'] Ingestelde gebruikersnaam
$this->conf['Password'] Ingestelde wachtwoord


paymentFailed($transactionID)

Deze functie zal de online betaling van de factuur of bestelling annuleren.



paymentProcessed($transactionID)

Deze functie zal de succesvolle betaling van de factuur of bestelling verwerken. De factuur of bestelling wordt op betaald gezet.



paymentStatusUnknown($message = '')

Indien de status onbekend is, kan de klant worden doorverwezen naar het betaalscherm met een optionele foutmelding.



setInvoice($invoiceID)

Aan de hand van de $invoiceID worden de gegevens opgehaald van de factuur. Onderstaande variabelen zijn beschikbaar na aanroep van deze functie, mits de functie geen 'false' heeft teruggegeven.


Variabele Beschrijving
$this->Type Altijd de waarde 'invoice'
$this->InvoiceID ID van de factuur die betaald wordt
$this->InvoiceCode Factuurnummer
$this->Paid Boolean of de factuur betaald is
$this->TransactionID Transactiekenmerk van de factuur
$this->Amount Bedrag in notatie:  #.##


setOrder($orderID)

Aan de hand van de $orderID worden gegevens opgehaald van de bestelling. Onderstaande variabelen zijn beschikbaar na aanroep van deze functie, mits de functie geen 'false' heeft teruggegeven.


Variabele Beschrijving
$this->Type Altijd de waarde 'order'
$this->OrderID ID van de bestelling die betaald wordt
$this->Ordercode Bestelnummer
$this->Paid Boolean of de bestelling betaald is
$this->TransactionID Transactiekenmerk van de bestelling
$this->Amount Bedrag in notatie:  #.##


updateTransactionID($transactionID)

Deze functie slaat het transactiekenmerk op bij de betreffende factuur of bestelling.