Documentatie/API-referentie

API REFERENCE

Een valutawisselorder opvragen

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

Een valutawisselorder opvragen

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.

Deze API vraagt gegevens van een valutawisselorder op.

Nadat een valutawisselorder is aangemaakt en uitgevoerd, kunt u met deze API de meest recente status, uitvoeringsgegevens en bijbehorende transactiegegevens opvragen.

Gebruik een speciaal account.

user=040268

API-URL:https://mapi.yabandpay.com/Payments

Methode:POST

POST gegevenstype:Json

ParameterTypeBeschrijvingVerplicht
userStringMerchantniveau UIDVerplicht
signStringSignatureVerplicht
methodStringv3.QueryFXOrderVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
trade_idStringKoers-IDVerplicht
request_idStringUnieke aanvraag-ID; een combinatie van minimaal 24 cijfers en letters wordt aanbevolenVerplicht

Voorbeeld van een handtekening:

Parameters op volgorde samengevoegd tot een querystring in URL-stijl

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

Onderteken stringA met secret_key

De gegenereerde handtekening is:

"YOUR_SIGNATURE"

Voorbeeld van een aanvraag:

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

Voorbeeld van een antwoord:

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

Aanvullende informatie:

Resultaat van het antwoord:
  1. Bij een geslaagde aanroep wordt "status": true geretourneerd.
  2. Bij een mislukte aanroep wordt "status": false geretourneerd.
Antwoordcodes:
StatusCodeBericht
true200
false-1000Internal error
false-403The signature Error
false-2001The user not exist
false-3001Required field is missing
false-4118Incorrect request ID
booking_status
StatusBeschrijving
successDe valutaboeking is verwerkt en de order is aangemaakt of uitgevoerd.
failedDe aanvraag is mislukt door een interne systeemfout. Probeer het later opnieuw of neem contact op met de technische ondersteuning als het probleem aanhoudt.
pendingDe aanvraag is in behandeling omdat de verificatie van de aanvraaghandtekening is mislukt. Controleer de handtekeningparameters en probeer het opnieuw.
reversedDe aanvraag kon niet worden verwerkt omdat de opgegeven gebruiker niet in het systeem bestaat.
rolledDe aanvraag is afgewezen omdat een of meer verplichte velden in de aanvraagparameters ontbreken.
updatedDe opgegeven aanvraag-ID is onjuist of komt niet overeen met een bestaande transactie.
settlement_status:
StatusBeschrijving
openDe FX-order is aangemaakt en wacht op afwikkeling.
settledDe FX-transactie is volledig afgewikkeld en het geld is volgens de overeengekomen looptijd geleverd.
pendingDe FX-order is aangemaakt, maar de afwikkeling is nog niet voltooid. Dit kan gebeuren wanneer de afwikkelingsdatum nog niet is bereikt (bijvoorbeeld SPOT T+2).
cancelledDe FX-order is geannuleerd en wordt niet afgewikkeld.