DRdrivewealth
Settlements

Get Bulk Funding Settlement

Retrieves a Bulk Funding Settlement by settlementID.

get/settlements/{settlementID}

Request

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

Path parameters

settlementIDstring required

A unique identifier that identifies the settlement.

Example:sett_123e4567-e89b-12d3-a456-000000000060_settle-profile-usa_20221224

Response

Retrieving a Bulk Funding Settlement by settlementID was Successful.

cashBalancenumber

Cash balance in the partner's settlement account. Only present if the partner is enabled for automated settlements processing.

cashSettlementAccountIDstring

sensitive The user's unique account identifier.

cashSettlementAccountNostring

Account number of the cash settlement account. Only present if the partner is enabled for automated settlements processing.

Example response

{
  "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.