Documentation/Référence API

API REFERENCE

Annulation d’une transaction

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

Annulation d’une transaction

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.

Paramètres

ParameterTypeDescriptionObligatoire
data.tidstring设备的TID✓
data.trade_idstringYabandPay订单编号✓
data.request_idstring请求id需保持唯一,建议24以上位数字+字母✓

S’applique aux paiements en personne sur terminal POS

Cette API lance, depuis le cloud, l’annulation d’une transaction réussie.

L’annulation de transaction ne prend en charge que les transactions du jour même et uniquement les annulations complètes.

Pour les annulations partielles ou les transactions des jours précédents, utilisez l’API de remboursement.

Après l’envoi d’une instruction d’annulation, le terminal POS affiche le déroulement et le résultat final en temps réel, afin que le marchand et l’utilisateur puissent confirmer immédiatement le statut. Pour une annulation silencieuse (sans affichage du déroulement sur le terminal POS), utilisez l’API d’annulation du paiement.

Avant d’appeler cette API, vérifiez que l’appareil POS est en ligne et disponible afin que l’instruction d’annulation puisse être transmise et traitée correctement.

URL de l’API (production) : https://mapi.yabandpay.com/Payments

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

ParamètreTypeDescriptionObligatoire
userStringTID de l’appareilObligatoire
signStringSignatureObligatoire
methodStringv3.POSReversalObligatoire
timeLongTimestampObligatoire
  • Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | tid | string | TID de l’appareil | Obligatoire | | trade_id | String | Numéro de commande YabandPay | Obligatoire | | request_id | String | ID de requête unique ; une combinaison de chiffres et de lettres d’au moins 24 caractères est recommandée | Obligatoire |

Exemple de signature :

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

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

Signer stringA avec secret_key

La signature obtenue est :

"YOUR_SIGNATURE"

Exemple de requête :

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

  }
} 

Exemple de réponse :

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

Informations complémentaires :

Résultat de la réponse :
  1. Une requête réussie renvoie "status": true.

  2. Une requête échouée renvoie "status": false.

Nous recommandons vivement d’utiliser à la fois les consultations de commande et les notifications asynchrones pour synchroniser et mettre à jour le statut de paiement, et ainsi garantir l’exactitude des informations de paiement en temps réel.

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