Skip to main content
POST
Simulate Incoming Instant Payment

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string
required

Idempotency key

Maximum string length: 255

Body

application/json
creditor_account_number_id
string
required

The ID of the Account Number object receiving the instant payment.

Pattern: ^account_number_\w+$
Example:

"account_number_xyz123"

amount
integer<int64>
required

The amount of the instant payment in cents.

Required range: x >= 0
Example:

5000

currency_code
enum<string>
required

A three-letter currency code as defined in ISO 4217. Only USD is supported.

Available options:
USD
Example:

"USD"

debtor
object
required

The details of the debtor (payer) sending the funds.

debtor_agent
object
required

The details of the financial institution where the debtor (payer) holds their account.

description
string

Free-form information on the reason for the payment.

Maximum string length: 140
Example:

"Payment for invoice 12345"

payment_identifiers
object

Optional payment identifiers.

Response

Intentionally empty - incoming instant payment will be created asynchronously.