Skip to main content
POST
/
test
/
deposits
curl --request POST \
  --url https://{host}/test/deposits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "64f1b2c3d4e5f67890123456",
  "amount": 100,
  "bankAccount": {
    "holderName": "Account Holder Name",
    "iban": "GR1601101250000000012300695",
    "bic": "ETHNGRAA",
    "currency": "EUR"
  }
}
'
{
  "id": "dep_64f0c51e7fb3fc001234abcd",
  "ownerId": "64f0c51e7fb3fc001234abcd",
  "amount": 10050,
  "currency": "EUR",
  "status": "Settled",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "reference": "a1B2c3D4e5F6g7H8"
}
These test endpoints are only available in development and staging environments. They are disabled in production for security reasons.
See the Sandbox payments flow for detailed examples and usage patterns.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
userId
string
required

MongoDB ObjectId of the user who will receive the deposit

Example:

"64f0c51e7fb3fc001234abcd"

​
amount
number
required

Deposit amount in whole currency units (e.g., 100.50 for £100.50)

Required range: x >= 0.01
Example:

100.5

​
bankAccountId
string

MongoDB ObjectId of an existing bank account to use for the deposit. Cannot be provided together with bankAccount.

Example:

"64f1b2c3d4e5f67890123457"

​
bankAccount
object

Bank account details to create and associate with the deposit. Cannot be provided together with bankAccountId.

Response

Deposit created successfully

​
id
string
required
Example:

"dep_64f0c51e7fb3fc001234abcd"

​
ownerId
string
required

MongoDB ObjectId of the user who owns the deposit

Example:

"64f0c51e7fb3fc001234abcd"

​
amount
number
required

Deposit amount in cents (minor currency units)

Example:

10050

​
currency
string
required

ISO 4217 currency code

Example:

"EUR"

​
status
string
required

Transaction status (always "Settled" for test deposits)

Example:

"Settled"

​
createdAt
string<date-time>
required
Example:

"2024-01-15T10:30:00.000Z"

​
reference
string

Automatically generated bank reference

Example:

"a1B2c3D4e5F6g7H8"