Documentatie/API-referentie

API REFERENCE

Transactie annuleren

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

Transactie annuleren

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

Request parameters3

Required fields first

交易取消

tidRequiredstringdata.tid设备的TID
trade_idRequiredstringdata.trade_idYabandPay订单编号
request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母

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

Van toepassing op betalingen met een fysieke POS-terminal

Deze API initieert via de cloud de annulering van onbetaalde bestellingen.

Hiermee wordt het betaalscherm op de terminal gesloten, zodat het systeem een nieuw transactie-verzoek kan starten.

API-URL (productie): https://mapi.yabandpay.com/Payments

API-URL (test): https://acc-mapi.yabandpay.com/Payments

Methode:POST

POST gegevenstype:Json

ParameterTypeBeschrijvingVerplicht
userStringApparaat-TIDVerplicht
signStringSignatureVerplicht
methodStringv3.POSCancelVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
tidstringApparaat-TIDVerplicht
trade_idStringYabandPay-bestelnummerVerplicht
request_idStringUnieke aanvraag-ID; aanbevolen wordt een combinatie van cijfers en letters van ten minste 24 tekensVerplicht

Handtekeningvoorbeeld:

Gesorteerde parameters aaneengevoegd tot een queryreeks in URL-stijl

 "method=v3.POSReversal&request_id=a7z1lox4l6z6mdx1udgn5gtezasze1x0&tid=T125119061&time=1555498137&trade_id=4a49ffb3-a30f-ba92-9422-1969afb6f121&user=T125119061" 

Onderteken stringA met secret_key

De resulterende handtekening is:

"YOUR_SIGNATURE"

Aanvraagvoorbeeld:

 {
  "user": "T125119061",
  "sign": "YOUR_SIGNATURE",
  "method": "v3.POSCancel",
  "time": 1555498137,
  "data": {
   "tid": "T125119061",
		"trade_id": "4a49ffb3-a30f-ba92-9422-1969afb6f121",
    "request_id": "a7z1lox4l6z6mdx1udgn5gtezasze1x0"

  }
} 

Antwoordvoorbeeld:

{
  "status": true,
  "code": "200",
  "data": {
        "type": "payment",
        "user": "T125119061",
        "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:
  1. Een geslaagde aanvraag retourneert "status": true.

  2. Een mislukte aanvraag retourneert "status": false.

We raden sterk aan om zowel bestellingen op te vragen als asynchrone meldingen te gebruiken om de betalingsstatus te synchroniseren en bij te werken, zodat betalingsinformatie in realtime actueel blijft.

Antwoordcodes:
StatusCodeBericht
true200
false-3001Required field is missing
false-3002duplicate request_id
false-4111Exceed cancel window
false-4112The transaction has been cleared cannot be cancelled
false-4114The trade_id does not exist
false-4115The transaction cannot be cancelled
false-4116The transaction has been cancelled
false-4117The transaction has been Expired