Aanroep en antwoord

De verschillende functies van de API kennen allemaal een zelfde basisverloop. U doet een request bij de API en ontvangt een antwoord. Op basis van dat antwoord worden activiteiten ondernomen, zoals het doorsturen van de klant naar een website of het laten bellen naar een telefoonnummer. Na afloop van die activiteiten ontvangt u een terugkoppeling met het resultaat van de transactie. Dit proces is schematisch als volgt weer te geven:

Op deze pagina wordt ingegaan op de eerste aanroep en het antwoord dat u daarop ontvangt. De terugkoppeling heeft een eigen hoofdstuk.

Aanroep

Bij het aanroepen van een functie geeft u uw customerID mee. Deze kunt u vinden op de pagina Profiel --> API. Daarnaast kunt u een eigen referentie meegeven. Deze kunt u gebruiken om de transactie binnen uw systeem te herkennen. Bij elke terugkoppeling wordt de referentie weer meegezonden.

Antwoord

In elk antwoord dat u ontvangt bij het aanroepen van een API-functie zit algemeen gedeelte met een statuscode en een statusbeschrijving. Deze geeft aan of uw aanroep geslaagd is en, wanneer dat niet zo is, waarom de aanroep geweigerd is.

Daarnaast bevat elk antwoord een specifiek gedeelte dat voor elke functie anders is.

Overzicht statuscodes antwoord