Payments

List Partner Payments

Retrieves a unified, chronological list of deposits and redemptions across every account under a partner.

get/funding/payments

Request

Base URL
https://bo-api.drivewealth.io/back-office
URL
https://bo-api.drivewealth.io/back-office/funding/payments
Auth
HTTP bearer

Query parameters

partnerIDstring

The partner's unique identifier.

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

Filters payments by partnerID. Defaults to the caller's own partnerID; only DriveWealth's own parentIB caller may pass a different one.

fromstring required

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

tostring 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.

categorystring[]

Payment categories to filter by (comma separated for multiple).

statusstring

Comma separated payment statuses to filter by.

typestring

Comma separated payment (vendor) types to filter by.

sort'timestamp' | '-timestamp'

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

limitinteger

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

offsetstring

A unique identifier for the payment (a deposit or redemption).

Example:11AA000001-1234567890128-RJJLU

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

amount[gt]number

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

amount[gte]number

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

amount[lt]number

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

amount[lte]number

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

Response

Retrieving a list of Partner Payments was Successful.

pageSizeinteger

The number of payments returned in this page.

limitinteger

The page size that was applied to this request.

Example response

{
  "pageSize": 25,
  "limit": 25,
  "payments": [
    {
      "id": "11AA000001-1234567890128-RJJLU",
      "paymentID": "11AA000001-1234567890128-RJJLU",
      "accountID": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
      "category": "DEPOSIT",
      "type": "ACH",
      "amount": -50.5,
      "currency": {
        "name": "USD",
        "description": "US Dollar",
        "symbol": "$"
      },
      "details": {
        "bankAccountNickname": "John's checking account",
        "bankRoutingNumber": "****0000",
        "bankAccountNumber": "****2227"
      },
      "status": {
        "id": 2,
        "message": "Successful",
        "comment": "Valid request. Auto-move to Successful",
        "updated": "2022-12-11T22:28:21.810Z"
      },
      "seasoningDetails": {
        "status": 2,
        "statusMessage": "SEASONING",
        "seasoningPeriodExpires": "2026-01-09T22:28:21.810Z",
        "depositBuyingPowerHoldExpires": "2026-01-09T22:28:21.810Z"
      },
      "userDetails": {
        "userID": "123e4567-e89b-12d3-a456-000000000004",
        "username": "ttc.user.john",
        "firstName": "John",
        "lastName": "Smith",
        "email": "john.doe@example.com",
        "parentIB": {
          "id": "123e4567-e89b-12d3-a456-000000000005",
          "name": "Tendies Trading Company"
        },
        "wlpID": "TTC",
        "settlementProfileID": "settlement-profile-bank-account-1"
      },
      "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",
      "transactionCode": {
        "code": "RECEIPT_OTHER",
        "type": "CSR",
        "description": "Cash Receipt - Other e.g. TransferWise, Currencycloud, etc."
      },
      "finTranReference": "HG.123e4567-e89b-12d3-a456-00000000004e",
      "note": "Hey! Welcome to DriveWealth Developer Docs!",
      "timestamp": "2026-09-15T18:28:11.267Z",
      "returned": "2026-09-15",
      "settlementProfileID": "settlement-profile-bank-account-1",
      "reportableTaxYear": 2026,
      "iraContribution": "POSTPONED_CONTRIBUTION",
      "iraContributionSubType": "SC",
      "iraDistribution": "EARLY_DISTRIBUTION_PENALTY_EXCEPTION",
      "iraDistributionSubType": "SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP_72T"
    }
  ],
  "page": {
    "hasMore": true,
    "nextCursor": "11AA000001-1234567890128-RJJLU"
  }
}

Changes

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