Request an FX rate

POST 
/api/deal_request

This endpoint allows users to request an FX (foreign exchange) rate based on provided parameters such as currency pair and amounts.

Request

Header Parameters

Unique-Request-Id string

Possible values: <= 50 characters

An optional unique identifier for the request, limited to 50 characters. Used to track requests and prevent duplication.

application/json

Body

required

currencyFrom stringrequired
currencyTo stringrequired
amountTo stringnullable

Possible values: Value must match regular expression ^(\d+.\d\d)$

amountFrom stringnullable

Possible values: Value must match regular expression ^(\d+.\d\d)$

valueDate date-timerequired

Responses

201

Created - The request was processed successfully.

application/json

Schema

Schema

id string
currencyFrom stringnullablerequired
currencyTo stringnullablerequired
amountFrom stringnullable

Possible values: Value must match regular expression ^(\d+.\d\d)$

amountTo stringnullable

Possible values: Value must match regular expression ^(\d+.\d\d)$

valueDate stringrequired
spotRate stringnullable
platformRate stringnullable
forwardPoints stringnullable

Example (from schema)

{
  "id": 1,
  "currencyFrom": "CHF",
  "currencyTo": "EUR",
  "amountFrom": "100.00",
  "amountTo": "105.53",
  "valueDate": "2023-01-01T00:00:00+00:00",
  "spotRate": "1.0553",
  "platformRate": "1.0553",
  "forwardPoints": "1.0553"
}

400

Bad Request -- Your request is invalid.

application/json

Schema

Schema

title stringnullable

A short, human-readable summary of the problem.

detail stringnullable

A human-readable explanation specific to this occurrence of the problem.

status numbernullable

Default value: 400

instance stringnullable

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

type string

A URI reference that identifies the problem type

Example (from schema)

{
  "title": "string",
  "detail": "string",
  "status": 400,
  "instance": "string",
  "type": "string"
}

401

Unauthorised -- Your access token is wrong.

application/json

Schema

Schema

type string
title string
detail string

Example (from schema)

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

403

Forbidden -- Access to the requested resource or action is forbidden.

application/json

Schema

Schema

type string
title string
detail string

Example (from schema)

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

422

Unprocessable Content -- We could not process your request due to invalid data provided.

application/json

Schema

Schema

status integer

Default value: 422

violations object[]
Array [
propertyPath stringrequired
The property path of the violation
message stringrequired
The message associated with the violation
code string
The code of the violation
hint string
An extra hint to understand the violation
payload object
The serialized payload of the violation
property name* any
The serialized payload of the violation
]
detail string
type string
title stringnullable
instance stringnullable

Example (from schema)

{
  "status": 422,
  "violations": [
    {
      "propertyPath": "string",
      "message": "string",
      "code": "string",
      "hint": "string",
      "payload": {}
    }
  ],
  "detail": "string",
  "type": "string",
  "title": "string",
  "instance": "string"
}

Loading...