API REFERENCE
Gegevens van trade_id ophalen
Vraag trade_id op met invoice_id.
Tip
Gebruik deze API na een geslaagde transactie om de bijbehorende
trade_idop te halen voor vervolgacties, zoals autorisatie verhogen of verlagen, opvragen, terugdraaien of terugbetalen.
API-URL (productie): https://mapi.yabandpay.com/Payments
API-URL (test): https://acc-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.GetTradeId | Verplicht |
| time | Long | Timestamp | Verplicht |
- Parameters
| Parameter | Type | Beschrijving | Verplicht |
|---|---|---|---|
| invoice_id | String | Ordernummer | Verplicht |
Voorbeeld van een handtekening:
Parameters op volgorde samengevoegd tot een querystring in URL-stijl
"invoice_id=1234567&method=v3.GetTradeId&time=1546588959&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.GetTradeId",
"time": 1546588959,
"data": {
"invoice_id": "1234567"
}
}
Voorbeeld van een antwoord:
{
"status": true,
"code": "200",
"data": {
"trade_id": "2312e8b0-8ed5-6a66-293e-29efc206c599"
},
"message": ""
}
Aanvullende informatie:
Resultaat van het antwoord:
-
Bij een geslaagde aanvraag wordt "status": true geretourneerd.
-
Bij een mislukte aanvraag wordt "status": false geretourneerd.
Antwoordcodes:
| Status | Code | Bericht |
|---|---|---|
| true | 200 | |
| false | -1000 | Internal error |
| false | -403 | The signature Error |
| false | -4006 | Order number does not exist |
Opmerkingen
trade_id is doorgaans ongeveer 1 minuut na voltooiing van de transactie beschikbaar.
Als de fout "Ordernummer bestaat niet" wordt geretourneerd, wacht dan ongeveer 1 minuut voordat u het opnieuw probeert.
