v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB

Settlements

List Cashless Reconciliations

Fetches a list of daily reconciliations for a firm using cashless settlement.

get/funding/reconciliations

Query parameters

tostring required

The date and time in which to end at.

fromstring required

The date and time in which to start from.

status'PENDING' | 'APPROVED' | 'PROCESSING' | 'SUCCESSFUL' | 'FAILED'

The current status of the reconciliation report.

Example:APPROVED

Filters the reconciliations reports by the status of reconciliation.

Response

Fetching a list of daily reconciliations for a firm was successful.

idstring

The unique identifier of the reconciliation report.

datestring

The date of when the reconciliation report was generated for.

status'PENDING' | 'APPROVED' | 'PROCESSING' | 'SUCCESSFUL' | 'FAILED'

The current status of the reconciliation report.

statusCommentstring

A custom comment about the status.

totalAmountnumber

The total amount due or owed to the firm.

partnerIDstring

The partner's unique identifier.

settlementProfileIDstring

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

createdstring

The date and time the reconciliation report was created.

updatedstring

The date and time the reconciliation report was last updated.

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

attestedAtstring

The date and time when the reconciliation report was attested.

Example response

[
  {
    "id": "80f9b672-120d-4b73-9cc9-42fb3262c4b9_20240417",
    "date": "2024-04-17",
    "status": "APPROVED",
    "statusComment": "Finished processing breakdown",
    "totalAmount": 12001.01,
    "partnerID": "80f9b672-120d-4b73-9ccv9-42fb3262c4b9",
    "settlementProfileID": "settlement-profile-bank-account-1",
    "created": "2024-04-15T22:28:21.810Z",
    "updated": "2024-04-17T22:28:21.810Z",
    "updatedBy": "SYSTEM",
    "attestedAt": "2024-04-17T22:28:21.810Z"
  }
]