Skip to main content
GET
/
deposits
/
{depositId}
Get deposit by ID
curl --request GET \
  --url https://{host}/deposits/{depositId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-user-id: <x-user-id>'
{
  "id": "dep_64f0c51e7fb3fc001234abcd",
  "userId": "bank-user-12345",
  "bankAccountId": "ba_64f0c51e7fb3fc001234abcd",
  "amount": "100.00",
  "currency": "GBP",
  "status": "pending",
  "reference": "Top-up for trading",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-user-id
string
required

The external user identifier of the acting customer.

Example:

"bank-user-12345"

Path Parameters

​
depositId
string
required

Unique identifier of the deposit

Example:

"dep_64f0c51e7fb3fc001234abcd"

Response

Deposit

​
id
string
required
Example:

"dep_64f0c51e7fb3fc001234abcd"

​
userId
string
required
Example:

"bank-user-12345"

​
bankAccountId
string
required
Example:

"ba_64f0c51e7fb3fc001234abcd"

​
amount
string
required

Decimal string with 2 fractional digits

Example:

"100.00"

​
currency
string
required

ISO 4217 currency code

Example:

"GBP"

​
status
enum<string>
required

Status of the deposit

Available options:
pending,
completed,
failed
Example:

"pending"

​
reference
string
Example:

"Top-up for trading"

​
createdAt
string<date-time>
​
updatedAt
string<date-time>