Documentation/Référence API

API REFERENCE

Consulter un ordre de change

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

Consulter un ordre de change

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

Request parameters2

Required fields first

查询换汇订单

trade_idRequiredstringdata.trade_id询价的id
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.trade_idstring询价的id✓
data.request_idstring请求id需保持唯一,建议24以上位数字+字母✓

Cette API consulte les informations d’un ordre de change.

Après la création et l’exécution d’un ordre de change, utilisez cette API pour consulter son dernier statut, les informations d’exécution et les transactions associées.

Veuillez utiliser un compte dédié.

user=040268

ParamètreTypeDescriptionObligatoire
userStringUID au niveau du marchandObligatoire
signStringSignatureObligatoire
methodStringv3.QueryFXOrderObligatoire
timeLongTimestampObligatoire
  • Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | trade_id | String | ID de cotation | Obligatoire | | request_id | String | ID de requête unique ; une combinaison d’au moins 24 chiffres et lettres 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.QueryFXOrder&request_id=20304095064069023960369q-11&time=1546588959&trade_id=6e5cf660fb58455cd68a413a8249061a&user=040268"

Signer stringA avec secret_key

La signature obtenue est :

"YOUR_SIGNATURE"

Exemple de requête :

{
  "user": "040268",
  "sign": "YOUR_SIGNATURE",
  "method": "v3.QueryFXOrder",
  "time": 1546588959,
  "data": {
    "trade_id": "6e5cf660fb58455cd68a413a8249061a",
    "request_id": "20304095064069023960369q-11"
  }
}

Exemple de réponse :

{
  "status": true,
  "code": "200",
  "data": {
    "booking_status": "success",
    "settlement_status": "settled",
    "sell_currency": "GBP",
    "buy_currency": "DKK",
    "sold_currency": "GBP",
    "sold_amount": "1.00",
    "bought_currency": "DKK",
    "bought_amount": "8.54",
    "tenor": "TOD",
    "exchange_rate": "8.544924729",
    "order_id": "YOUR_ORDER_ID",
    "quote_id": "83e96dc0-8f8e-48c7-9bc4-6acc1019fced",
    "trade_id": "6e5cf660fb58455cd68a413a8249061a",
    "reference": "YB test"
  },
  "message": "",
  "response_id": "202603181711118835985708"
}

Informations complémentaires :

Résultat de la réponse :
  1. Si l’appel réussit, "status": true est renvoyé.
  2. Si l’appel échoue, "status": false est renvoyé.
Codes de réponse :
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-2001The user not exist
false-3001Required field is missing
false-4118Incorrect request ID
booking_status
StatusDescription
successLa demande de réservation de change a été traitée avec succès et l’ordre a été créé ou exécuté.
failedLa demande a échoué en raison d’une erreur interne du système. Réessayez plus tard ou contactez le support technique si le problème persiste.
pendingLa demande est en attente, car la vérification de la signature a échoué. Vérifiez les paramètres de signature et réessayez.
reversedLa demande n’a pas pu être traitée, car l’utilisateur indiqué n’existe pas dans le système.
rolledLa demande a été rejetée, car un ou plusieurs champs obligatoires sont absents des paramètres.
updatedL’ID de requête fourni est incorrect ou ne correspond à aucune transaction existante.
settlement_status :
StatusDescription
openL’ordre de change a été créé avec succès et attend son règlement.
settledLa transaction de change a été entièrement réglée et les fonds ont été livrés selon la durée convenue.
pendingL’ordre de change a été créé, mais le règlement n’est pas encore terminé. Cela peut se produire en attendant la date de règlement (par exemple, SPOT T+2).
cancelledL’ordre de change a été annulé et ne sera pas réglé.