API REFERENCE
Betaling annuleren
Deze API annuleert betaalorders, waaronder onbetaalde, betaalde en succesvol geautoriseerde orders.
Als u het definitieve betalingsresultaat van YabandPay (geslaagd of mislukt) nog niet hebt ontvangen, of een betaalorder wilt sluiten, roept u deze API aan om de order te annuleren.
Tip
- Tijdslimiet: betaalorders kunnen alleen binnen het opgegeven venster worden geannuleerd, vanaf het begin van de transactie tot 00:30 op de volgende dag (T+1 dag 00:30), Midden-Europese tijd.
- Bedrag: annulering geldt voor het volledige bedrag. Gedeeltelijk annuleren wordt niet ondersteund.
- Terugbetaling: een betaalorder kan niet worden geannuleerd als er een terugbetaling op is uitgevoerd.
- Verrekening en kosten: geannuleerde betaalorders worden niet verrekend of afgerekend en YabandPay brengt geen transactiekosten in rekening.
API-URL:https://mapi.yabandpay.com/Payments
Methode:POST
POST gegevenstype:Json
| Parameter | Type | Beschrijving | Verplicht |
|---|---|---|---|
| user | String | Kassieraccount UID | Verplicht |
| sign | String | Signature | Verplicht |
| method | String | v3.CancelPayment | Verplicht |
| time | Long | Timestamp | Verplicht |
- Parameters
| Parameter | Type | Beschrijving | Verplicht |
|---|---|---|---|
| trade_id | String | YabandPay-ordernummer | Verplicht |
Voorbeeld van een handtekening:
Parameters op volgorde samengevoegd tot een querystring in URL-stijl
"method=v3.CancelPayment&time=1546588959&trade_id=4a49ffb3-a30f-ba92-9422-1969afb6f121&user=YOUR_CASHIER_UID"
Onderteken stringA met secret_key
De gegenereerde handtekening is:
"YOUR_SIGNATURE"
Voorbeeld van een aanvraag:
{
"user": "YOUR_CASHIER_UID",
"sign": "YOUR_SIGNATURE",
"method": "v3.CancelPayment",
"time": 1546588959,
"data": {
"trade_id": "4a49ffb3-a30f-ba92-9422-1969afb6f121"
}
}
Voorbeeld van een antwoord:
{
"status": true,
"code": "200",
"data": {
"type": "payment",
"user": "YOUR_CASHIER_UID",
"amount": "0.10",
"currency": "EUR",
"trade_id": "4a49ffb3-a30f-ba92-9422-1969afb6f121",
"description": "YabandPay test",
"order_id": "YOUR_ORDER_ID",
"createDate": "1706771212",
"demo": "test",
"transaction_id": "",
"state": "cancelled"
},
"message": ""
}
Aanvullende informatie:
Resultaat van het antwoord:
- Bij een geslaagde annulering wordt "status": true geretourneerd.
- Bij een mislukte annulering wordt "status": false geretourneerd.
Roep Order opvragen aan om de orderstatus te controleren. Als de orderstatus state gelijk is aan cancelled, is de annulering geslaagd.
Antwoordcodes:
| Status | Code | Bericht |
|---|---|---|
| true | 200 | |
| false | -4111 | Exceed cancel window |
| false | -4112 | The transaction has been cleared cannot be cancelled |
| false | -4114 | The trade_id does not exist |
| false | -4115 | The transaction cannot be cancelled |
| false | -4116 | The transaction has been cancelled |
| false | -4117 | The transaction has been Expired |
