v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB

Settlements

Retrieve Cashless Reconciliation

Fetches reconciliations details for a firm using cashless settlement.

get/funding/reconciliations/{reconciliationID}

Path parameters

reconciliationIDstring required

The unique identifier of the reconciliation report.

Example:80f9b672-120d-4b73-9cc9-42fb3262c4b9_20240417

The unique identifier of the reconciliation report.

Response

Fetching a firm's reconciliation details 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.

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

{
  "id": "80f9b672-120d-4b73-9cc9-42fb3262c4b9_20240417",
  "date": "2024-04-17",
  "status": "APPROVED",
  "statusComment": "Finished processing breakdown",
  "amounts": {
    "total": -1263.56,
    "purchases": -1680.07,
    "sales": 416.51
  },
  "transferAmounts": {
    "currency": "USD",
    "payablesToDW": 1263.56
  },
  "partnerID": "80f9b672-120d-4b73-9cc9-42fb3262c4b9",
  "settlementProfileID": "settlement-profile-bank-account-1",
  "created": "2024-04-15T22:28:21.810Z",
  "updated": "2024-04-17T22:28:21.810Z",
  "updatedBy": "SYSTEM",
  "attestedBy": "66304da9-3h6f-2234-935f-ac6b7933d706",
  "attestedAt": "2024-04-17T22:28:21.810Z"
}