Get transaction list

Get transaction list

Chat with AI▼

API get transaction list

EndPoint

GET /api/v2/orders/transactions

Header Params

Params	Requirement	Data type	Description
X-APPOTAPAY-AUTH	required	String	How to generate JWT_TOKEN
Content-Type	required	String	Value: application/json

{
    "X-APPOTAPAY-AUTH": "Bearer JWT_TOKEN",
    "Content-Type": "application/json"
}

Request Params

Params	Requirement	Data type	Description
startTime	optional	Integer	Start time (required if have end time)
endTime	optional	Integer	End time (required if have start time)
status	optional	String	Status of transaction want filter
paymentMethod	optional	String	Payment method of transaction want filter
limit	optional	Integer	Min is 1, max is 50 (default is 15)
page	optional	Integer	Min is 1 (default is 1)

Response Params

Params	Requirement	Data type	Description
pagination	required	Object	Pagination info
pagination.total	required	Integer	Total record
pagination.page	required	Integer	Current page
pagination.limit	required	Integer	Limit page
transactions	required	Array	List transactions

Success

Http Status Code 200 - OK

Example Response

{
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 15
  },
  "transactions": [
    {
      "errorCode": 0,
      "status": "success",
      "amount": 1000000,
      "currency": "VND",
      "orderId": "9MOmaZigD",
      "bankCode": "MASTERCARD",
      "paymentMethod": "CC",
      "paymentType": "WEB",
      "appotapayTransId": "AP241447565422",
      "transactionTs": 1715848036,
      "extraData": "CPM"
    }
  ]
}

Error

HTTP Status Code != 200 With the returned errorCode, please refer to the error code table here

Code Examples

curl --location 'https://gateway.dev.appotapay.com/api/v2/orders/transactions?startTime=1715848036&endTime=1715848036&limit=15&page=1' \
  --header 'X-APPOTAPAY-AUTH: JWT_TOKEN' \
  --header 'Content-Type: application/json'

Request

REQUEST

Base URL

https://gateway.dev.appotapay.com

Development server

Path

Auth REQUIRED

Bearer Token

Parameters