API betaalverzoeken

De beschikbare API calls voor het aanmaken van betaalverzoeken en het uitlezen van de status.

ReturnUrl

Vanaf versie 1.12 is het mogelijk om een ReturnUrl op te geven in een API verzoek. Indien gewenst kan voor elk betaalverzoek een eigen link gebruikt worden. De ReturnUrl kunnen we ook op organisatie niveau toevoegen. Op deze manier zijn er meerdere opties beschikbaar.

Info

Let op dat als je de returnUrl meeneemt in je APi verzoek deze wel gevuld is met een geldige link.

Aanmaken verzoek

We kunnen nu een payment request aanmaken. Open de body om het betaalverzoek naar eigen inzicht aan te passen.

• Amount: Bedrag. Punt gebruiken voor decimaal.
• RemittanceInformation: Omschrijving van het betaalverzoek
• ReturnUrl: (Optioneel). Bevat een weblink waar eindgebruikers naartoe gestuurd worden na betaling van het verzoek.

Input

Zonder returnUrl

{{BaseUrl}}/v2/payment-request

{
"Amount": 24.95,
"RemittanceInformation": "Postman: Green Tea Extract 548755",
 }

Met returnUrl

{{BaseUrl}}/v2/payment-request

{
"Amount": 24.95,
"RemittanceInformation": "Postman: Green Tea Extract 548756",
"ReturnUrl": "https://nidaros.nl"
 }

Na het betalen of afkeuren van dit verzoek wordt je automatisch doorgestuurd naar

{returnUrl}/?authorizationCode=4da3eb52-xxxxx-48e6-xxxx-e35009ddbbdc

De authorizationCode is terug te vinden in het initiële betaalverzoek.

Response

Vanaf versie 1.12 is de AuthorizationCode toegevoegd in de response. Indien gebruik gemaakt wordt van de ReturnUrl wordt de AuthorizationCode.

{
    "PaymentRequestId": 3,
    "Amount": 24.95,
    "AmountCurrency": "€ 24,95",
    "RemittanceInformation": "Postman: Green Tea Extract 18176477",
    "AuthorizationUrl": "https://xxxxxxxx",
    "AuthorizationCode": "4da3eb52-xxxxx-48e6-xxxx-e35009ddbbdc"
}

Betaalstatus

De beschikbare API calls om betaalverzoek statussen op te halen. De beschikbare statussen van een betaalverzoek.

Status	Betaalverzoek status	API code
	Aangemaakt	Code: 0
	In behandeling	Code: 1
	Betaald	Code: 2
	Niet betaald	Code: 3
	Fout	Code: 4

Status Check

{{BaseUrl}}/v2/payment-request/{{PaymentRequestId}}/status

Status Response

Tip

Als je een ander requestId wil uitlezen, dan kun je ook de environment variabele CreatedPaymentRequestId aanpassen of de variabele aanpassen naar het PaymentRequestId wat je wil uitlezen.