All pages
Powered by GitBook
1 of 1

Loading...

Initialise FX quote request

Initialising an FX quote request refers to creating a request with the amount for the currency pair that you want to use.

Use case

Here we will initialise an FX quote request with sample data.

Use case data
API parameters with values

The path parameter is the technical ID of the account to which the payment is being made.

Currency details

Amount details

Tenor refers to the contract durations for trades.

The allowed value is TODAY. This means that the currency exchange rate on the day that the order is executed is applied.

Sample API call

To initialise the FX quote request, use the following endpoint:

Sample request

The sample request body is as follows:

{
  "sellCurrencyCode": "EUR",
  "buyCurrencyCode": "GBP",
  "money": {
    "amount": 30,
    "currencyCode": "EUR"
  },
  "tenor": "TODAY"
}
curl -X 'POST' \
  'https://payment-api.sandbox.tuumplatform.com/api/v1/accounts/ID-1026/fx-quotes/initialise' \
  -H 'accept: */*' \
  -H 'x-channel-code: SYSTEM' \
  -H 'x-tenant-code: MB' \
  -H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDctMTNUMTE6Mjc6NDMiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIuRVUiLCJleHAiOjE2ODkyNDc2NjN9.V62GKGz6hIMFF15n1IGnKpZTWtcTyPF0IC5pGfuToIU' \
  -H 'Content-Type: application/json' \
  -d '{
  "sellCurrencyCode": "EUR",
  "buyCurrencyCode": "GBP",
  "money": {
    "amount": 30,
    "currencyCode": "EUR"
  },
  "tenor": "TODAY"
}'

Sample response

Below you will find the response to the sample request:

Response
{
  "errors": null,
  "validationErrors": null,
  "data": {
    "quoteRequestId": "ID-1263",
    "accountId": "ID-1026",
    "accountNumber": {
      "value": "DK9189000099106120",
      "type": "IBAN"
    },
    "accountServiceProviderCode": "BC",
    "currencyPair": "EURGBP",
    "sellCurrencyCode": "EUR",
    "buyCurrencyCode": "GBP",
    "money": {
      "amount": 30,
      "currencyCode": "EUR"
    },
    "tenor": "TODAY",
    "comment": null,
    "source": null,
    "statusCode": "WAITING_QUOTE",
    "errorCode": null,
    "quoteDtime": "2023-07-13T11:06:14.780047Z",
    "tradeDate": "2025-04-07",
    "settlementDate": "2025-04-07",
    "quoteResponses": [],
    "requestReason": "FX"
  }
}

Result

https://payment-api.sandbox.tuumplatform.com/api/v1/accounts/ID-1026/fx-quotes/initialise

Learn more about the endpoint from the developer portal.

The quote request is created with a quote request ID and status code. The next step is to for the quote request.

".../ID-1026/fx-quotes/initialise"
"sellCurrencyCode": "EUR",
"buyCurrencyCode": "GBP"
"amount": {
    "amount": 30,
    "currencyCode": "EUR" }
"tenor": "TODAY"
initialise FX quote request
get the response ID