For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log in to the PayOS Dashboard
GuidesAPI ReferenceHelp Center
GuidesAPI ReferenceHelp Center
  • Authentication API
    • POSTRequest an Access Token
  • Payments API
  • Payment Rules API
  • Payouts API
  • Payers API [BETA]
  • Reporting API
      • POSTCreate Transactions Report
      • POSTCreate Transactions Reconciliation Report
      • POSTCreate Unmatched Settlements Report
      • GETList Reports
      • GETGet Transactions Report
      • GETGet Transactions Reconciliation Report
      • GETGet Unmatched Settlements Report
      • GETGet Generic Report
      • POSTImport Generic Report
  • Verification API
Log in to the PayOS Dashboard
LogoLogo
Reporting APIReport

Get Transactions Report

GET
https://api.payos.money/api/v1/reports/transactions/:id
GET
/api/v1/reports/transactions/:id
$curl https://api.payos.money/api/v1/reports/transactions/id
1{
2  "summary": {
3    "id": "string",
4    "reportType": "TransactionsReport",
5    "merchantId": "string",
6    "requesterUsername": "string",
7    "createdAt": "2024-01-15T09:30:00Z",
8    "status": "Initiated",
9    "name": "string",
10    "generatedAt": "2024-01-15T09:30:00Z",
11    "merchantName": "string"
12  },
13  "parameters": {
14    "dateRange": {
15      "startDate": "2024-01-15T09:30:00Z",
16      "endDate": "2024-01-15T09:30:00Z"
17    },
18    "columns": [
19      "Amount"
20    ],
21    "statuses": [
22      "string"
23    ],
24    "paymentProcessorIds": [
25      "string"
26    ],
27    "paymentMethodIds": [
28      "string"
29    ]
30  },
31  "rows": [
32    {
33      "amount": 1.1,
34      "cardBin": "string",
35      "cardHolderName": "string",
36      "cardPayerEmail": "string",
37      "completedAt": "2024-01-15T09:30:00Z",
38      "currency": "string",
39      "merchantReference": "string",
40      "payerId": "string",
41      "paymentAttributes": {},
42      "paymentLocation": "string",
43      "paymentMethodId": "string",
44      "processorName": "string",
45      "processorReference": "string",
46      "receivedAt": "2024-01-15T09:30:00Z",
47      "sessionId": "string",
48      "status": "string",
49      "transactionAttemptId": "string",
50      "transactionId": "string",
51      "transactionType": "string",
52      "updatedAt": "2024-01-15T09:30:00Z"
53    }
54  ],
55  "aggregateData": {
56    "paymentAttributeKeys": [
57      "string"
58    ]
59  }
60}
Retrieve a specific transactions report
Was this page helpful?
Previous

Get Transactions Reconciliation Report

Next
Built with

Path parameters

idstringRequired

Response

Transactions report retrieved successfully
summaryobject
parametersobject
Parameters for configuring the transactions report
rowslist of objects
aggregateDataobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error