Dokumentation/API-Referenz

API REFERENCE

FX-Auftrag abfragen

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

FX-Auftrag abfragen

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.

Diese API fragt Informationen zu einem FX-Auftrag ab.

Nachdem ein FX-Auftrag erstellt und ausgeführt wurde, verwenden Sie diese API, um seinen aktuellen Status, Ausführungsinformationen und zugehörige Transaktionsdetails abzufragen.

Verwenden Sie bitte ein dediziertes Konto.

user=040268

ParameterTypBeschreibungErforderlich
userStringHändlerbezogenes UIDErforderlich
signStringSignatureErforderlich
methodStringv3.QueryFXOrderErforderlich
timeLongTimestampErforderlich
  • Parameter
ParameterTypBeschreibungErforderlich
trade_idStringKurs-IDErforderlich
request_idStringEindeutige Anfrage-ID; empfohlen wird eine Kombination aus mindestens 24 Ziffern und BuchstabenErforderlich

Signaturbeispiel:

Die sortierten Parameter werden zu einer URL-ähnlichen Abfragezeichenfolge verkettet.

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

Signieren Sie stringA mit secret_key.

Die resultierende Signatur lautet:

"YOUR_SIGNATURE"

Anfragebeispiel:

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

Antwortbeispiel:

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

Weitere Informationen:

Antwortergebnis:
  1. Bei erfolgreichem Aufruf wird "status": true zurückgegeben.
  2. Bei fehlgeschlagenem Aufruf wird "status": false zurückgegeben.
Antwortcodes:
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
StatusBeschreibung
successDie FX-Buchungsanfrage wurde erfolgreich verarbeitet; der Auftrag wurde erstellt oder ausgeführt.
failedDie Anfrage ist aufgrund eines internen Systemfehlers fehlgeschlagen. Versuchen Sie es später erneut oder wenden Sie sich an den technischen Support, wenn das Problem weiterhin besteht.
pendingDie Anfrage steht aus, weil die Signaturprüfung fehlgeschlagen ist. Prüfen Sie die Signaturparameter und versuchen Sie es erneut.
reversedDie Anfrage konnte nicht verarbeitet werden, weil der angegebene Nutzer nicht im System vorhanden ist.
rolledDie Anfrage wurde abgelehnt, weil mindestens ein erforderliches Feld in den Anforderungsparametern fehlt.
updatedDie angegebene Anfrage-ID ist falsch oder gehört zu keiner vorhandenen Transaktion.
settlement_status:
StatusBeschreibung
openDer FX-Auftrag wurde erfolgreich erstellt und wartet auf die Abrechnung.
settledDie FX-Transaktion wurde vollständig abgerechnet und die Mittel wurden gemäß der vereinbarten Laufzeit bereitgestellt.
pendingDer FX-Auftrag wurde erstellt, aber noch nicht vollständig abgerechnet. Dies kann etwa beim Warten auf das Abrechnungsdatum auftreten (z. B. SPOT T+2).
cancelledDer FX-Auftrag wurde storniert und wird nicht abgerechnet.