v3

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

Get cash authorizations

Get all cash authorizations

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

get/cash/authorization

Query parameters

max_amountinteger
Example:100

Maximum amount of the transfer

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

Destination account ID

client_namestring

Client name of the transfer

from_order_datestring date

From order date of the transfer

to_order_datestring date

To order date of the transfer

idstring[]

Cashier Authorization ID

[
  "7d943c51-e4ff-4e57-9558-08cab6b963c7"
]
order_datestring date

order date of the transfer

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

Originating account ID

partner_idstring

Partner ID of the transfer

bank_idstring

Bank ID of the transfer

account_numberstring

Account number of the transfer, known as "Location ID" in the cash order csv

amountstring

Amount of the transfer

min_amountinteger
Example:100

Minimum amount of the transfer

Response

Retrieve all cash authorizations

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",
  "authorizations": [
    {
      "amount": 10000,
      "destination_account_id": "fccb4a46-1261-4e91-b622-73b5b946183d",
      "client_name": "Cash-Based Brick and Mortar Store",
      "originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "tenant": "abcdef_ghijkl"
    }
  ]
}