Documentation/Référence API

API REFERENCE

Obtenir trade_id

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

Obtenir trade_id

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.

Paramètres

ParameterTypeDescriptionObligatoire
data.invoice_idstring单号✓

Obtenir trade_id à l’aide de invoice_id.

Conseil

Après la réussite d’une transaction, utilisez cette API pour obtenir le trade_id correspondant afin d’effectuer des opérations ultérieures, telles qu’une augmentation ou une diminution de l’autorisation, une capture, une consultation, une annulation ou un remboursement.

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

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

ParamètreTypeDescriptionObligatoire
userStringCompte caissier UIDObligatoire
signStringSignatureObligatoire
methodStringv3.GetTradeIdObligatoire
timeLongTimestampObligatoire
  • Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | invoice_id | String | Numéro de commande | Obligatoire |

Exemple de signature :

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

"invoice_id=1234567&method=v3.GetTradeId&time=1546588959&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.GetTradeId",
  "time": 1546588959,
  "data": {
    "invoice_id": "1234567"
  }
}

Exemple de réponse :

{
  "status": true,
  "code": "200",
  "data": {
    "trade_id": "2312e8b0-8ed5-6a66-293e-29efc206c599"
  },
  "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.

Codes de réponse :
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-4006Order number does not exist

Remarques

trade_id est généralement disponible environ 1 minute après la fin de la transaction.
Si l’erreur « Order number does not exist » est renvoyée, attendez environ 1 minute avant de réessayer.