Sign in

v7

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0462198511.0 KB
payments

Create a deposit

Create a deposit, funded by bank transfer. The deposit amount can be optionally advanced, to increase the account's buying power before the deposit is funded.

post/accounts/{account_id}/deposits

Path parameters

account_idstring required

Request body

currency'EUR' | 'USD' | 'GBP' required
payment_referencestring

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

request_advanceboolean

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

Response

Created

accountstring required

The ID of the parent account.

advanced_atstring date-time nullable

The time the deposit was advanced as unsettled cash.

amountstring required

The amount of the deposit.

completed_atstring date-time nullable

The time the deposit was completed.

created_atstring date-time required

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

currency'EUR' | 'USD' | 'GBP' required
idstring required

Unique resource identifier.

modified_atstring date-time required

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

payment_referencestring required

The reference used to identify the inbound payment.

status'open' | 'completed' required
was_advancedboolean required

Whether the deposit was advanced as unsettled cash.

Example response

{
  "advanced_at": "2026-07-14T09:32:00Z",
  "amount": "100.00",
  "completed_at": "2026-07-14T09:34:12Z",
  "payment_reference": "202512161234"
}