Skip to main content
GET
/
deposits
Get all deposits
curl --request GET \
  --url https://{host}/deposits \
  --header 'Authorization: Bearer <token>' \
  --header 'x-user-id: <x-user-id>'
[
  {
    "id": "dep_64f0c51e7fb3fc001234abcd",
    "ownerId": "bank-user-12345",
    "bankAccountId": "ba_64f0c51e7fb3fc001234abcd",
    "amount": 100,
    "currency": "EUR",
    "status": "pending",
    "consideration": {
      "currency": "EUR",
      "amount": 100
    },
    "reference": "Top-up for trading",
    "createdAt": "2023-11-07T05:31:56Z"
  }
]
Use this endpoint to monitor incoming payments that have been reconciled as deposits for the authenticated user. You can optionally filter by:
  • status – restrict the response to deposits in a specific lifecycle state (e.g. pending, completed).
  • bankReference – match the exact payment reference that was supplied when sending funds to the Wealthyhood wallet IBAN. This is useful when you create a unique identifier for each payment instruction and want to confirm that it has been received.
The response returns the most recent deposits first. Combine the filters to zero-in on the exact payment instance you are tracking.

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"

Query Parameters

​
status
enum<string>

Optional status filter Status of the deposit

Available options:
pending,
completed,
failed
Example:

"pending"

​
bankReference
string

Filter deposits that were received with a specific bank payment reference.

Example:

"wallet-topup-5f91ce"

Response

List of deposits

​
id
string
required
Example:

"dep_64f0c51e7fb3fc001234abcd"

​
ownerId
string
required
Example:

"bank-user-12345"

​
bankAccountId
string
required
Example:

"ba_64f0c51e7fb3fc001234abcd"

​
amount
number
required

Deposit amount as a number

Required range: x >= 0.01
Example:

100

​
currency
enum<string>
required

ISO 4217 currency code

Available options:
GBP,
EUR,
USD
Example:

"EUR"

​
status
enum<string>
required

Status of the deposit

Available options:
pending,
completed,
failed
Example:

"pending"

​
consideration
object

Deposit consideration with currency and amount

​
reference
string
Example:

"Top-up for trading"

​
createdAt
string<date-time>