Documentação/Referência da API

API REFERENCE

Criar uma ordem de câmbio

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

Criar uma ordem de câmbio

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.

Parâmetros

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

Esta API cria uma ordem de câmbio.

Após consultar a taxa de câmbio, execute a ordem usando o quote_id retornado dentro de 30 segundos.

Dica

Depois de obter quote_id, envie e execute a ordem de câmbio dentro de 30 segundos.

Se a cotação expirar, chame novamente a API de consulta de taxa de câmbio para obter uma nova cotação.

Use uma conta dedicada.

user=040268

ParâmetroTipoDescriçãoObrigatório
userStringUID no nível do estabelecimentoObrigatório
signStringSignatureObrigatório
methodStringv3.ExecuteFXOrderObrigatório
timeLongTimestampObrigatório
  • Parameters
ParâmetroTipoDescriçãoObrigatório
order_idStringID da ordem de câmbioObrigatório
quote_idStringID da cotaçãoObrigatório
request_idStringID de solicitação exclusivo; recomenda-se uma combinação de pelo menos 24 letras e númerosObrigatório
referenceStringRemarksOpcional

Signature example:

Parâmetros ordenados concatenados em uma cadeia de consulta no formato de 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"

Sign stringA using secret_key

A assinatura resultante é:

"YOUR_SIGNATURE"

Request example:

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

Response example:

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

Additional information:

Response result:
  1. Se a chamada for bem-sucedida, "status": true será retornado.
  2. Se a chamada falhar, "status": false será retornado.
Response codes:
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-2001The UID not exist
false-3001Required field is missing
false-4118Incorrect request ID