Skip to main content
Version: Lastest

Transaction list

Endpoint: /api/v2/partner/orders/transactions

Method: GET

Header: How to generate a JWT_TOKEN

{
"X-APPOTAPAY-AUTH": "JWT_TOKEN",
"X-Request-Id": "Your_Unique_id",
"Content-Type": "application/json"
}

Request params

ParameterRequirementData typesDescription
payment_methodoptionalStringPayment methods (POS, QR)
pagerequiredString
limitrequiredString

Response Params

Success

Http Status Code 200 - OK

ParameterData typesDescriptionNotes
transactionsArray ObjectTransaction information
transaction.transaction_idStringAppotaPay transaction ID
transaction.partner_ref_idStringPartner reference transaction ID
transaction.statusStringTransaction status

pending = The transaction is pending.

processing = The transaction is being processed.

success = The transaction is successful.

error = The transaction has failed.

void = The transaction has been refunded.

transaction.amountIntegerTransaction amount
transaction.error_codeIntegerTransaction error code (Note: returned only if status != success)
transaction.error_messageStringTransaction status details (Note: returned only if status != success)
transaction.payment_methodStringPayment methods
transaction.created_atStringTransaction creation time (ISO 8601 format)
transaction.paid_atStringTransaction payment time (ISO 8601 format)
paginationObject
pagination.limitstringLimit
pagination.pagestringPage
pagination.totalstringTotal
pagination.total_itemsstringTotal Items

Failure

HTTP Status Code != 200

ParameterData typesDescription
error_codeStringError code
error_messageStringError code description

Example

Response

{
"transactions": [
{
"transaction_id": "01KF33A1JNTD6ZE42T42ZVN7P3",
"partner_ref_id": "asdnndaudddssdsddnwduu",
"status": "pending",
"amount": 123456,
"error_code": "34",
"error_message": "Giao dịch đang chờ xử lý",
"payment_method": "POS",
"created_at": "2026-01-16T16:48:42",
"paid_at": ""
}
],
"pagination": {
"limit": 1,
"page": 1,
"total": 10,
"total_items": 10
}
}

Code Example

curl --location 'https://pos-gw.dev.appotapay.com/api/v2/partner/orders/transactionspage=1&limit=25' \
--header 'X-APPOTAPAY-AUTH: JWT_TOKEN' \
--header 'Content-Type: application/json'

Request

REQUEST

Development server