Skip to main content
POST
Create a deposit

Authorizations

Authorization
string
header
required

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

Path Parameters

account_id
string
required

Body

application/json
amount
required

Positive deposit amount with up to two decimal places.

Required range: x > 0
Example:

"100.00"

currency
enum<string>
required

Supported account currency to credit.

Available options:
EUR,
USD,
GBP
payment_reference
string

Reference used to match the inbound payment; generated when omitted and unique per funding batch when provided.

request_advance
boolean
default:false

Request that the deposit amount is credited in advance as unsettled cash, which will settle once the deposit is funded.

Response

Created

account
string
required

The ID of the parent account.

amount
string
required

The amount of the deposit.

Examples:

"100.00"

"50.12"

created_at
string<date-time>
required

The timestamp (in ISO-8601 format) of when the resource was created.

currency
enum<string>
required

The currency of the deposit.

Available options:
EUR,
USD,
GBP
id
string
required

Unique resource identifier.

modified_at
string<date-time>
required

The timestamp (in ISO-8601 format) of when the resource was last modified.

payment_reference
string
required

The reference used to identify the inbound payment.

Example:

"202512161234"

status
enum<string>
required

The status of the deposit.

Available options:
open,
completed
was_advanced
boolean
required

Whether the deposit was advanced as unsettled cash.

advanced_at
string<date-time> | null

The time the deposit was advanced as unsettled cash.

Example:

"2026-07-14T09:32:00Z"

completed_at
string<date-time> | null

The time the deposit was completed.

Example:

"2026-07-14T09:34:12Z"