DRdrivewealth
Settlements

Attest Bulk Funding Settlement

Attests a Bulk Funding Settlement if it is in a successful state and not already attested. Only available if the attestation feature is enabled for the partner.

patch/settlements/{settlementID}/attest

Request

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/settlements/{settlementID}/attest
  • 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

The ID of the Bulk Funding Settlement to attest

Response

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

idstring

A unique identifier that identifies the settlement.

settlementDatestring
status'SUCCESSFUL'

The status of the attested settlement.

statusCommentstring

A custom comment about the current status of the settlement.

breakdownReportstring url

A URL to a JSON file that breaks down all the deposits or withdrawals across sub accounts over the course of the settlement date.

partnerIDstring

The partner's unique identifier.

settlementProfileIDstring

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

updatedBy'SYSTEM REPORT SERVICE' | 'INSTANT FUNDING BREAKDOWN JOB'
createdAtstring
updatedAtstring
attestedBystring

User ID of the person who attested the settlement report.

attestedAtstring

The date and time when the settlement report was attested.

Example response

{
  "cashBalance": 25000.75,
  "cashSettlementAccountID": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
  "cashSettlementAccountNo": "DW123456789",
  "id": "sett_123e4567-e89b-12d3-a456-000000000060_settle-profile-usa_20221224",
  "settlementDate": "2022-12-25",
  "status": "SUCCESSFUL",
  "statusComment": "Finished processing breakdown",
  "amount": {
    "total": 5000.45,
    "credits": 6000.45,
    "debits": -1000
  },
  "breakdownReport": "https://d111111abcdef8.cloudfront.net/singleSettlementReport....",
  "partnerID": "123e4567-e89b-12d3-a456-000000000005",
  "settlementProfileID": "settlement-profile-bank-account-1",
  "updatedBy": "SYSTEM",
  "createdAt": "2022-12-11T22:28:21.810Z",
  "updatedAt": "2022-12-11T22:28:21.810Z",
  "attestedBy": "123e4567-e89b-12d3-a456-000000000167",
  "attestedAt": "2024-04-17T22:28:21.810Z"
}

Changes

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