Sign in

v1

latestOpenAPI 3.1.02026-07-26457177.8 KB
Transfers

Cancel Transfer

📘

You can place the bearer access_token for a specific user into the Authentication section of this documentation 👉.

Cancel a transfer for a user. To cancel a transfer, you must provide the ID of the transfer in the Endpoint URL. When a transfer is successfully canceled, Astra will return a successful response (HTTP 200) and the status of the transfer in the Transfer table will update to canceled.

🚧

If the API response states that the transfer cannot be cancelled, then it indeed cannot be cancelled by any means. For details see this guide.

post/v1/transfers/{id}/cancel

Path parameters

idstring required

The ID of the Transfer to cancel

Response

Successful response

idstring

The unique ID of the transfer

routine_type'one-time' | 'recurring'

The type of routine associated with the transfer

routine_namestring

The name of the routine associated with the transfer

routine_idstring

The unique ID of the routine associated with the transfer

client_correlation_idstring

An optional correlation id that will be added to ACH or Debit Addenda. This will also be included in the Transfer response.

source_idstring

The ID of the Source Account

destination_idstring

The ID of the Destination Account

destination_user_idstring

The User ID associated with the Destination Account (if peer-to-peer)

amountnumber float

The amount of the transfer (when explicitly defined like one-time or recurring)

payment_type'ach' | 'debit' | 'ledger'

The type of payment

initiatedstring date-time

The date and time the transfer was initiated

updatedstring date-time

The date and time the transfer was updated

estimated_clearing_datestring date-time

The estimated date and time the transfer will clear

status'cancelled'

The status of the Transfer