API Reference
Client PortalAPI StatusWebsite
Start typing to search…

Post FX transactions

post
https://www.bankingcircleconnect.com/api/v2/fx/transactions
Body Params
int32
1 to 2147483647
Defaults to 1

Number pages returned. Defaults to 1 if not specified.

PageNumber and PageSize details the pagination information

Condition: Valid page number (1 to n)

int32
1 to 5000
Defaults to 50

Number of items returned per page. Defaults to 50 if not specified.

Condition: Required - Larger than zero

accountId
array of uuids | null

Account Id

Criteria: Exact match any of

  • ForeignExchange.SoldAccountId
  • ForeignExchange.BoughtAccountId
accountId
string | null

Your reference used when booking a Banking Circle FX trade

Criteria: Exact match of ForeignExchange.ClientOrderId

string | null

Banking Circle's unique reference

Criteria: Exact match of ForeignExchange.BankingCircleRef

transactionStatus
array of strings | null

Filter based on current status of your transactions

transactionStatus
date-time | null

Filter based on the trade execution date. Show only transactions on or after this date.

Format: ISO 8601 | YYYY-MM-DD

date-time | null

Filter based on the trade execution date. Show only transactions with trade date until and including this date.

Format: ISO 8601 | YYYY-MM-DD

date-time | null

Filter based on the trade value. Show only transactions with value date on or after this date

Format: ISO 8601 | YYYY-MM-DD

date-time | null

Filter based on the trade value. Show only transactions with value date until and including this date.

Format: ISO 8601 | YYYY-MM-DD

currencies
array of strings | null

Filter based on currencies. Accepts multiple currencies using the and separator in the path.

currencies
double | null

Filter based on the amount. Show only amounts equal or exceeding this value.

customerId
array of strings | null

Optional

Banking Circle Customer Id in case you have multiple legal entities and want to narrow the search

customerId
Responses

Updated 7 months ago

Language
Credentials
Bearer
Response 
 Choose an example:
application/json
Updated 7 months ago