Settlements

Attest Cashless Reconciliation

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

patch/funding/reconciliations/{reconciliationID}/attest

Request

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/funding/reconciliations/{reconciliationID}/attest
  • Auth
    HTTP bearer

Path parameters

reconciliationIDstring required

The ID of the reconciliation report 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

The unique identifier of the reconciliation report.

datestring

The date of when the reconciliation report was generated for.

status'SUCCESSFUL'

The status of the attested reconciliation.

statusCommentstring

A custom comment about the status.

reconciliationBreakdownstring
partnerIDstring

The unique identifier of the firm.

settlementProfileIDstring

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

createdstring

The date and time when the reconciliation report was created.

updatedstring

The date and time when the reconciliation report was last updated.

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

User ID of the person who attested the reconciliation report.

attestedAtstring

The date and time when the reconciliation report was attested.

Example response

{
  "cashBalance": 25000.75,
  "cashSettlementAccountID": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
  "cashSettlementAccountNo": "DW123456789",
  "id": "123e4567-e89b-12d3-a456-000000000005_20240417",
  "date": "2024-04-17",
  "status": "SUCCESSFUL",
  "statusComment": "Finished processing breakdown",
  "amounts": {
    "total": -1263.56,
    "purchases": -1680.07,
    "purchasesOptions": -250,
    "sales": 416.51,
    "salesOptions": 250
  },
  "transferAmounts": {
    "currency": "USD",
    "payablesToDW": 1263.56
  },
  "partnerID": "123e4567-e89b-12d3-a456-000000000005",
  "settlementProfileID": "settlement-profile-bank-account-1",
  "created": "2024-04-15T22:28:21.810Z",
  "updated": "2024-04-17T22:28:21.810Z",
  "updatedBy": "SYSTEM",
  "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.