DRdrivewealth
Settlements

List Bulk Funding Settlements

Retrieves a list of Bulk Funding Settlements.

get/settlements

Request

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

Query parameters

fromstring required

The date to start from.

tostring required

The date to end at.

status'PENDING' | 'APPROVED' | 'SUCCESSFUL'

The current status of the settlement.

Example:PENDING

Filters, the settlements by the status.

settlementProfileIDstring

A settlement profile identifier that links to a specific bank account for fund settlement.

Example:settlement-profile-bank-account-1

Filters, the settlements by the settlement profile.

limitinteger

The number of items to return.

offsetstring

Used for pagination. Set this to the first/last id value of your payload to get the prev/next page of results respectively.

direction'prev' | 'next'

The direction of the pagination.

Response

Retrieving a list of Bulk Funding Settlements was Successful.

pageSizeinteger

The amount of results on the page.

limitinteger

The maximum number of results per page.

Example response

{
  "pageSize": 1,
  "limit": 50,
  "settlements": [
    {
      "cashBalance": 25000.75,
      "cashSettlementAccountID": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
      "cashSettlementAccountNo": "DW123456789"
    }
  ]
}

Changes

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