Skip to main content
POST
/
accounts
/
{account_id}
/
deposits
Create a deposit
curl --request POST \
  --url https://api.example.com/accounts/{account_id}/deposits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "100.00",
  "currency": "EUR",
  "payment_reference": "<string>",
  "request_advance": false
}
'
{
  "id": "<string>",
  "account": "<string>",
  "amount": "<string>",
  "currency": "EUR",
  "payment_reference": "<string>",
  "was_advanced": true,
  "status": "open",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "advanced_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

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

The amount to deposit, as a decimal number with two decimal places.

Required range: x > 0
Example:

"100.00"

​
currency
enum<string>
required

The currency to deposit in, which needs to be a supported currency on the account.

Available options:
EUR,
USD,
GBP
​
payment_reference
string

The reference that will be used to identify the inbound payment that funds this deposit. If provided, it should be unique per batch of deposits you are planning to fund. If not provided, we will generate one for you. In both cases, we expect that a payment will be received with this reference.

​
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

​
id
string
required

Unique resource identifier.

​
account
string
required

The ID of the parent account.

​
amount
string
required

The amount of the deposit.

Examples:

"100.00"

"50.12"

​
currency
enum<string>
required

The currency of the deposit.

Available options:
EUR,
USD,
GBP
​
payment_reference
string
required

The reference that will be used to identify the inbound payment that funds this deposit.

Example:

"202512161234"

​
was_advanced
boolean
required

Whether the deposit was advanced as unsettled cash.

​
status
enum<string>
required

The status of the deposit.

Available options:
open,
completed
​
created_at
string<date-time>
required

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

​
modified_at
string<date-time>
required

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

​
advanced_at
string<date-time> | null

The timestamp (in ISO-8601 format) of when the deposit was advanced as unsettled cash, if applicable.

​
completed_at
string<date-time> | null

The timestamp (in ISO-8601 format) of when the deposit was completed i.e settled funds were credited to the account's cash balance.