Withdrawals

List Account Withdrawals

Retrieves a list of Account Withdrawals by accountID

get/accounts/{accountID}/funding/redemptions

Request

Base URL
https://bo-api.drivewealth.io/back-office
URL
https://bo-api.drivewealth.io/back-office/accounts/{accountID}/funding/redemptions
Auth
HTTP bearer

Path parameters

accountIDstring required

sensitive The user's unique account identifier.

Example:123e4567-e89b-12d3-a456-000000000004.1234567890125

sensitive

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 of Account Withdrawals was Successful.

idstring

A unique identifier for the user's account redemption/withdrawal.

paymentIDstring

A unique identifier for the user's account redemption/withdrawal.

amountnumber

The amount that will be withdraw from the user's brokerage account.

wlpFinTranTypeIDstring

A unique identifier to id different type of transactions.

finTranReferencestring

The unique identifier that references back to the specific transaction.

timestampstring

The date and time of when the redemption was created.

Example response

[
  {
    "id": "ZZZZ009001-1234567890137-4X5Y6",
    "paymentID": "ZZZZ009001-1234567890137-4X5Y6",
    "amount": 250.25,
    "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"
      }
    },
    "fees": [
      {
        "type": "FEE_STATE_TAX_CA",
        "description": "Fee - ACH",
        "amount": -5.99,
        "wlpFinTranTypeID": "123e4567-e89b-12d3-a456-00000000004c",
        "transactionCode": "FEE_STATE_TAX_CA",
        "finTranReference": "HG.123e4567-e89b-12d3-a456-00000000004e",
        "created": "2022-12-11T22:28:21.810Z",
        "currency": "USD",
        "symbol": "$"
      }
    ],
    "wlpFinTranTypeID": "123e4567-e89b-12d3-a456-00000000004c",
    "finTranReference": "HG.123e4567-e89b-12d3-a456-00000000004e",
    "timestamp": "2022-12-11T22:28:21.810Z"
  }
]

Changes

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