Get Transactions Reconciliation Report

GET

https://api.payos.money/api/v1/reports/reconciliation/:id

GET

/api/v1/reports/reconciliation/:id

1 curl https://api.payos.money/api/v1/reports/reconciliation/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       "TransactionId"
20     ],
21     "reconciliationStatuses": [
22       "Full"
23     ]
24   },
25   "rows": [
26     {
27       "transactionId": "string",
28       "merchantReference": "string",
29       "processorReference": "string",
30       "processorClientReference": "string",
31       "transactionAttemptId": "string",
32       "transactionAmountMinor": 1.1,
33       "transactionCurrency": "AED",
34       "settlementAmountSumMinor": 1.1,
35       "reconciliationState": "Full",
36       "warnings": {},
37       "createdAt": "2024-01-15T09:30:00Z",
38       "updatedAt": "2024-01-15T09:30:00Z",
39       "payerId": "string",
40       "paymentAttributes": {},
41       "paymentLocation": "string",
42       "paymentMethodId": "string",
43       "processorName": "string",
44       "sessionId": "string",
45       "transactionStatus": "string",
46       "transactionType": "string"
47     }
48   ]
49 }

Retrieve a specific reconciliation report

Path parameters

idstringRequired

Response

Transactions reconciliation report retrieved successfully

summaryobject

parametersobject

Parameters for configuring the reconciliation report

rowslist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error