API REFERENCE
Consultar uma ordem de câmbio
Parâmetros
| Parameter | Type | Descrição | Obrigatório |
|---|---|---|---|
| data.trade_id | string | 询价的id | ✓ |
| data.request_id | string | 请求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âmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| user | String | UID no nível do estabelecimento | Obrigatório |
| sign | String | Signature | Obrigatório |
| method | String | v3.QueryFXOrder | Obrigatório |
| time | Long | Timestamp | Obrigatório |
- Parameters
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| trade_id | String | ID da cotação | Obrigatório |
| request_id | String | ID de solicitação exclusivo; recomenda-se uma combinação de pelo menos 24 letras e números | Obrigató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:
- Se a chamada for bem-sucedida, "status": true será retornado.
- Se a chamada falhar, "status": false será retornado.
Response codes:
| Status | Code | Message |
|---|---|---|
| true | 200 | |
| false | -1000 | Internal error |
| false | -403 | The signature Error |
| false | -2001 | The user not exist |
| false | -3001 | Required field is missing |
| false | -4118 | Incorrect request ID |
booking_status
| Status | Descrição |
|---|---|
| success | A solicitação de reserva de câmbio foi processada com sucesso e a ordem foi criada ou executada. |
| failed | A 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. |
| pending | A solicitação está pendente porque a verificação da assinatura falhou. Verifique os parâmetros da assinatura e tente novamente. |
| reversed | A solicitação não pôde ser processada porque o usuário especificado não existe no sistema. |
| rolled | A solicitação foi rejeitada porque faltam um ou mais campos obrigatórios nos parâmetros da solicitação. |
| updated | O ID de solicitação informado está incorreto ou não corresponde a nenhuma transação existente. |
settlement_status:
| Status | Descrição |
|---|---|
| open | A ordem de câmbio foi criada com sucesso e aguarda liquidação. |
| settled | A transação de câmbio foi totalmente liquidada e os fundos foram entregues conforme o prazo acordado. |
| pending | A 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). |
| cancelled | A ordem de câmbio foi cancelada e não será liquidada. |
