Documentation/Référence API

API REFERENCE

Créer un ordre de change

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

Créer un ordre de change

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

Request parameters4

Required fields first

创建换汇订单

order_idRequiredstringdata.order_id外汇订单id
quote_idRequiredstringdata.quote_id询价的id
request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母
Optional parameters 1
referenceOptionalstringdata.reference备注

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

Paramètres

ParameterTypeDescriptionObligatoire
data.order_idstring外汇订单id✓
data.quote_idstring询价的id✓
data.request_idstring请求id需保持唯一,建议24以上位数字+字母✓
data.referencestring备注—

Cette API crée un ordre de change.

Après avoir consulté le taux de change, vous devez exécuter l’ordre de change à l’aide de la valeur renvoyée quote_id dans un délai de 30 secondes.

Conseil

Après avoir obtenu quote_id, soumettez et exécutez l’ordre de change dans un délai de 30 secondes.

Si la cotation expire, appelez de nouveau l’API de consultation du taux de change pour en obtenir une nouvelle.

Veuillez utiliser un compte dédié.

user=040268

ParamètreTypeDescriptionObligatoire
userStringUID au niveau du marchandObligatoire
signStringSignatureObligatoire
methodStringv3.ExecuteFXOrderObligatoire
timeLongTimestampObligatoire
  • Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | order_id | String | ID de l’ordre de change | Obligatoire | | quote_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 | | reference | String | Remarks | Facultatif |

Exemple de signature :

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

"method=v3.ExecuteFXOrder&order_id=202603051019-16&quote_id=83e96dc0-8f8e-48c7-9bc4-6acc1019fced&reference=YB test&request_id=203040950640690239603690g-24&time=1546588959&user=040268"

Signer stringA avec secret_key

La signature obtenue est :

"YOUR_SIGNATURE"

Exemple de requête :

{
  "user": "040268",
  "sign": "YOUR_SIGNATURE",
  "method": "v3.ExecuteFXOrder",
  "time": 1546588959,
  "data": {
    "order_id": "YOUR_ORDER_ID",
    "quote_id": "83e96dc0-8f8e-48c7-9bc4-6acc1019fced",
    "reference": "YB test",
    "request_id": "203040950640690239603690g-24"
  }
}

Exemple de réponse :

{
  "status": true,
  "code": "200",
  "data": {
    "booking_status": "pending",
    "settlement_status": "pending",
    "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": "202603181703581985574708"
}

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 UID not exist
false-3001Required field is missing
false-4118Incorrect request ID