---
updatedAt: 2026-09-30T00:02:23.000Z
agentTools:
  projectIndex: https://developer.drivewealth.com/apis/llms.txt
---

# List Account Payments

Retrieves a unified, chronological list of an account's deposits and redemptions.

# OpenAPI definition

```json
{
  "openapi": "3.0.2",
  "info": {
    "title": "Money Movement APIs",
    "version": "2026-11-07",
    "contact": {
      "email": "producteng@drivewealth.tech"
    }
  },
  "servers": [
    {
      "url": "https://bo-api.drivewealth.io/back-office",
      "description": "Sandbox (No Real World Financial/Trading Impact)"
    },
    {
      "url": "https://bo-api.drivewealth.net/back-office",
      "description": "Production"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-readme": {
    "explorer-enabled": false,
    "headers": [
      {
        "key": "dw-client-app-key",
        "value": "{{yourAppKey}}"
      }
    ]
  },
  "tags": [
    {
      "name": "Payments"
    }
  ],
  "paths": {
    "/accounts/{accountID}/funding/payments": {
      "get": {
        "tags": [
          "Payments"
        ],
        "summary": "List Account Payments",
        "description": "Retrieves a unified, chronological list of an account's deposits and redemptions.",
        "parameters": [
          {
            "in": "path",
            "name": "accountID",
            "schema": {
              "$ref": "#/components/schemas/accountID"
            },
            "required": true,
            "x-sensitive": true,
            "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)"
          },
          {
            "in": "query",
            "name": "from",
            "schema": {
              "type": "string"
            },
            "required": true,
            "example": "2026-09-01T00:00:00Z",
            "description": "Start of the search window (inclusive). Accepts a bare date (`YYYY-MM-DD`) or a full ISO-8601 timestamp."
          },
          {
            "in": "query",
            "name": "to",
            "schema": {
              "type": "string"
            },
            "required": true,
            "example": "2026-09-16T00:00:00Z",
            "description": "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."
          },
          {
            "in": "query",
            "name": "category",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "DEPOSIT",
                  "REDEMPTION"
                ]
              }
            },
            "style": "form",
            "explode": false,
            "example": [
              "DEPOSIT",
              "REDEMPTION"
            ],
            "description": "Payment categories to filter by (comma separated for multiple)."
          },
          {
            "in": "query",
            "name": "status",
            "schema": {
              "type": "string"
            },
            "example": "Successful,Pending",
            "description": "Comma separated payment statuses to filter by."
          },
          {
            "in": "query",
            "name": "type",
            "schema": {
              "type": "string"
            },
            "example": "ACH,WIRE",
            "description": "Comma separated payment (vendor) types to filter by."
          },
          {
            "in": "query",
            "name": "sort",
            "schema": {
              "type": "string",
              "enum": [
                "timestamp",
                "-timestamp"
              ],
              "default": "-timestamp"
            },
            "example": "-timestamp",
            "description": "Sort by `timestamp`, ascending (`timestamp`) or descending (`-timestamp`, the default/newest-first)."
          },
          {
            "in": "query",
            "name": "limit",
            "schema": {
              "type": "integer",
              "default": 25,
              "minimum": 1,
              "maximum": 100
            },
            "example": 50,
            "description": "The number of payments to be returned per page. Minimum=1, Maximum=100."
          },
          {
            "in": "query",
            "name": "offset",
            "schema": {
              "$ref": "#/components/schemas/paymentID"
            },
            "example": "11AA000001-1234567890128-RJJLU",
            "description": "The `paymentID` of the last payment in the previous page (the response's `page.nextCursor`). Omit for the first page."
          },
          {
            "in": "query",
            "name": "amount[gt]",
            "schema": {
              "type": "number",
              "minimum": 0
            },
            "example": 100,
            "description": "Amount magnitude strictly greater than this value. Mutually exclusive with `amount[gte]`."
          },
          {
            "in": "query",
            "name": "amount[gte]",
            "schema": {
              "type": "number",
              "minimum": 0
            },
            "example": 100,
            "description": "Amount magnitude greater than or equal to this value. Mutually exclusive with `amount[gt]`."
          },
          {
            "in": "query",
            "name": "amount[lt]",
            "schema": {
              "type": "number",
              "minimum": 0
            },
            "example": 500,
            "description": "Amount magnitude strictly less than this value. Mutually exclusive with `amount[lte]`."
          },
          {
            "in": "query",
            "name": "amount[lte]",
            "schema": {
              "type": "number",
              "minimum": 0
            },
            "example": 500,
            "description": "Amount magnitude less than or equal to this value. Mutually exclusive with `amount[lt]`."
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieving a list of Account Payments was Successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentsSearchResponse"
                },
                "examples": {
                  "Successful": {
                    "value": {
                      "pageSize": 2,
                      "limit": 25,
                      "payments": [
                        {
                          "id": "11AA000001-1234567890128-RJJLU",
                          "paymentID": "11AA000001-1234567890128-RJJLU",
                          "accountID": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
                          "category": "DEPOSIT",
                          "type": "WIRE_DIRECT2BANK",
                          "amount": 250.25,
                          "currency": {
                            "name": "USD",
                            "description": "US Dollar",
                            "symbol": "$"
                          },
                          "details": {
                            "sequencerFlow": "CLM_INTERIM"
                          },
                          "status": {
                            "id": 2,
                            "message": "Successful",
                            "comment": "Valid request. Auto-move to Successful",
                            "updated": "2026-09-15T18:28:11.267Z"
                          },
                          "userDetails": {
                            "userID": "123e4567-e89b-12d3-a456-000000000004",
                            "username": "ttc.user.john",
                            "firstName": "John",
                            "lastName": "Doe",
                            "email": "john.doe@example.com",
                            "parentIB": {
                              "id": "123e4567-e89b-12d3-a456-000000000005",
                              "name": "Tendies Trading Company"
                            },
                            "wlpID": "TTC"
                          },
                          "accountDetails": {
                            "accountID": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
                            "accountNo": "FFFF000005",
                            "accountType": {
                              "name": "LIVE",
                              "description": "Live Account"
                            },
                            "accountManagementType": {
                              "name": "SELF",
                              "description": "Self Directed Account"
                            }
                          },
                          "fees": [],
                          "wlpFinTranTypeID": "123e4567-e89b-12d3-a456-000000000136",
                          "transactionCode": {
                            "code": "RECEIPT_OTHER",
                            "type": "CSR",
                            "description": "Cash Receipt - Other e.g. TransferWise, Currencycloud, etc."
                          },
                          "finTranReference": "NI.123e4567-e89b-12d3-a456-000000000137",
                          "note": "Wire deposit",
                          "timestamp": "2026-09-15T18:28:11.267Z"
                        },
                        {
                          "id": "FFFF000005-1234567890188-K3F9L",
                          "paymentID": "FFFF000005-1234567890188-K3F9L",
                          "accountID": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
                          "category": "REDEMPTION",
                          "type": "ACH",
                          "amount": -100,
                          "currency": {
                            "name": "USD",
                            "description": "US Dollar",
                            "symbol": "$"
                          },
                          "details": {
                            "beneficiaryRoutingNumber": "****0000",
                            "beneficiaryAccountNumber": "****2227",
                            "bankAccountNickname": "John's checking account",
                            "beneficiaryName": "John Doe",
                            "beneficiaryBankCountry": "USA",
                            "sequencerFlow": "CLM_INTERIM"
                          },
                          "status": {
                            "id": 2,
                            "message": "Successful",
                            "comment": "Valid request. Auto-move to Successful",
                            "updated": "2026-09-15T18:30:00.000Z"
                          },
                          "userDetails": {
                            "userID": "123e4567-e89b-12d3-a456-000000000004",
                            "username": "ttc.user.john",
                            "firstName": "John",
                            "lastName": "Doe",
                            "email": "john.doe@example.com",
                            "parentIB": {
                              "id": "123e4567-e89b-12d3-a456-000000000005",
                              "name": "Tendies Trading Company"
                            },
                            "wlpID": "TTC"
                          },
                          "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_ACH",
                              "description": "Fee - ACH",
                              "amount": -0.25,
                              "wlpFinTranTypeID": "123e4567-e89b-12d3-a456-000000000138",
                              "transactionCode": "FEE_ACH",
                              "created": "2026-09-15T18:29:59.000Z",
                              "currency": "USD",
                              "symbol": "$"
                            }
                          ],
                          "wlpFinTranTypeID": "123e4567-e89b-12d3-a456-000000000139",
                          "transactionCode": {
                            "code": "DISBURSEMENT_ACH_MT",
                            "type": "CSD",
                            "description": "Cash Disbursement - ACH MT"
                          },
                          "note": "ACH withdrawal",
                          "timestamp": "2026-09-15T18:30:00.000Z"
                        }
                      ],
                      "page": {
                        "hasMore": false
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseModel"
                },
                "examples": {
                  "from is required": {
                    "value": {
                      "errorCode": "E030",
                      "message": "Invalid or missing parameters in the request URL. Refer to the API documentation for details. Details: from is required"
                    }
                  },
                  "to is required": {
                    "value": {
                      "errorCode": "E030",
                      "message": "Invalid or missing parameters in the request URL. Refer to the API documentation for details. Details: to is required"
                    }
                  },
                  "Invalid category": {
                    "value": {
                      "errorCode": "E025",
                      "message": "Invalid or badly formatted request. Refer to the API documentation for details. Details: category must be DEPOSIT or REDEMPTION: NONSENSE"
                    }
                  },
                  "Invalid sort": {
                    "value": {
                      "errorCode": "E025",
                      "message": "Invalid or badly formatted request. Refer to the API documentation for details. Details: sort must be 'timestamp' (ascending) or '-timestamp' (descending): amount"
                    }
                  },
                  "Limit should be greater than 0": {
                    "value": {
                      "errorCode": "E025",
                      "message": "Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be greater than 0."
                    }
                  },
                  "Limit should be less than or equal to 100": {
                    "value": {
                      "errorCode": "E025",
                      "message": "Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be less than or equal to 100"
                    }
                  },
                  "Redundant amount bound": {
                    "value": {
                      "errorCode": "E025",
                      "message": "Invalid or badly formatted request. Refer to the API documentation for details. Details: specify only one of amount[gt] or amount[gte], not both"
                    }
                  },
                  "Invalid amount range": {
                    "value": {
                      "errorCode": "E025",
                      "message": "Invalid or badly formatted request. Refer to the API documentation for details. Details: amount range is invalid: lower bound 500 is not below upper bound 500"
                    }
                  },
                  "Unknown offset paymentID": {
                    "value": {
                      "errorCode": "E025",
                      "message": "Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid offset: payment not found for paymentId not-a-real-payment-id"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorCode": {
        "type": "string",
        "description": "The error code that is returned when an error occurs.",
        "example": "E032"
      },
      "ErrorCodeMessage": {
        "type": "string",
        "description": "The error message that is returned when an error occurs."
      },
      "ErrorDetails": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "JSON field name from the request body that caused an error"
          },
          "type": {
            "type": "string",
            "enum": [
              "STRING",
              "ARRAY",
              "INT",
              "DECIMAL",
              "BOOL",
              "TEXT",
              "UUID",
              "DATE",
              "MAP",
              "OBJECT",
              "ENUM"
            ],
            "description": "Expected data type of the field",
            "x-enumDescriptions": {
              "STRING": "The value is a string.",
              "ARRAY": "The value is an array.",
              "INT": "The value is an integer.",
              "DECIMAL": "The value is a decimal number.",
              "BOOL": "The value is a boolean.",
              "TEXT": "The value is free-form text.",
              "UUID": "The value is a UUID.",
              "DATE": "The value is a date.",
              "MAP": "The value is a key-value map.",
              "OBJECT": "The value is an object.",
              "ENUM": "The value is one of a fixed set of enumerated values."
            }
          },
          "allowedValues": {
            "type": "string",
            "description": "Example values which are allowed in the field"
          },
          "detail": {
            "type": "string",
            "description": "Additional validation or error details for the field"
          }
        }
      },
      "ErrorResponseModel": {
        "type": "object",
        "description": "The error response model that is returned when an error occurs.",
        "required": [
          "errorCode",
          "message"
        ],
        "properties": {
          "errorCode": {
            "$ref": "#/components/schemas/ErrorCode"
          },
          "message": {
            "$ref": "#/components/schemas/ErrorCodeMessage"
          },
          "errorDetails": {
            "$ref": "#/components/schemas/ErrorDetails"
          }
        }
      },
      "userID": {
        "type": "string",
        "example": "123e4567-e89b-12d3-a456-000000000004",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nA unique identifier created for each User on DriveWealth's platform.",
        "x-sensitive": true
      },
      "accountID": {
        "type": "string",
        "example": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe user's unique account identifier.",
        "x-sensitive": true
      },
      "accountNo": {
        "type": "string",
        "example": "FFFF000005",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe user's unique account number, that is human readable.",
        "x-sensitive": true
      },
      "accountTypeObject": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "LIVE",
            "description": "The type of account that has been created."
          },
          "description": {
            "type": "string",
            "example": "Live Account",
            "description": "A custom description of the account type."
          }
        }
      },
      "accountManagementTypeObject": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "SELF",
            "description": "The type of account who has trading authority.",
            "enum": [
              "SELF",
              "ADVISORY",
              "RIA_MANAGED",
              "CUSTODIAL",
              "CUSTODIAL_MANAGED",
              "RESERVE",
              "RETIREMENT_TRADITIONAL_SELF",
              "RETIREMENT_TRADITIONAL_ADVISORY",
              "RETIREMENT_TRADITIONAL_RIA_MANAGED",
              "RETIREMENT_ROTH_SELF",
              "RETIREMENT_ROTH_ADVISORY",
              "RETIREMENT_ROTH_RIA_MANAGED",
              "TRUST_SELF",
              "TRUST_ADVISORY",
              "TRUST_RIA_MANAGED",
              "HSA_SELF",
              "HSA_ADVISORY",
              "HSA_RIA_MANAGED",
              "BUSINESS_SELF",
              "BUSINESS_ADVISORY",
              "BUSINESS_RIA_MANAGED",
              "TRUMP_SELF"
            ],
            "x-enumDescriptions": {
              "SELF": "A user directs trades in their own account without advice.",
              "ADVISORY": "An Investment Advisor or Investment Advisor Representative has access to the account, but trades are placed only with the user's authorization.",
              "RIA_MANAGED": "An Investment Advisor has discretion to place trades in the account.",
              "CUSTODIAL": "An account held for the benefit of a minor.",
              "CUSTODIAL_MANAGED": "A custodial account with discretionary trading managed by an advisor.",
              "RESERVED": "Reserved for future use; not currently assigned.",
              "RETIREMENT_TRADITIONAL_SELF": "A self-directed Traditional IRA retirement account.",
              "RETIREMENT_TRADITIONAL_ADVISORY": "A Traditional IRA retirement account accessible to an advisor, with trades placed only by the user's authorization.",
              "RETIREMENT_TRADITIONAL_RIA_MANAGED": "A Traditional IRA retirement account with discretionary trading managed by an advisor.",
              "RETIREMENT_ROTH_SELF": "A self-directed Roth IRA retirement account.",
              "RETIREMENT_ROTH_ADVISORY": "A Roth IRA retirement account accessible to an advisor, with trades placed only by the user's authorization.",
              "RETIREMENT_ROTH_RIA_MANAGED": "A Roth IRA retirement account with discretionary trading managed by an advisor.",
              "TRUST_SELF": "A self-directed Trust account.",
              "TRUST_ADVISORY": "A Trust account accessible to an advisor, with trades placed only by the user's authorization.",
              "TRUST_RIA_MANAGED": "A Trust account with discretionary trading managed by an advisor.",
              "HSA_SELF": "A self-directed Health Savings Account.",
              "HSA_ADVISORY": "A Health Savings Account accessible to an advisor, with trades placed only by the user's authorization.",
              "HSA_RIA_MANAGED": "A Health Savings Account with discretionary trading managed by an advisor.",
              "BUSINESS_SELF": "A self-directed Business account.",
              "BUSINESS_ADVISORY": "A Business account accessible to an advisor, with trades placed only by the user's authorization.",
              "BUSINESS_RIA_MANAGED": "A Business account with discretionary trading managed by an advisor.",
              "TRUMP_SELF": "A self-directed Trump account."
            }
          },
          "description": {
            "type": "string",
            "example": "Self Directed Account",
            "description": "A custom description of the account management type."
          }
        }
      },
      "updated": {
        "type": "string",
        "example": "2022-12-11T22:28:21.810Z",
        "description": ""
      },
      "feeTransactionCode": {
        "description": "The transaction code of the fee. State income tax withholding uses either the generic `FEE_STATE_TAX` code or a per-state code of the form `FEE_STATE_TAX_<XX>`, where `<XX>` is the two-letter state code (e.g. `FEE_STATE_TAX_CA`), depending on partner configuration.",
        "example": "FEE_ACH",
        "oneOf": [
          {
            "type": "string",
            "title": "Fee code",
            "enum": [
              "FEE_ACH",
              "FEE_WIRE",
              "FEE_WIRE_DOMESTIC",
              "FEE_WIRE_INTERNATIONAL",
              "FEE_FEDERAL_TAX",
              "FEE_STATE_TAX"
            ],
            "x-enumDescriptions": {
              "FEE_ACH": "An ACH transfer fee.",
              "FEE_WIRE": "A wire transfer fee.",
              "FEE_WIRE_DOMESTIC": "A domestic wire transfer fee.",
              "FEE_WIRE_INTERNATIONAL": "An international wire transfer fee.",
              "FEE_FEDERAL_TAX": "U.S. federal income tax withholding.",
              "FEE_STATE_TAX": "U.S. state income tax withholding, when a per-state `FEE_STATE_TAX_<XX>` code is not used."
            }
          },
          {
            "type": "string",
            "title": "Per-state tax withholding code",
            "pattern": "^FEE_STATE_TAX_[A-Z]{2}$",
            "example": "FEE_STATE_TAX_CA",
            "description": "U.S. state income tax withholding for a specific state, where the suffix is the two-letter state code."
          }
        ]
      },
      "transactionCodeType": {
        "type": "string",
        "example": "CSR",
        "enum": [
          "CSR",
          "CSD"
        ],
        "x-enumDescriptions": {
          "CSR": "Cash receipt.",
          "CSD": "Cash disbursement."
        }
      },
      "note": {
        "type": "string",
        "example": "Hey! Welcome to DriveWealth Developer Docs!",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nA way to store a message/comment on the this object. Do not put personal or account data in this field.",
        "x-sensitive": true
      },
      "wlpFinTranTypeID": {
        "type": "string",
        "example": "123e4567-e89b-12d3-a456-00000000004c",
        "description": "A unique identifier to id different type of transactions."
      },
      "depositSeasoningStatusStatus": {
        "type": "number",
        "example": 2,
        "description": "The current status of the payment ach settlement."
      },
      "depositsSeasoningStatusMessage": {
        "type": "string",
        "example": "SEASONING",
        "description": "A custom message about the current status of the payment ach settlement."
      },
      "seasoningPeriodExpires": {
        "type": "string",
        "example": "2026-01-09T22:28:21.810Z",
        "description": ""
      },
      "depositBuyingPowerHoldExpires": {
        "type": "string",
        "example": "2026-01-09T22:28:21.810Z",
        "description": ""
      },
      "currency": {
        "type": "string",
        "example": "USD",
        "description": "The name of the currency in abbreviation form.",
        "enum": [
          "USD"
        ],
        "x-enumDescriptions": {
          "USD": "U.S. Dollar."
        }
      },
      "currencySymbol": {
        "type": "string",
        "example": "$",
        "description": "The currency symbol.",
        "enum": [
          "$"
        ],
        "x-enumDescriptions": {
          "$": "U.S. Dollar symbol."
        }
      },
      "currencyObject": {
        "type": "object",
        "properties": {
          "name": {
            "$ref": "#/components/schemas/currency"
          },
          "description": {
            "type": "string",
            "example": "US Dollar",
            "description": "A custom description about the currency."
          },
          "symbol": {
            "$ref": "#/components/schemas/currencySymbol"
          }
        }
      },
      "finTranReference": {
        "type": "string",
        "example": "HG.123e4567-e89b-12d3-a456-00000000004e",
        "description": "The unique identifier that references back to the specific transaction."
      },
      "iraDistribution": {
        "type": "string",
        "example": "EARLY_DISTRIBUTION_PENALTY_EXCEPTION",
        "description": "The type of redemption/withdrawal from an IRA type of account.\n\nNote: Trump accounts follow specific requirements for external account transfers or distributions. Click [here](https://developer.drivewealth.com/apis/v1.82.0/reference/enums?isFramePreview=true#trump-distribution-types) for more details.",
        "enum": [
          "NORMAL_DISTRIBUTION",
          "EARLY_DISTRIBUTION",
          "EARLY_DISTRIBUTION_PENALTY_EXCEPTION",
          "DIRECT_ROLLOVER",
          "DIRECT_TRANSFER",
          "REQUIRED_MINIMUM_DISTRIBUTION",
          "DISTRIBUTION_TO_BENEFICIARY",
          "RETURN_OF_EXCESS_CONTRIBUTION",
          "QUALIFIED_CHARITABLE_CONTRIBUTION"
        ],
        "x-enumDescriptions": {
          "NORMAL_DISTRIBUTION": "A normal distribution.",
          "EARLY_DISTRIBUTION": "An early distribution, subject to penalty.",
          "EARLY_DISTRIBUTION_PENALTY_EXCEPTION": "An early distribution that qualifies for a penalty exception.",
          "DIRECT_ROLLOVER": "A direct rollover to another retirement account.",
          "DIRECT_TRANSFER": "A direct transfer to another retirement account.",
          "REQUIRED_MINIMUM_DISTRIBUTION": "A required minimum distribution (RMD).",
          "DISTRIBUTION_TO_BENEFICIARY": "A distribution to a beneficiary.",
          "RETURN_OF_EXCESS_CONTRIBUTION": "A return of an excess contribution.",
          "QUALIFIED_CHARITABLE_CONTRIBUTION": "A qualified charitable distribution (QCD)."
        }
      },
      "iraDistributionSubType": {
        "type": "string",
        "example": "SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP_72T",
        "description": "These types are only applicable for the distribution type EARLY_DISTRIBUTION_PENALTY_EXCEPTION. Click [here](https://developer.drivewealth.com/apis/reference/enums#ira-distribution-subtypes) for more details.\",",
        "enum": [
          "SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP_72T",
          "DISABILITY_OR_DEATH",
          "HIGHER_EDUCATION_EXPENSES",
          "FIRST_TIME_HOME_PURCHASE",
          "MEDICAL_EXPENSES",
          "HEALTH_INSURANCE_PREMIUMS",
          "RESERVIST_DISTRIBUTIONS"
        ],
        "x-enumDescriptions": {
          "SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP_72T": "Structured periodic withdrawals under Section 72(t).",
          "DISABILITY_OR_DEATH": "Exempt from the early-distribution penalty due to disability or death.",
          "HIGHER_EDUCATION_EXPENSES": "Used for tuition, books, and fees at a qualified institution.",
          "FIRST_TIME_HOME_PURCHASE": "Up to $10,000 used toward a first home purchase.",
          "MEDICAL_EXPENSES": "Used for unreimbursed medical expenses exceeding 7.5% of adjusted gross income.",
          "HEALTH_INSURANCE_PREMIUMS": "Used for health insurance premiums while unemployed for 12+ weeks.",
          "RESERVIST_DISTRIBUTIONS": "A distribution for a qualified reservist called to active duty."
        }
      },
      "username": {
        "type": "string",
        "example": "ttc.user.john",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe username of the user.",
        "x-sensitive": true
      },
      "parentIBIDObject": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "123e4567-e89b-12d3-a456-000000000005",
            "description": "The unique identifier of an associated organization."
          },
          "name": {
            "type": "string",
            "example": "Tendies Trading Company",
            "description": "The organization name."
          }
        }
      },
      "firstName": {
        "type": "string",
        "example": "John",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe first name of the user.",
        "x-sensitive": true
      },
      "lastName": {
        "type": "string",
        "example": "Smith",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe last (family) name of the user.",
        "x-sensitive": true
      },
      "email": {
        "type": "string",
        "example": "john.doe@example.com",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe user's email address.",
        "x-sensitive": true
      },
      "wlpID": {
        "type": "string",
        "example": "TTC",
        "description": "The wlpID is a deep backoffice ID that identifies each partner from each other."
      },
      "FundingSeasoningDetails": {
        "type": "object",
        "properties": {
          "status": {
            "$ref": "#/components/schemas/depositSeasoningStatusStatus"
          },
          "statusMessage": {
            "$ref": "#/components/schemas/depositsSeasoningStatusMessage"
          },
          "seasoningPeriodExpires": {
            "$ref": "#/components/schemas/seasoningPeriodExpires"
          },
          "depositBuyingPowerHoldExpires": {
            "$ref": "#/components/schemas/depositBuyingPowerHoldExpires"
          }
        }
      },
      "withdrawalAccountDetails": {
        "type": "object",
        "properties": {
          "accountID": {
            "$ref": "#/components/schemas/accountID"
          },
          "accountNo": {
            "$ref": "#/components/schemas/accountNo"
          },
          "accountType": {
            "$ref": "#/components/schemas/accountTypeObject"
          },
          "accountManagementType": {
            "$ref": "#/components/schemas/accountManagementTypeObject"
          }
        }
      },
      "iraContribution": {
        "type": "string",
        "example": "POSTPONED_CONTRIBUTION",
        "description": "The type of contribution deposit for retirement accounts.\n\nNote: Trump accounts have their own enums. Click [here](https://developer.drivewealth.com/apis/v1.82.0/reference/enums?isFramePreview=true#trump-contribution-types) for more details.",
        "enum": [
          "CURRENT_YEAR",
          "PRIOR_YEAR",
          "POSTPONED_CONTRIBUTION",
          "REPAYMENT",
          "SEC_128_EMPLOYER",
          "OTHER_SOURCE",
          "QUALIFIED_ROLLOVER",
          "PILOT_PROGRAM",
          "QUALIFIED_GENERAL",
          "PROMOTIONAL_EARNING",
          "CORRECTIVE_DEPOSIT"
        ],
        "x-enumDescriptions": {
          "CURRENT_YEAR": "A contribution for the current tax year.",
          "PRIOR_YEAR": "A contribution for the prior tax year.",
          "POSTPONED_CONTRIBUTION": "A postponed contribution.",
          "REPAYMENT": "A repayment contribution.",
          "SEC_128_EMPLOYER": "An employer contribution (Trump account).",
          "OTHER_SOURCE": "An individual contribution (Trump account).",
          "QUALIFIED_ROLLOVER": "A trustee-to-trustee transfer of the entire balance from another Trump account.",
          "PILOT_PROGRAM": "A contribution under the U.S. Treasury pilot program (Trump account).",
          "QUALIFIED_GENERAL": "A grant from a government, tribe, or 501(c)(3) organization (Trump account).",
          "PROMOTIONAL_EARNING": "A promotional earning contribution.",
          "CORRECTIVE_DEPOSIT": "A non-contribution cash deposit into a retirement account to correct an error, restore a loss, or provide an incentive. Not counted toward contribution limits or reported as a contribution."
        }
      },
      "iraContributionSubType": {
        "type": "string",
        "example": "SC",
        "description": "The sub type to be used for POSTPONED_CONTRIBUTION, REPAYMENT, PROMOTIONAL_EARNING, or CORRECTIVE_DEPOSIT contributions for retirement accounts. Click [here](https://developer.drivewealth.com/apis/reference/enums#ira-contribution-subtypes) for more details.",
        "enum": [
          "SC",
          "PO",
          "FD",
          "EO",
          "PL",
          "QR",
          "DD",
          "BA",
          "EP",
          "DA",
          "TI",
          "SU",
          "FR",
          "RF",
          "RB",
          "RL",
          "AT",
          "AF",
          "AD"
        ],
        "x-enumDescriptions": {
          "SC": "The self-certification procedure for a late rollover contribution.",
          "PO": "A rollover of a qualified plan loan offset.",
          "FD": "Due to a federally designated disaster.",
          "EO": "Combat zone or hazardous duty area, declared by Executive Order.",
          "PL": "Combat zone or hazardous duty area, not declared by Executive Order.",
          "QR": "Repayment of a qualified reservist distribution.",
          "DD": "Repayment of a qualified disaster recovery distribution.",
          "BA": "Repayment of a qualified birth or adoption distribution.",
          "EP": "Repayment of an emergency personal expense distribution.",
          "DA": "Repayment of a domestic abuse victim distribution.",
          "TI": "Repayment of a terminally ill individual distribution.",
          "SU": "A signup bonus (account opening bonus).",
          "FR": "A fee reimbursement (e.g. prior broker exit fee).",
          "RF": "Restorative payment: reimbursement for fraud or theft of account funds.",
          "RB": "Restorative payment: settlement for breach of fiduciary duty or bad investment advice.",
          "RL": "Restorative payment: class action settlement or court/arbitration-ordered award.",
          "AT": "Administrative correction: credit for missed gains due to a failed/late trade execution.",
          "AF": "Administrative correction: refund of a mistakenly charged management or NSF fee.",
          "AD": "Administrative correction: manual credit for a dividend that failed to post."
        }
      },
      "reportableTaxYear": {
        "type": "integer",
        "example": 2026,
        "nullable": true,
        "description": "The tax year the IRA contribution deposit is reportable for, derived from the transaction date and iraContribution type. `null` for deposits that are not retirement-account contributions."
      },
      "feeObject": {
        "type": "object",
        "required": [
          "type",
          "amount"
        ],
        "properties": {
          "type": {
            "description": "The type of fee that is being applied.",
            "allOf": [
              {
                "$ref": "#/components/schemas/feeTransactionCode"
              }
            ]
          },
          "description": {
            "type": "string",
            "example": "Fee - ACH",
            "description": "A custom description that describes the fee type."
          },
          "amount": {
            "type": "number",
            "example": -5.99,
            "description": "The amount of the fee that is being applied."
          },
          "wlpFinTranTypeID": {
            "$ref": "#/components/schemas/wlpFinTranTypeID"
          },
          "transactionCode": {
            "$ref": "#/components/schemas/feeTransactionCode"
          },
          "finTranReference": {
            "$ref": "#/components/schemas/finTranReference"
          },
          "created": {
            "type": "string",
            "example": "2022-12-11T22:28:21.810Z",
            "description": "The timestamp of when the fee was charged."
          },
          "currency": {
            "$ref": "#/components/schemas/currency"
          },
          "symbol": {
            "$ref": "#/components/schemas/currencySymbol"
          }
        }
      },
      "settlementProfileID": {
        "type": "string",
        "example": "settlement-profile-bank-account-1",
        "description": "A settlement profile identifier that links to a specific bank account for fund settlement."
      },
      "Payment": {
        "type": "object",
        "description": "A single deposit or redemption, as returned by the unified funding-payments search.",
        "required": [
          "id",
          "paymentID",
          "accountID",
          "category",
          "status",
          "timestamp"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/paymentID"
          },
          "paymentID": {
            "$ref": "#/components/schemas/paymentID"
          },
          "accountID": {
            "$ref": "#/components/schemas/accountID"
          },
          "category": {
            "type": "string",
            "example": "DEPOSIT",
            "enum": [
              "DEPOSIT",
              "REDEMPTION"
            ],
            "description": "The category of the payment."
          },
          "type": {
            "type": "string",
            "example": "ACH",
            "description": "The payment's vendor/method type, e.g. `ACH`, `WIRE`, `WIRE_DIRECT2BANK`, `BULK_FUNDING`, `CASH_TRANSFER`."
          },
          "amount": {
            "type": "number",
            "example": -50.5,
            "description": "The payment amount (negative for redemptions, positive for deposits)."
          },
          "currency": {
            "$ref": "#/components/schemas/currencyObject"
          },
          "details": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Free-form payment details, with sensitive values (personal ID, full bank account/routing numbers) stripped or masked. Omitted when the payment has no details.",
            "example": {
              "bankAccountNickname": "John's checking account",
              "bankRoutingNumber": "****0000",
              "bankAccountNumber": "****2227"
            }
          },
          "status": {
            "$ref": "#/components/schemas/paymentStatusObject"
          },
          "seasoningDetails": {
            "allOf": [
              {
                "$ref": "#/components/schemas/FundingSeasoningDetails"
              }
            ],
            "description": "Present only for eligible Modern Treasury deposits pending seasoning; omitted otherwise."
          },
          "userDetails": {
            "$ref": "#/components/schemas/UnifiedFundingUserDetails"
          },
          "accountDetails": {
            "$ref": "#/components/schemas/withdrawalAccountDetails"
          },
          "fees": {
            "type": "array",
            "description": "A list of fees associated with the payment.",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/feeObject"
                }
              ]
            }
          },
          "wlpFinTranTypeID": {
            "$ref": "#/components/schemas/wlpFinTranTypeID"
          },
          "transactionCode": {
            "$ref": "#/components/schemas/UnifiedTransactionCode"
          },
          "finTranReference": {
            "$ref": "#/components/schemas/finTranReference"
          },
          "note": {
            "$ref": "#/components/schemas/note"
          },
          "timestamp": {
            "type": "string",
            "example": "2026-09-15T18:28:11.267Z",
            "description": "The date and time the payment was created."
          },
          "liquidateAccount": {
            "$ref": "#/components/schemas/liquidateAccount"
          },
          "returned": {
            "$ref": "#/components/schemas/returned"
          },
          "settlementProfileID": {
            "$ref": "#/components/schemas/settlementProfileID"
          },
          "reportableTaxYear": {
            "$ref": "#/components/schemas/reportableTaxYear"
          },
          "iraContribution": {
            "$ref": "#/components/schemas/iraContribution"
          },
          "iraContributionSubType": {
            "$ref": "#/components/schemas/iraContributionSubType"
          },
          "iraDistribution": {
            "$ref": "#/components/schemas/iraDistribution"
          },
          "iraDistributionSubType": {
            "$ref": "#/components/schemas/iraDistributionSubType"
          }
        }
      },
      "UnifiedTransactionCode": {
        "type": "object",
        "description": "Unlike the legacy deposit/redemption endpoints, the unified search isn't limited to a small fixed set of codes, so `code` is not a closed enum here.",
        "properties": {
          "code": {
            "type": "string",
            "example": "RECEIPT_OTHER",
            "description": "The transaction (batch) code identifying how/why the payment was posted."
          },
          "type": {
            "$ref": "#/components/schemas/transactionCodeType"
          },
          "description": {
            "type": "string",
            "example": "Cash Receipt - Other e.g. TransferWise, Currencycloud, etc.",
            "description": "A custom description about the transaction code."
          }
        }
      },
      "UnifiedFundingUserDetails": {
        "type": "object",
        "description": "Same shape as FundingUserDetails, but the parent-IB field is named `parentIB` here, not `parentIBID`.",
        "properties": {
          "userID": {
            "$ref": "#/components/schemas/userID"
          },
          "username": {
            "$ref": "#/components/schemas/username"
          },
          "firstName": {
            "$ref": "#/components/schemas/firstName"
          },
          "lastName": {
            "$ref": "#/components/schemas/lastName"
          },
          "email": {
            "$ref": "#/components/schemas/email"
          },
          "parentIB": {
            "$ref": "#/components/schemas/parentIBIDObject"
          },
          "wlpID": {
            "$ref": "#/components/schemas/wlpID"
          },
          "settlementProfileID": {
            "$ref": "#/components/schemas/settlementProfileID"
          }
        }
      },
      "PaymentsSearchResponse": {
        "type": "object",
        "properties": {
          "pageSize": {
            "type": "integer",
            "example": 25,
            "description": "The number of payments returned in this page."
          },
          "limit": {
            "type": "integer",
            "example": 25,
            "description": "The page size that was applied to this request."
          },
          "payments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Payment"
            }
          },
          "page": {
            "type": "object",
            "properties": {
              "hasMore": {
                "type": "boolean",
                "example": true,
                "description": "Whether more payments remain beyond this page."
              },
              "nextCursor": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/paymentID"
                  }
                ],
                "description": "The `paymentID` to pass as `offset` to fetch the next page. Omitted when `hasMore` is false."
              }
            }
          }
        }
      },
      "paymentID": {
        "type": "string",
        "example": "11AA000001-1234567890128-RJJLU",
        "description": "A unique identifier for the payment (a deposit or redemption)."
      },
      "paymentStatusObject": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "example": 2,
            "description": "The current status of the payment, in integer form."
          },
          "message": {
            "type": "string",
            "example": "Successful",
            "description": "The current status of the payment.",
            "enum": [
              "Started",
              "Pending",
              "Successful",
              "Failed",
              "Other",
              "Returned",
              "RIA_Pending",
              "RIA_Approved",
              "RIA_Rejected",
              "Approved",
              "Rejected",
              "On_Hold",
              "Processing",
              "Remitted",
              "Return_Pending",
              "Unknown"
            ],
            "x-enumDescriptions": {
              "Started": "The payment request has been initiated but processing has not yet begun.",
              "Pending": "The payment is queued for processing.",
              "Successful": "The payment completed successfully.",
              "Failed": "The payment failed to process.",
              "Other": "The payment is in a state not covered by the other status values.",
              "Returned": "The payment was returned by the receiving bank after being sent.",
              "RIA_Pending": "The payment is awaiting approval from the account's Registered Investment Advisor (RIA).",
              "RIA_Approved": "The account's RIA has approved the payment, which is now awaiting completion.",
              "RIA_Rejected": "The account's RIA rejected the payment.",
              "Approved": "The payment has been approved and is awaiting completion.",
              "Rejected": "The payment was rejected.",
              "On_Hold": "The payment is held for manual review before it can proceed.",
              "Processing": "The payment is actively being processed.",
              "Remitted": "Funds for the payment have been remitted to their destination.",
              "Return_Pending": "The payment is in the process of being returned by the receiving bank.",
              "Unknown": "The payment's status could not be determined."
            }
          },
          "comment": {
            "type": "string",
            "example": "Valid request. Auto-move to Successful",
            "description": "A custom comment about the current status of the payment."
          },
          "updated": {
            "allOf": [
              {
                "$ref": "#/components/schemas/updated"
              }
            ],
            "description": "The last updated timestamp of the status of the payment."
          }
        }
      },
      "liquidateAccount": {
        "type": "boolean",
        "example": false,
        "description": "For a managed-account redemption, whether the request instructed DriveWealth to fully liquidate the account. Omitted for deposits."
      },
      "returned": {
        "type": "string",
        "example": "2026-09-15",
        "description": "The date the payment was returned by the bank. Omitted if it has not been returned."
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  }
}
```

# Sibling pages

* [List User Payments](https://developer.drivewealth.com/apis/reference/get_users-userid-funding-payments.md)
* [List Partner Payments](https://developer.drivewealth.com/apis/reference/get_funding-payments.md)