Settlement
Batch settlement and settlement report generation. Requires the reports:read scope.
POST
/api/v1/{system}/settle🔒 reports:readTrigger end-of-day batch settlement. Sends a settlement report to the specified email.
Auth: Bearer JWT
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| branchId | long | Yes | Branch user ID |
| string | Yes | Email for settlement report | |
| timezone | string | Yes | IANA timezone (e.g. Pacific/Auckland) |
⚠️ Live testing disabled for this endpoint — it modifies data. Use curl or the SDK against your sandbox.
POST
/api/v1/{system}/settlementReport🔒 reports:readGenerate a settlement report for a date range without triggering settlement.
Auth: Bearer JWT
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| branchId | long | Yes | Branch user ID |
| startDate | LocalDate | Yes | Report start date |
| endDate | LocalDate | Yes | Report end date |
SandboxCalls go to
https://payus.co.nz