U bent hier:

API

Geautomatiseerd werken via API

U kunt geautomatiseerd met het PayByLink platform werken en automatisch transacties, automatische incasso's en mandates aanleveren. Al deze functies zijn in 1 API beschikbaar.

Het enige wat u hoeft te doen is een in PayByLink een API gebruiker aan te maken, een wachtwoord voor authenticatie in te voeren en op te geven van welke IP-adressen de communicatie plaatsvindt. Dan bent u klaar voor het geautomatiseerd werken.

De API call log geeft u inzicht in de API calls

De API-functionaliteit is voorzien van een API call log. In deze log kunt de datum en tijd van het API bericht zien, de gebruikersnaam van de API user en het IP-adres. Daarnaast kunt u deze logfile raadplegen in het geval er een foutmelding optreedt.

API voor zoeken van betalingen op basis van een (deel van een) Order-ID

Naam
Omschrijving Verplicht
entityKey De sleutel van het account waarbinnen gezocht wordt Ja
orderId Het (deel van) het order id waar betalingen voor gezocht worden Ja (minimaal 5 karakters)
exactSearch True = Zoek naar het EXACTE order id (default)
False = Zoek naar een order id waar de meegegeven waarde in voorkomt

Nee (default = True)

getChildPaymentsToo True = Zoek ook in betalingen waar dit account de 'parent' van is
False = Zoek alleen binnen dit account
Nee (default = False)
getPspPayments True = Geef van de gevonden betalingen ook de PSP-betalingen terug
False = Geef geen PSP-betalingen terug
Nee (default = False)
getApiParameters True = Geef van de gevonden betalingen ook alle API-parameters terug
False = Geef geen API-parameters terug
Nee (default = False)
dateFrom De aanmaakdatum van waaraf moet worden gezocht
Formaat: 'yyyy-mm-dd HH:mm'
Nee (default = 6 maanden terug)
dateTo De uiterste aanmaakdatum van de betaling waarnaar wordt gezocht
Formaat: 'yyyy-mm-dd HH:mm' (max. 6 maanden na de 'dateFrom')
Nee (default = 'nu')

Bijvoorbeeld:
Deze aanroep geeft alle betalingen terug voor enkel het account met de entity key ‘8f9e8dad-530a-4dd7-9e95-a865f1fb5994’ waarbij in het order id de waarde ‘12345’ voorkomt:
testapi.paybylink.com/payment/search/8f9e8dad-530a-4dd7-9e95-a865f1fb5994

Trust Guard