Documentation/Référence API

API REFERENCE

Annuler un paiement

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

Annuler un paiement

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.

Paramètres

ParameterTypeDescriptionObligatoire
data.trade_idstringYabandPay订单编号✓

Cette API annule les ordres de paiement, notamment ceux qui n’ont pas été payés, qui ont été payés ou qui ont été autorisés avec succès.

Si vous n’avez pas encore reçu le résultat final du paiement par YabandPay (succès ou échec), ou si vous souhaitez clôturer un ordre de paiement, appelez cette API pour l’annuler.

Conseil

  1. Délai : les ordres de paiement ne peuvent être annulés que pendant la période prévue, du lancement de la transaction jusqu’à 00:30 le lendemain (jour T+1, à 00:30), heure d’Europe centrale.
  1. Restriction sur le montant : l’annulation doit porter sur le montant total. L’annulation partielle n’est pas prise en charge.
  1. Restriction liée aux remboursements : un ordre de paiement ne peut pas être annulé si une opération de remboursement a été effectuée.
  1. Règlement et frais : les ordres de paiement annulés ne sont ni compensés ni réglés, et YabandPay ne facture aucuns frais de transaction.
ParamètreTypeDescriptionObligatoire
userStringCompte caissier UIDObligatoire
signStringSignatureObligatoire
methodStringv3.CancelPaymentObligatoire
timeLongTimestampObligatoire
  • Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | trade_id | String | Numéro de commande YabandPay | Obligatoire |

Exemple de signature :

Paramètres triés et concaténés dans une chaîne de requête au format URL

"method=v3.CancelPayment&time=1546588959&trade_id=4a49ffb3-a30f-ba92-9422-1969afb6f121&user=YOUR_CASHIER_UID"

Signer stringA avec secret_key

La signature obtenue est :

"YOUR_SIGNATURE"

Exemple de requête :

{
    "user": "YOUR_CASHIER_UID",
	"sign": "YOUR_SIGNATURE",
	"method": "v3.CancelPayment",
	"time": 1546588959,
	"data": {
		"trade_id": "4a49ffb3-a30f-ba92-9422-1969afb6f121"
    }
}

Exemple de réponse :

{
    "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": ""
}

Informations complémentaires :

Résultat de la réponse :
  1. Si l’annulation réussit, "status": true est renvoyé.
  2. Si l’annulation échoue, "status": false est renvoyé.

Appelez Consultation de commande pour vérifier le statut de la commande. Si le statut state de la commande vaut cancelled, l’annulation a réussi.

Codes de réponse :
StatusCodeMessage
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