Documentatie/API-referentie

API REFERENCE

Betaling annuleren

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

Betaling annuleren

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

Request parameters1

Required fields first

取消支付

trade_idRequiredstringdata.trade_idYabandPay订单编号

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

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

  1. 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.
  1. Bedrag: annulering geldt voor het volledige bedrag. Gedeeltelijk annuleren wordt niet ondersteund.
  1. Terugbetaling: een betaalorder kan niet worden geannuleerd als er een terugbetaling op is uitgevoerd.
  1. 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

ParameterTypeBeschrijvingVerplicht
userStringKassieraccount UIDVerplicht
signStringSignatureVerplicht
methodStringv3.CancelPaymentVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
trade_idStringYabandPay-ordernummerVerplicht

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:
  1. Bij een geslaagde annulering wordt "status": true geretourneerd.
  2. 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:
StatusCodeBericht
true200
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