v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

Cash Orders and Deposits (alpha)

Cash Authorization for an upcoming transfer

Create a new cash authorization

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

post/cash/authorization

Headers

Idempotency-Keystring

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

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Request body

amountinteger required

Transfer amount in cents

authorization_type'CASH_ORDER' | 'DEPOSIT' required

destination_account_idstring uuid required

The UUID of the Synctera account resource that is the destination of the transfer.

order_datestring date required

The date the cash order was placed with cash distribution provider

Example request

{
  "amount": 10000,
  "destination_account_id": "fccb4a46-1261-4e91-b622-73b5b946183d"
}

Response

Successful creation of an cash order authorization

amountinteger required

Transfer amount in cents

authorization_type'CASH_ORDER' | 'DEPOSIT' required

destination_account_idstring uuid required

The UUID of the Synctera account resource that is the destination of the transfer.

order_datestring date required

The date the cash order was placed with cash distribution provider

account_numberstring required

The account number of the client business the cash order is for. Known as "Location ID" in the cash order CSV files.

client_namestring required

The name of the client business the cash order is for.

hold_idstring uuid required

ID of the hold created for this authorization

idstring uuid required

ID of the transfer

originating_account_idstring uuid required

The UUID of the Synctera account resource originating the transfer.

status'CANCELLED' | 'COMPLETE' | 'EXPIRED' | 'PENDING' required

tenantstring required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example response

{
  "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"
}