Documentação/Referência da API

API REFERENCE

Consultar uma ordem de câmbio

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

Consultar uma ordem de câmbio

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.

Parâmetros

ParameterTypeDescriçãoObrigatório
data.trade_idstring询价的id✓
data.request_idstring请求id需保持唯一,建议24以上位数字+字母✓

Esta API consulta informações de ordens de câmbio.

Depois que uma ordem de câmbio for criada e executada, use esta API para consultar o status mais recente, as informações de execução e os detalhes de transações relacionadas.

Use uma conta dedicada.

user=040268

ParâmetroTipoDescriçãoObrigatório
userStringUID no nível do estabelecimentoObrigatório
signStringSignatureObrigatório
methodStringv3.QueryFXOrderObrigatório
timeLongTimestampObrigatório
  • Parameters
ParâmetroTipoDescriçãoObrigatório
trade_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

Signature example:

Parâmetros ordenados concatenados em uma cadeia de consulta no formato de URL

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

Sign stringA using secret_key

A assinatura resultante é:

"YOUR_SIGNATURE"

Request example:

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

Response example:

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

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 user not exist
false-3001Required field is missing
false-4118Incorrect request ID
booking_status
StatusDescrição
successA solicitação de reserva de câmbio foi processada com sucesso e a ordem foi criada ou executada.
failedA solicitação falhou devido a um erro interno do sistema. Tente novamente mais tarde ou entre em contato com o suporte técnico se o problema persistir.
pendingA solicitação está pendente porque a verificação da assinatura falhou. Verifique os parâmetros da assinatura e tente novamente.
reversedA solicitação não pôde ser processada porque o usuário especificado não existe no sistema.
rolledA solicitação foi rejeitada porque faltam um ou mais campos obrigatórios nos parâmetros da solicitação.
updatedO ID de solicitação informado está incorreto ou não corresponde a nenhuma transação existente.
settlement_status:
StatusDescrição
openA ordem de câmbio foi criada com sucesso e aguarda liquidação.
settledA transação de câmbio foi totalmente liquidada e os fundos foram entregues conforme o prazo acordado.
pendingA ordem de câmbio foi criada, mas a liquidação ainda não foi concluída. Isso pode ocorrer enquanto se aguarda a data de liquidação (por exemplo, SPOT T+2).
cancelledA ordem de câmbio foi cancelada e não será liquidada.