API Detail Transaction

Endpoint: /api/v2/partner/orders/transaction/:partner_ref_id

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

Parameter	Requirement	Data types	Description
partner_ref_id	required	String	Partner reference transaction ID

Response Params

Success

Http Status Code 200 - OK

Parameter	Data types	Description	Notes
transaction_id	String	AppotaPay transaction ID
order_id	String	Order ID
status	String	Transaction 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.
amount	Integer	Payment amount
error_code	Integer	Transaction error code (Note: returned only if status != success)
error_message	String	Transaction status details (Note: returned only if status != success)
payment_method	String	Payment methods
created_at	String	Transaction creation time (ISO 8601 format)
paid_at	String	Transaction payment time (ISO 8601 format)

Failure

HTTP Status Code != 200

Parameter	Data types	Description
error_code	String	Error code
error_message	String	Error code description

Example

Response

{
  "order_id": "586205440621461504",
  "transaction_id": "01K9SPCC1PGFT23E797EWC2K6R",
  "payment_method": "POS",
  "amount": 10000,
  "status": "success",
  "error_code": "00",
  "error_message": "Giao dịch thành công",
  "created_at": "2025-11-11T21:51:08",
  "paid_at": "2025-11-11T21:51:30"
}

Code Example

curl --location 'https://pos-gw.dev.appotapay.com/api/v2/partner/orders/transaction/:partner_ref_id' \
  --header 'X-APPOTAPAY-AUTH: JWT_TOKEN' \
  --header 'X-Request-Id: UUID' \
  --header 'Content-Type: application/json'

Request

REQUEST

Base URL

https://pos-gw.dev.appotapay.com

Development server

Path

Auth REQUIRED

Bearer Token

Parameters

partner_ref_id — path REQUIRED