Transaction Queries

Look up transaction details, recent transactions, and refund statuses. Requires the transactions:read scope.

POST/api/v1/{system}/getTransactionDetails🔒 transactions:read

Get 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

FieldTypeRequiredDescription
referenceIdstringYesTransaction reference
branchIdlongYesBranch 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
}
SandboxCalls go to https://payus.co.nz

Authentication

POST/api/v1/{system}/getRecentTransactions🔒 transactions:read

Get paginated recent transactions for a branch. Optionally filter by date range.

Auth: Bearer JWT

Request Body

FieldTypeRequiredDescription
branchIdlongYesBranch user ID
startDatestringNoFilter start ("YYYY-MM-DD")
endDatestringNoFilter end ("YYYY-MM-DD")
SandboxCalls go to https://payus.co.nz

Authentication

POST/api/v1/{system}/find🔒 transactions:read

Search transactions with flexible criteria.

Auth: Bearer JWT

Request Body

FieldTypeRequiredDescription
_datestringYesRange start date ("YYYY-MM-DD"). The branch is derived from the authenticated token.
_date2stringYesRange end date ("YYYY-MM-DD").
SandboxCalls go to https://payus.co.nz

Authentication

GET/api/v1/{system}/refundStatus🔒 transactions:read

Check the status of a refund request.

Auth: Bearer JWT

Request Body

FieldTypeRequiredDescription
referenceIdstring (query)YesOriginal transaction reference
refundTradeNostring (query)YesRefund trade number
branchIdlong (query)YesBranch user ID
configIdlong (query)YesTerminal config ID
terminalIdstring (query)YesTerminal id (from listTerminals)
accessIdstring (query)YesBranch access id
SandboxCalls go to https://payus.co.nz

Authentication