Query Transactions

Return a paginated list of matching transactions.

Request

query Parameters

limit	integer <int32> Maximum results per page. Default to 20, must be between 1 and 500.
page	integer <int32> Page number of results to show (starting at page 1).
sort	string Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a `-` character.
createdAfter	string <date-time> Return transactions that were created at or after this timestamp in ISO-8601 format Example: createdAfter=2024-09-06T05:56:26.512390332Z
createdBefore	string <date-time> Return transactions that were created at or before this timestamp in ISO-8601 format
amount	integer <int64> Amount of the transaction
customerId	Array of strings Filter by customer identifier
merchantId	Array of strings Filter by merchant identifier
status	string (TransactionStatus) Filter by the status of the transaction Enum: "accepted" "paid" "refunded" "partially_refunded" "pending" "failed" "cancelled" "disputed" "not_captured" "incomplete"

Responses

200

Matching items sorted as specified

400

401

403

404

405

406

409

422

429

500

503

get/transactions

Request samples

Curl
JavaScript

Response samples

application/json

[{"purchaseDetails": {"orderId": "ordr_ZtqZhJAAVEu0G0pj",
"merchantId": "mcht_ZtqZhJAAVEu0G0pf",
"referenceOrderId": "ORD-12411",
"amount": {"minorCurrencyUnits": 0,
"currency": "AUD"
},
"surchargeAmount": 0,
"refundedAmount": 0,
"merchantName": "string",
"transactionId": "tran_ZtqZhJAAVEu0G0pi",
"orderType": "online",
"payType": "PayPlan",
"description": "string",
"orderMetadata": { },
"status": "accepted",
"refundIds": ["rfnd_ZtqZhZAAVEu0G0pw"
],
"disputeId": "dispute_ZtqZhJAAVEu0G0pm",
"disputeIds": ["dispute_ZtqZhJAAVEu0G0pm"
],
"paidOn": "2019-08-24",
"availableOn": "2019-08-24",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"paymentMethod": {"paymentMethodType": "Card",
"cardBrand": "string",
"cardLast4": "string",
"cardFunding": "string",
"cardIssuer": "string",
"cardExpiryDate": "string",
"cardCountry": "string",
"cardCVCVerificationPassed": true,
"card3DSVerificationPassed": true,
"card3DSFlow": "string",
"cardStatement": "string"
},
"serviceFees": {"variableAmount": 0,
"fixedAmount": 0,
"taxAmount": 0,
"totalAmount": 0
},
"customerDetails": {"customerId": "cust_ZtqZhJAAVEu0G0pg",
"referenceCustomerId": "CUST-48822821",
"customerName": "string",
"customerEmailAddress": "lucy.diamond@star.com",
"customerPhoneNumber": "+61401234567"
},
"timelines": [{"eventType": "PaymentSucceed",
"eventTime": "2019-08-24T14:15:22Z",
"amount": 0,
"identifier": "string"
}
]
}
]