Query transfer(s)

Note

Looks up transfers — use it to confirm a transfer settled, reconcile against your own books, or show a client their funding history.

Query in one of three ways: by your own clientOrderId, by the BrokerX orderId, or by brokerClientId to list every transfer for one client (paginated with page / pageSize, with an optional startTime / endTime range). In every case data is returned as { records, total }. Each record shows the amount you requested, the amount actually credited (receivedAmount, in USD), the direction, and the status — with a reason when it failed.

Empty results and errors

No matching account or transfer record returns success with data.records: [] and data.total: 0.

Invalid parameter formats, such as page=abc or a nonnumeric startTime, return HTTP 200 with code: 1000. For example:

{"code":1000,"message":"Invalid Format Error [{page}]"}

Check the JSON business code even when HTTP status is 200. Error responses can omit data.

Query Params
string

Look up by your own order id.

string

Look up by CONNEX transfer id.

string

List all transfers for one client (as source or destination).

string

Start of the time range, Unix epoch milliseconds. Used with brokerClientId.

string

End of the time range, Unix epoch milliseconds. Used with brokerClientId.

int32

Page number (default 1).

int32

Page size (default 20).

Headers
string

Optional client-supplied trace id, echoed through our logs for easier support. Generated for you if omitted.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json
text/plain