Create an Inbound transfer
Create an inbound transfer to fund your financial account
from an externally linked bank account.
In Production, this requires that an external bank account has been setup
and verified for your account through the Chariot Dashboard.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Idempotency-Key
The idempotency key for the request
Request
This endpoint expects an object.
amount
The amount of the transfer in cents.
This amount must be positive.
account_id
The identifier of the financial account that will receive the transfer.
description
An arbitrary string attached to the object. Often useful for displaying to users.
Response
The inbound transfer was created
id
The unique identifier for the inbound transfer
amount
The amount of the inbound transfer in minor currency units (cents). This amount must be positive.
created_at
The date and time the inbound transfer was created
description
An arbitrary string attached to the object. Often useful for displaying to users.
status
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_at
The date and time the inbound transfer was last updated