Deposits

List User Deposits

Retrieves a list of User Deposits by userID.

get/users/{userID}/funding/deposits

Request

Base URL
https://bo-api.drivewealth.io/back-office
URL
https://bo-api.drivewealth.io/back-office/users/{userID}/funding/deposits
Auth
HTTP bearer

Path parameters

userIDstring required

sensitive The User's unique identifier.

Query parameters

statusstring

Comma separated payment statuses

typestring

Comma separated deposit types

limitinteger

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

offsetstring

Should either be null or the last payment result in the previous request

Response

Retrieving a list User Deposits by userID was Successful.

idstring

A unique identifier for the Deposit.

paymentIDstring

A unique identifier for the Deposit.

amountnumber

The amount of the deposit

wlpFinTranTypeIDstring

A unique identifier to id different type of transactions.

notestring

sensitive A way to store a message/comment on the this object. Do not put personal or account data in this field.

Example response

[
  {
    "id": "YYYY009000-1234567890136-1A2B3",
    "paymentID": "YYYY009000-1234567890136-1A2B3",
    "amount": 125.22,
    "currency": {
      "name": "USD",
      "description": "US Dollar",
      "symbol": "$"
    },
    "status": {
      "id": 1,
      "message": "PENDING",
      "updated": "2022-12-11T22:28:21.810Z"
    },
    "accountDetails": {
      "accountID": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
      "accountNo": "FFFF000005",
      "accountType": {
        "name": "LIVE",
        "description": "Live Account"
      },
      "accountManagementType": {
        "name": "SELF",
        "description": "Self Directed Account"
      }
    },
    "wlpFinTranTypeID": "123e4567-e89b-12d3-a456-00000000004c",
    "note": "Hey! Welcome to DriveWealth Developer Docs!"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.