Sign in

v3

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

Update a cash transfer

To cancel a transfer, update the status to 'CANCELLED'. Only 'INITIATED' or 'PENDING` transfers can be cancelled.

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

patch/cash/{id}

Path parameters

idstring uuid required

Cashier Transfer ID

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

destination_account_idstring uuid

The UUID of the Synctera account resource that is the destination of the transfer for incoming transfers. This can only be updated if the transfer is suspended.

source_dataobject

Additional information to be added to the transfer

status'CANCELLED'

Example request

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

Response

The updated Cashier transfer.

amountinteger required

Transfer amount in cents

dc_sign'CREDIT' | 'DEBIT' required

Debit or credit sign

source_dataobject

Additional information to be added to the transfer

client_bank_accountstring

The bank account of the client.

client_namestring

The name of the client.

customer_idstring

The UUID of the Synctera customer resource that is the originator of the transfer.

destination_account_idstring

The UUID of the Synctera account that is the destination of the transfer. For a transfer originated by the Synctera platform, this will be an external account resource, while for a transfer originated by the external account, this account will be an account resource.

destination_account_numberstring string

The account number of the destination account.

destination_account_owner_namestring

The account owner name of the destination account.

effective_datestring date required

The effective date of the transaction once it gets posted

failedboolean

Whether the transfer failed or not.

idstring uuid required

ID of the transfer

is_same_dayboolean required

Send the same day (use only is_same_day without specific effective_date).

network_status'PENDING' | 'POSTED' | 'RETURNED' | 'REVERSED'

The network status of the transfer in the Synctera platform.

original_reference_idstring

The original reference id of the transfer if it's a return.

originating_account_idstring

The UUID of the Synctera account that is the origination of the transfer. For a transfer originated by the Synctera platform, this will be an account resource, while for a transfer originated by the external account, this will be an external account resource.

originating_account_numberstring string

The account number of the originating account.

originating_account_owner_namestring

The account owner name of the origination account.

posting_datestring date

The posting date of the transaction once it gets posted

reference_idstring required

The reference id of the transfer.

status'CANCELLED' | 'EXPIRED' | 'INITIATED' | 'PENDING' | 'POSTED' required

The status of the transfer in the Synctera platform. This is automatically set upon the creation of a transfer. To cancel a transfer, the current status must be 'INITIATED' or 'PENDING' and the request status set to 'CANCELLED'. To trigger a return, the current status must be 'POSTED' and the returned status will be set to 'RETURNED' if successful.

subtype'CASH_ORDER' | 'CASH_ORDER_REVERSAL' | 'DEPOSIT' | 'DEPOSIT_REVERSAL' required

The subtype of the transfer

suspendedboolean

Whether the transfer is suspended or not.

tenant_idstring required

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

transaction_idstring uuid

The related transaction id of the transfer.

Example response

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