Documentación/Referencia de API

API REFERENCE

Consultar una orden de cambio de divesas

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

Consultar una orden de cambio de divesas

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.

Esta API consulta la información de una orden de cambio de divesas.

Una vez creada y ejecutada una orden de cambio de divesas, utilice esta API para consultar su estado más reciente, los datos de ejecución y los detalles de las transacciones relacionadas.

Utilice una cuenta específica.

user=040268

ParámetroTipoDescripciónObligatorio
userStringA nivel de comercio UIDObligatorio
signStringSignatureObligatorio
methodStringv3.QueryFXOrderObligatorio
timeLongTimestampObligatorio
  • Parámetros
ParámetroTipoDescripciónObligatorio
trade_idStringID de cotizaciónObligatorio
request_idStringID de solicitud único; se recomienda una combinación de al menos 24 dígitos y letrasObligatorio

Ejemplo de firma:

Parámetros ordenados y concatenados en una cadena de consulta con formato de URL

"method=v3.QueryFXOrder&request_id=20304095064069023960369q-11&time=1546588959&trade_id=6e5cf660fb58455cd68a413a8249061a&user=040268"

Firme la cadena A con secret_key

La firma resultante es:

"YOUR_SIGNATURE"

Ejemplo de solicitud:

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

Ejemplo de respuesta:

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

Información adicional:

Resultado de la respuesta:
  1. Si la llamada se realiza correctamente, se devuelve "status": true es returned.
  2. Si la llamada falla, se devuelve "status": false es returned.
Códigos de respuesta:
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
StatusDescripción
successThe FX booking request was successfully processed and the order has been created or executed.
failedThe request failed due to an internal system error. Please retry later or contact technical support if the issue persists.
pendingThe request is pending because the request signature verification failed. Please verify the signature parameters and try again.
reversedThe request could not be processed because the specified user does not exist in the system.
rolledThe request was rejected because one or more required fields are missing in the request parameters.
updatedThe request ID provided is incorrect or does not match any existing transaction.
settlement_status:
StatusDescripción
openThe FX order has been successfully created and is awaiting settlement.
settledThe FX transaction has been fully settled and the funds have been delivered according to the agreed tenor.
pendingThe FX order has been created but settlement has not yet been completed. This may occur while waiting for the settlement date (e.g., SPOT T+2).
cancelledThe FX order has been cancelled and will not be settled.