v1

latestOpenAPI 3.1.02026-07-2432337285.3 KB
Internal Transfers

List Internal Transfers

Retrieves a list of internal transfers.

get/internal-transfer/

Query parameters

page_numberinteger

Page index (1-based). Results start from page 1 by default.

Page index (1-based). Results start from page 1 by default.

page_sizeinteger

Maximum number of transfers to return per page. Defaults to 50.

Maximum number of transfers to return per page. Defaults to 50.

date_fromstring date-time

Only include transfers created on or after this timestamp. Must be ISO 8601 (UTC).

Only include transfers created on or after this timestamp. Must be ISO 8601 (UTC).

date_tostring date-time

Only include transfers created on or before this timestamp. Must be ISO 8601 (UTC).

Only include transfers created on or before this timestamp. Must be ISO 8601 (UTC).

include_child_companiesboolean

If set to true, also return transfers belonging to any child companies of the authenticated company. Default: false.

If set to true, also return transfers belonging to any child companies of the authenticated company. Default: false.

source_currencystring

Source account currency

Source account currency

target_currencystring

Target account currency

Target account currency

status'PENDING' | 'PROCESSING' | 'SETTLING' | 'COMPLETED' | 'FAILED'

Filter by transfer status (PENDING, PROCESSING, SETTLING, COMPLETED, FAILED).

idempotency_keystring

Idempotency key.

Idempotency key.

internal_transfer_idstring

Internal tranfer ID. If passed it will ignore the rest of theparameters, except for 'include_child_companies'.

Internal tranfer ID. If passed it will ignore the rest of theparameters, except for 'include_child_companies'.

limitinteger
cursorstring

Headers

x-company-idinteger

ID of a child company for authentication. If not provided, the parent company will be authenticated.

ID of a child company for authentication. If not provided, the parent company will be authenticated.

Response

Successful Response

next_cursorstring
has_moreboolean
status'success'