Transaction Queries
Look up transaction details, recent transactions, and refund statuses. Requires the transactions:read scope.
/api/v1/{system}/getTransactionDetails🔒 transactions:readGet details of a specific transaction by reference ID. This (and getRecentTransactions / find) is where the non-sensitive card remnants live for receipts and reconciliation — maskedCard (last 4), cardType (brand), and gatewayCode (the acquirer EMV approval/auth code). They are NOT on payNow or the Cloud requestStatus response. Note the naming: on payNow the request field `authCode` means the customer's scanned QR/barcode value, whereas the acquirer EMV auth code is always returned as `gatewayCode`.
Auth: Bearer JWT
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| referenceId | string | Yes | Transaction reference |
| branchId | long | Yes | Branch user ID |
Response Example
{
"transaction": {
"referenceId": "REF-001",
"grandTotal": 10.00,
"paymentStatus": "SUCCESS",
"channel": "WECHAT",
"tradeNo": "TRADE-123",
"acquirerName": "SKYZER_PAY",
"maskedCard": "************1234",
"cardType": "VISA",
"gatewayCode": "A12345",
"createdAt": "2026-04-14T10:30:00Z"
},
"refunds": [],
"qrCodeUrl": null
}https://payus.co.nzAuthentication
/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 | string | No | Filter start ("YYYY-MM-DD") |
| endDate | string | No | Filter end ("YYYY-MM-DD") |
https://payus.co.nzAuthentication
/api/v1/{system}/find🔒 transactions:readSearch transactions with flexible criteria.
Auth: Bearer JWT
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| _date | string | Yes | Range start date ("YYYY-MM-DD"). The branch is derived from the authenticated token. |
| _date2 | string | Yes | Range end date ("YYYY-MM-DD"). |
https://payus.co.nzAuthentication
/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 |
| refundTradeNo | string (query) | Yes | Refund trade number |
| branchId | long (query) | Yes | Branch user ID |
| configId | long (query) | Yes | Terminal config ID |
| terminalId | string (query) | Yes | Terminal id (from listTerminals) |
| accessId | string (query) | Yes | Branch access id |
https://payus.co.nz