List User Payments

get

https://bo-api.drivewealth.io/back-office/users/{userID}/funding/payments

Retrieves a unified, chronological list of a user's deposits and redemptions across all of their accounts.

Path Params

userID

string

required

A unique identifier created for each User on DriveWealth's platform.

Query Params

from

string

required

Start of the search window (inclusive). Accepts a bare date (YYYY-MM-DD) or a full ISO-8601 timestamp.

string

required

End of the search window (inclusive). Accepts a bare date (YYYY-MM-DD, treated as the end of that day) or a full ISO-8601 timestamp.

category

Allowed:

status

string

Comma separated payment statuses to filter by.

type

string

Comma separated payment (vendor) types to filter by.

sort

string

enum

Defaults to -timestamp

Sort by timestamp, ascending (timestamp) or descending (-timestamp, the default/newest-first).

Allowed:

limit

integer

1 to 100

Defaults to 25

The number of payments to be returned per page. Minimum=1, Maximum=100.

offset

string

The paymentID of the last payment in the previous page (the response's page.nextCursor). Omit for the first page.

amount[gt]

number

≥ 0

Amount magnitude strictly greater than this value. Mutually exclusive with amount[gte].

amount[gte]

number

≥ 0

Amount magnitude greater than or equal to this value. Mutually exclusive with amount[gt].

amount[lt]

number

≥ 0

Amount magnitude strictly less than this value. Mutually exclusive with amount[lte].

amount[lte]

number

≥ 0

Amount magnitude less than or equal to this value. Mutually exclusive with amount[lt].

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

200Retrieving a list of User Payments was Successful.

400Bad Request