Post FX transactions

post

https://www.bankingcircleconnect.com/api/v2/fx/transactions

Body Params

Filter your FX Transactions

pageNumber

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)

pageSize

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

clientOrderId

string | null

Your reference used when booking a Banking Circle FX trade

Criteria: Exact match of ForeignExchange.ClientOrderId

bankingCircleRef

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

Allowed:

tradeDate

date-time | null

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

Format: ISO 8601 | YYYY-MM-DD

tradeDateTo

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

valueDate

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

valueDateTo

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

amount

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

Language

Loading…

Response

Choose an example:

application/json

200OK

400Bad Request

403Forbidden

404Not Found

500Internal Server Error