Documentatie/API-referentie

API REFERENCE

Gegevens van trade_id ophalen

POSThttps://mapi.yabandpay.com/Payments
Live API
API PLAYGROUND · Live API

Gegevens van trade_id ophalen

POSThttps://mapi.yabandpay.com/Payments
Automatically signed with your credentials

Request parameters1

Required fields first

获取trade_id

invoice_idRequiredstringdata.invoice_id单号

Credentials stay on this page. Your secret key is never stored or sent to the documentation server.

Vraag trade_id op met invoice_id.

Tip

Gebruik deze API na een geslaagde transactie om de bijbehorende trade_id op 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

ParameterTypeBeschrijvingVerplicht
userStringKassieraccount UIDVerplicht
signStringSignatureVerplicht
methodStringv3.GetTradeIdVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
invoice_idStringOrdernummerVerplicht

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:
  1. Bij een geslaagde aanvraag wordt "status": true geretourneerd.

  2. Bij een mislukte aanvraag wordt "status": false geretourneerd.

Antwoordcodes:
StatusCodeBericht
true200
false-1000Internal error
false-403The signature Error
false-4006Order 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.