Documentação/Referência da API

API REFERENCE

Consultar a taxa de câmbio

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

Consultar a taxa de câmbio

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

Request parameters6

Required fields first

汇率查询

sell_currencyRequiredstringdata.sell_currency卖出货币
buy_currencyRequiredstringdata.buy_currency买入货币
currencyRequiredstringdata.currency卖出货币,currency如果和sell_currency相同则为卖出货币,否则为买入货币
amountRequiredstringdata.amount卖出货币金额,currency如果和sell_currency相同则为卖出货币金额,否则为买入货币金额
tenorRequiredstringdata.tenorTOD 或者 SPOT
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.sell_currencystring卖出货币✓
data.buy_currencystring买入货币✓
data.currencystring卖出货币,currency如果和sell_currency相同则为卖出货币,否则为买入货币✓
data.amountstring卖出货币金额,currency如果和sell_currency相同则为卖出货币金额,否则为买入货币金额✓
data.tenorstringTOD 或者 SPOT✓
data.request_idstring请求id需保持唯一,建议24以上位数字+字母✓

Esta API consulta taxas de câmbio.

Antes de criar uma ordem de câmbio, chame esta API para obter uma cotação e crie a ordem em até 30 segundos após recebê-la.

Observações

Dica

Observações

  1. Período de validade da cotação
    Cada cotação de taxa de câmbio retornada é válida por 30 segundos. Após expirar, consulte novamente a taxa de câmbio.

  2. Prazo de liquidação (Tenor)

  • TOD: liquidação em tempo real, não afetada por feriados.

  • SPOT: liquidação em T+2 dias úteis. Antes da data de liquidação, certifique-se de que a conta tenha fundos suficientes para a liquidação. Se a liquidação falhar por insuficiência de fundos, poderá ser cobrada uma penalidade com base na perda efetiva.

  1. Acesso a SPOT
    É necessário solicitar previamente o uso da liquidação SPOT, sujeita a limites de crédito.

Use uma conta dedicada.

user=040268

ParâmetroTipoDescriçãoObrigatório
userStringUID no nível do estabelecimentoObrigatório
signStringSignatureObrigatório
methodStringv3.GetFXQuoteObrigatório
timeLongTimestampObrigatório
  • Parameters
ParâmetroTipoDescriçãoObrigatório
sell_currencyStringMoeda a venderObrigatório
buy_currencyStringMoeda a comprarObrigatório
currencyStringMoeda a vender se a moeda corresponder a sell_currency; caso contrário, moeda a comprarObrigatório
amountStringValor a vender se a moeda corresponder a sell_currency; caso contrário, valor a comprarObrigatório
tenorStringTOD ou SPOTObrigató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

"amount=1&buy_currency=DKK&currency=GBP&method=v3.GetFXQuote&request_id=20304095064069023960369000g-42&sell_currency=GBP&tenor=TOD&time=1546588959&user=040268"

Sign stringA using secret_key

A assinatura resultante é:

"YOUR_SIGNATURE"

Request example:

{
  "user": "040268",
  "sign": "YOUR_SIGNATURE",
  "method": "v3.GetFXQuote",
  "time": 1546588959,
  "data": {
    "sell_currency": "GBP",
    "buy_currency": "DKK",
    "currency": "GBP",
    "amount": "1",
    "tenor": "TOD",
    "request_id": "20304095064069023960369000g-42"
  }
}

Response example:

{
  "status": true,
  "code": "200",
  "data": {
    "type": "sell",
    "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,
    "quote_id": "83e96dc0-8f8e-48c7-9bc4-6acc1019fced",
    "expiry_time": 1773824647
  },
  "message": "",
  "response_id": "202603181703362736334439"
}

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