v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB

Deposits

List User Deposits

Retrieves a list of User Deposits by userID.

get/users/{userID}/funding/deposits

Path parameters

userIDstring required

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

A way to store a message/comment on the this object.

Example response

[
  {
    "id": "-DMIQY",
    "paymentID": "-DMIQY",
    "amount": 125.22,
    "currency": {
      "name": "USD",
      "description": "US Dollar",
      "symbol": "$"
    },
    "status": {
      "id": 1,
      "message": "PENDING",
      "updated": "2022-12-11T22:28:21.810Z"
    },
    "accountDetails": {
      "accountID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759",
      "accountNo": "DWBG000052",
      "accountType": {
        "name": "LIVE",
        "description": "Live Account"
      },
      "accountManagementType": {
        "name": "SELF",
        "description": "Self Directed Account"
      }
    },
    "wlpFinTranTypeID": "c43bab85-2916-4831-a0db-66215150a6e4",
    "note": "Hey! Welcome to DriveWealth Developer Docs!"
  }
]