For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact usLogin
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • Introduction
    • Overview
    • Authentication
    • Errors
    • Software Development Kits
    • Webhooks and Events
    • Sandbox Simulations
  • Core Resources
  • DAFpay
  • Disbursements
      • GETList Inbound Transfers
      • POSTCreate an Inbound transfer
      • GETGet an Inbound Transfer
      • POSTCancel an Inbound Transfer
      • POSTSandbox: Fail an Inbound Transfer
      • POSTSandbox: Complete an Inbound Transfer
  • Gift Processing
LogoLogo
Contact usLogin
DisbursementsInbound Transfers

Cancel an Inbound Transfer

POST
/v1/inbound_transfers/:id/cancel
POST
/v1/inbound_transfers/:id/cancel
$curl -X POST https://api.givechariot.com/v1/inbound_transfers/inbound_transfer_01j8rs605a4gctmbm58d87mvsj/cancel \
>     -H "Authorization: Bearer <token>"
1{
2  "id": "inbound_transfer_01j8rs605a4gctmbm58d87mvsj",
3  "amount": 10000,
4  "created_at": "2020-01-31T23:00:00Z",
5  "description": "InboundTransfer from my bank account",
6  "status": "pending",
7  "updated_at": "2020-01-31T23:00:00Z"
8}
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.
Was this page helpful?
Previous

Sandbox: Fail an Inbound Transfer

Next
Built with

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