v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB

Settlements

Attest Settlement

Attests a 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

Path parameters

settlementIDstring required

The ID of the settlement report to attest

Response

Attestation successful

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 breakdown of 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

{
  "id": "sett_63ccb073-a7b6-4b33-af77-5baec5cc4494_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://du2c4wzqz90h1.cloudfront.net/singleSettlementReport....",
  "partnerID": "80f9b672-120d-4b73-9ccv9-42fb3262c4b9",
  "settlementProfileID": "settlement-profile-bank-account-1",
  "updatedBy": "SYSTEM",
  "createdAt": "2022-12-11T22:28:21.810Z",
  "updatedAt": "2022-12-11T22:28:21.810Z",
  "attestedBy": "66304da9-3h6f-2234-935f-ac6b7933d706",
  "attestedAt": "2024-04-17T22:28:21.810Z"
}