Forex Get Started

Forex trade

Below is an example where you are buying 1,000 EUR by GBP

Get Fx Quote

request

POST /fx/quote
{
    "walletId": "WA1426785367490592",
    "sellCcy": "USD",
    "buyCcy": "EUR",
    "amount": 1000,
    "amountSide": "BUY"
}

response

{
  "id": "QT1632092372860961",
  "sellCcy": "USD",
  "sellAmount": 1088.72,
  "buyCcy": "EUR",
  "buyAmount": 1000,
  "fixedSide": "BUY",
  "sellRate": 0.91850826,
  "valueDate": "2024-08-29",
  "createdTime": "2024-08-29 18:24:49",
  "ttl": 600
}

Create Fx Order

request

POST /fx/order
{
    "walletId": "WA1426785367490592",
    "fromAccountId": "AC1426789347885088",
    "toAccountId": "AC1426788133634080",
    "fxQuoteId": "QT1632092372860961",
    "requestId": "d1ffc915-0fca-4762-9b72-af7f5b84efa6"
}

response

{
  "id": "FX1632092796485665",
  "requestId": "d1ffc915-0fca-4762-9b72-af7f5b84efa6",
  "walletId": "WA1426785367490592",
  "sellCcy": "USD",
  "sellAmount": 1088.72,
  "buyCcy": "EUR",
  "buyAmount": 1000.0,
  "fixedSide": "BUY",
  "sellRate": 0.91850826,
  "valueDate": "2024-08-29",
  "status": "Processing",
  "createdTime": "2024-08-30 02:28:11",
  "updatedTime": null
}

Get Fx Order

request

GET /fx/order/{fxOrderId}

response

{
  "id": "FX1632092796485665",
  "requestId": "d1ffc915-0fca-4762-9b72-af7f5b84efa6",
  "walletId": "WA1426785367490592",
  "sellCcy": "USD",
  "sellAmount": 1088.72,
  "buyCcy": "EUR",
  "buyAmount": 1000.0,
  "fixedSide": "BUY",
  "sellRate": 0.91850826,
  "valueDate": "2024-08-29",
  "status": "Completed",
  "createdTime": "2024-08-30 02:28:12",
  "updatedTime": "2024-08-30 02:28:13"
}

Webhook callback events of Forex

eventType: Forex
referenceId: id of the fx order
event values:

FxCompleted

FxFailed

Callback event example:

{
  "eventId": "ET1235430036680001",
  "eventType": "Forex",
  "event": "FxCompleted",
  "referenceId": "FX1591157953921056",
  "description": ""
}

Forex trade#

Webhook callback events of Forex#

Forex trade

Webhook callback events of Forex