DisbursementsInbound Transfers

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.

Path parameters

idstringRequired
The unique identifier for the inbound transfer

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

The inbound transfer was canceled
idstring
The unique identifier for the inbound transfer
amountlong

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

created_atdatetime
The date and time the inbound transfer was created
descriptionstringOptional
An arbitrary string attached to the object. Often useful for displaying to users.
statusenumOptional

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.

Allowed values:
updated_atdatetimeOptional
The date and time the inbound transfer was last updated

Errors