Skip to main content
POST
Create a funding intent

Authorizations

Authorization
string
header
required

Server-side only. Never ships to a browser.

Headers

Idempotency-Key
string
required

Required on every mutating request. Absent is a 400.

Required string length: 8 - 200

Body

application/json
destination
object
required

One shape for a bank account, a blockchain address, a card, and an internal balance. Used for both sources and destinations: direction is a property of the transfer, never of the type.

amount
object

Omit for open-amount funding.

presentment_currency
string
Example:

"fiat:USD"

customer_id
string
reference
string

Your own order id. Unique per application. Not a substitute for the idempotency header.

metadata
object
policy
object

Response

Created

id
string
required
Example:

"fi_..."

status
enum<string>
required

Route shape never appears here. Values may be added in a minor version, so every client switch must carry a default.

Available options:
created,
quoted,
awaiting_payment,
payment_received,
in_review,
settling,
settled,
partially_settled,
undeliverable,
failed,
refund_pending,
refunded,
refund_failed,
expired,
canceled
destination
object
required

One shape for a bank account, a blockchain address, a card, and an internal balance. Used for both sources and destinations: direction is a property of the transfer, never of the type.

created_at
string<date-time>
required
expires_at
string<date-time>
required
amount
object
pay_to
object[]

Where the payer should send. One entry per rail that can receive.

reference
string
metadata
object
checkout_url
string<uri>
failure
object