v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Cash Orders and Deposits (alpha)

Get cash transfers

Get all cash transfers

🚧 Alpha > This is an Alpha spec-only endpoint. Feedback from the community is welcome. We may make breaking changes.

get/cash

Query parameters

from_posting_datestring

From posting date of the transfer

currencystring
Example:CAD

Currency of the transfer

to_effective_datestring

To effective date of the transfer

to_posting_datestring

To posting date of the transfer

customer_idstring

Customer ID of the transfer

dc_signstring

DC sign of the transfer

from_effective_datestring

From effective date of the transfer

max_amountinteger
Example:100

Maximum amount of the transfer

destination_account_idstring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

Destination account ID

is_same_dayboolean

Is same day transfer

idstring

Cashier Transfer ID

effective_datestring

Effective date of the transfer

destination_account_numberstring
Example:987654321

Destination account number

posting_datestring

Posting date of the transfer

network_statusstring

Network status of the transfer

originating_account_numberstring
Example:123456789

Originating account number

subtypestring

Subtype of the transfer

originating_account_idstring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

Originating account ID

partner_idstring

Partner ID of the transfer

destination_account_owner_namestring
Example:Jane Joe

Destination account owner name

bank_idstring

Bank ID of the transfer

reference_idstring

Reference ID of the transfer

statusstring

Status of the transfer

amountstring

Amount of the transfer

min_amountinteger
Example:100

Minimum amount of the transfer

originating_account_owner_namestring

Originating account owner name

Response

Retrieve all Cashier transfers

next_page_tokenstring

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

Example response

{
  "next_page_token": "a8937a0d",
  "transfers": [
    {
      "amount": 10000,
      "dc_sign": "DEBIT",
      "client_name": "Fintech A",
      "customer_id": "46fec39e-e776-4571-bf90-d0e1d15172fe",
      "destination_account_id": "fccb4a46-1261-4e91-b622-73b5b946183d",
      "effective_date": "2022-03-18",
      "is_same_day": true,
      "network_status": "POSTED",
      "originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "posting_date": "2022-03-18",
      "status": "POSTED",
      "subtype": "CASH_ORDER",
      "tenant_id": "abcdef_ghijkl",
      "transaction_id": "45b5246f-ad97-4629-9aac-465b74a05505"
    }
  ]
}