Transaction Queries
Look up transaction details, recent transactions, and refund statuses. Requires the transactions:read scope.
POST
/api/v1/{system}/getTransactionDetails🔒 transactions:readGet details of a specific transaction by reference ID.
Auth: Bearer JWT
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| referenceId | string | Yes | Transaction reference |
| branchId | long | Yes | Branch user ID |
Response Example
{
"referenceId": "REF-001",
"grandTotal": "10.00",
"paymentStatus": "SUCCESS",
"channel": "WECHAT",
"tradeNo": "TRADE-123",
"createdAt": "2026-04-14T10:30:00Z"
} SandboxCalls go to
https://payus.co.nzAuthentication
POST
/api/v1/{system}/getRecentTransactions🔒 transactions:readGet paginated recent transactions for a branch. Optionally filter by date range.
Auth: Bearer JWT
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| branchId | long | Yes | Branch user ID |
| startDate | LocalDate | No | Filter start (YYYY-MM-DD) |
| endDate | LocalDate | No | Filter end (YYYY-MM-DD) |
SandboxCalls go to
https://payus.co.nzAuthentication
POST
/api/v1/{system}/find🔒 transactions:readSearch transactions with flexible criteria.
Auth: Bearer JWT
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| branchId | long | Yes | Branch user ID |
| referenceId | string | No | Partial or full reference |
| channel | string | No | Filter by payment channel |
SandboxCalls go to
https://payus.co.nzAuthentication
GET
/api/v1/{system}/refundStatus🔒 transactions:readCheck the status of a refund request.
Auth: Bearer JWT
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| referenceId | string (query) | Yes | Original transaction reference |
| branchId | long (query) | Yes | Branch user ID |
SandboxCalls go to
https://payus.co.nz