Sign in

v49

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-294147162.3 KB
inboundTransfers

Cancel an Inbound Transfer

Cancel an inbound transfer. Returns the Inbound Transfer object if the cancelation succeeded. Returns a 412 Precondition Failed if the Inbound Transfer has already been canceled or cannot be canceled.

post/v1/inbound_transfers/{id}/cancel

Path parameters

idstring required

The unique identifier for the inbound transfer

Response

The inbound transfer was canceled

idstring required

The unique identifier for the inbound transfer

amountinteger required

The amount of the inbound transfer in minor currency units (cents). This amount must be positive.

descriptionstring

An arbitrary string attached to the object. Often useful for displaying to users.

status'pending' | 'completed' | 'canceled' | 'failed'

The status of the inbound transfer. An Inbound Transfer is pending if it created and the funds haven't been received yet. The status changes to completed when the funds have been received and the balance of the financial account has been updated. The status changes to canceled if the transfer is canceled. The status changes to failed if the transfer fails.

created_atstring date-time required

The date and time the inbound transfer was created

updated_atstring date-time

The date and time the inbound transfer was last updated

Example response

{
  "id": "inbound_transfer_01j8rs605a4gctmbm58d87mvsj",
  "amount": 10000,
  "description": "InboundTransfer from my bank account",
  "status": "pending",
  "created_at": "2020-01-31T23:00:00Z",
  "updated_at": "2020-01-31T23:00:00Z"
}