API Reference
Client PortalAPI StatusWebsite

Execute a BCFX order

post
https://www.bankingcircleconnect.com/api/v2/fx/trading
Body Params
string
required
length between 3 and 35

Unique reference on your side identifying this order.

Banking Circle suggests using UUID without dashes as only alphanumeric characters are allowed.

string | null

Optional Banking Circle Customer Id in case you have multiple legal entities and want to override settlement account to a specific one - can be agreed with client services during onboarding

string
required
length between 3 and 5

Specify the currency to be bought

string
required
length between 3 and 5

Specify the currency to be sold

string
required
length between 3 and 5

Specify whether the order amount refers to the currency being bought or currency being sold.

If you specify buyCurrency as EUR and sellCurrency as USD, and you would like to buy 1000 EUR, then you should specify amountCurrency as EUR and amount as 1000.

If you would like to sell 1000 USD, you should specify amountCurrency as USD and amount as 1000

double
required
≥ 0.01

Specify the order amount. Minimum order amount is 0.01, maximum order amount is as agreed during your Banking Circle onboarding.

Note: The minimum amount applies for both your specified amount, the converted amount, and additionally, the EUR equivalent amount.

uuid | null

(Optional)

Only required in request-for-quote flow. For Market Orders this field can be omitted

Unique identifier of the quote, previously received through "fx-rates" endpoint.

Your order will be rejected if the quoteId is invalid or has expired.

string | null
enum

(Optional/Conditionally Required)

Required when executing a Market Order. In request-for-quote flow, the Tenor is derived from the requested quote. You may specify ON for value date today, TN for value date tomorrow, or SPOT for value date T+2

Allowed:
string | null

(Optional)

Specify the buy account by account technical identifier, account number or IBAN.

If no input, default(main) account is selected.

string | null

(Optional)

Specify the sell account by account technical identifier, account number or IBAN.

If no input, default(main) account is selected.

string | null

(Optional)

Freetext field if you would like to attach any additional information to this trade, for example the purpose of the trade.

Responses

Updated 7 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated 7 months ago