Skip to main content
GET
Get cash transfers

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

id
string

Cashier Transfer ID

bank_id
string

Bank ID of the transfer

partner_id
string

Partner ID of the transfer

customer_id
string

Customer ID of the transfer

originating_account_id
string

Originating account ID

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

destination_account_id
string

Destination account ID

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

originating_account_number
string

Originating account number

Example:

"123456789"

destination_account_number
string

Destination account number

Example:

"987654321"

originating_account_owner_name
string

Originating account owner name

destination_account_owner_name
string

Destination account owner name

Example:

"Jane Joe"

status
string

Status of the transfer

network_status
string

Network status of the transfer

subtype
string

Subtype of the transfer

dc_sign
string

DC sign of the transfer

effective_date
string

Effective date of the transfer

from_effective_date
string

From effective date of the transfer

to_effective_date
string

To effective date of the transfer

posting_date
string

Posting date of the transfer

from_posting_date
string

From posting date of the transfer

to_posting_date
string

To posting date of the transfer

amount
string

Amount of the transfer

Example:

100

min_amount
integer

Minimum amount of the transfer

Required range: x >= 1
Example:

100

max_amount
integer

Maximum amount of the transfer

Required range: x >= 1
Example:

100

currency
string

Currency of the transfer

Example:

"CAD"

reference_id
string

Reference ID of the transfer

is_same_day
boolean

Is same day transfer

Response

Retrieve all Cashier transfers

transfers
Cash Transfer Response · object[]
required

Array of transfers.

next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"