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.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired
The unique identifier for the inbound transfer

Response

The inbound transfer was canceled
idstringRead-only
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_atstringRead-onlyformat: "date-time"
The date and time the inbound transfer was created
descriptionstring
An arbitrary string attached to the object. Often useful for displaying to users.
statusenum
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_atstringRead-onlyformat: "date-time"
The date and time the inbound transfer was last updated

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
412
Precondition Failed Error
500
Internal Server Error