Ezypay provides the following reports for merchants and integrators via APIs:

Settlement Reports

Settlement Summary Report (PDF)
Settlement Detailed Report (CSV)
Settlement Tax Invoice (PDF)

📘
Note
Settlement reports will also be emailed to the merchant during settlement.

Other Reports:

Outstanding Collection Report – Displays unpaid customer payments.
Merchant Transaction Report (CSV) – Lists all transactions within a specified period (up to 90 days).

Get started

Retrieve Settlement Reports

There are 3 API calls for Ezypay to generate the settlement reports as detailed below:

Use the List settlements API to get the settlements overview. Filter by date usingfrom and until in query parameters.
Retrieve the data.number field for settlements that require the reports.

{
    "data": [
        {
            "number": "124606",
            "date": "2024-07-24",
            "revenue": {
                "currency": "AUD",
                "value": 212353.37,
                "type": null
            },
            "deduction": {
                "currency": "AUD",
                "value": 49796.81,
                "type": null
            },
            "amount": {
                "currency": "AUD",
                "value": 162556.56,
                "type": null
            },
            "settlementPayoutMethod": {
                "id": null,
                "paymentMethodToken": "f427a3d0-7514-4a94-b29c-6d207b9d3e71",
                "bank": {
                    "accountHolderName": "Test Sandbox Acc",
                    "last4": "7270",
                    "bankNumber": "084447",
                    "branchNumber": "",
                    "suffixNumber": null
                }
            },
            "status": "success",
            "failedSettlementReason": null,
            "createdOn": "2024-07-19T03:15:58.097"
        }
    ],
    "paging": {
        "nextUrl": null,
        "nextCursor": 0,
        "limit": 0,
        "totalCount": 1
    }
}

Use the Generate Settlement Document API to generate the report in Ezypay's server. Provide settlementNumber (from step 2) in the URL path and documentType in request body.
Retrieve the fileId from the response body.

{ "documentType": "detail_report" }

{
    "fileId": "ef27f890-959e-458f-9b6f-4b58c39b3f09",
    "createdOn": "2024-09-25T05:30:11.521",
    "documentType": "detail_report"
}

Use the Get File API to download the generated file. Use fileId from step 4 in the URL path.
Retrieve the url from the response body to download the file.

{
    "id": "ef27f890-959e-458f-9b6f-4b58c39b3f09",
    "url": "https://ezypay-file-sandbox.s3-ap-southeast-2.amazonaws.com/%2Fef27f890-959e-458f-9b6f-4b58c39b3f09/invoice-INAU0000000000064465.pdf?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDmFwLXNvdXRoZWFzdC0yIkcwRQIgfFtF%2Fa%2BpAyI3e6spf1UrABwqXcPq7saBwJPbqYiTS0ICIQD4JwAhSYDX%2FJhgvzaF6OvHWgJ65Eb%2BR%2FevDhlMuT8R%2Byr6Awg7EAUaDDE5OTI0MTMyNDQ5MiIMz1jmXmBha13TC27HKtcD1CjyYxEWDqX9l00bm9YBuldCTtj3XQv%2B8i7jhIBSOaF8cmm9x3VCfbSrsjo3sPeuIUM33hkmPUpc74nZ6g7vrpNUoEfTb0h5RrOQ4Usb6tjnYYFwVvE38IcXN3OQqnQBov4hujAZtyuNitJM1OZSG6IcZbwLphS4asoWvvpwbbwcwQ68Rqzg5P7S87yGSnC3v%2FctEzuL9duz%2B8wddKDX0iLYLGX9KXisY7gwsz%2BSZut5xLfvTmu10dplrU1pquKNW7jTfKaTQUkstwWOQhML%2BBFXDhZ7LOz%2FGUHJA9BGU6AAUM7Kh%2FhCWxSvY9P87klot%2B8aF8WZa5LwdoX9UMCv9FTkPkEjr3eaYhkRi8RORMeaamQGc1cTD5pbRy3Lnb%2BJ0z4hYLvyu6pRpo4l5YyffGHpffU%2FRkNsfR080j4IFAZSxL9tELTs6lmqRZ2VlTQ6H3oYYz9fj9qpfVpgR1yV1mGn7JfGuZTpYhVD9e5NDUf8vKi6lviTdBebTIK2%2F4IKaQEsvdMfk07rHkDEcdxfoukcYDrKFz%2FDAl2Rl8iW0JJsBtGMlpgMdXq3oITHUy5FwS1c6h2s1ETjzKHHNHuLofK3B91kAknJ2s3Oa9vGkS8pxmMX3tIFMO74mboGOqUBQlDLWfaRTNubPUv60SOoykfwsDHw5GMDE0P%2FfME3tfDQRrLxCK7lB4i%2BAyv2wdZRdTZTQJd%2FhRNaaC%2BojbG6A9YFiRXhwChKWSo%2FFk5XTSb1ArJ3mi%2FskD5529NBcXHNjZzaaFsksmuz9ydQ%2FKiomfrldZoHRZWMFe8xB6GS69hREzYww%2FdAjeon%2FOB0RnZxXILOgA4sgWw3DkqZtpWGP%2BoId3%2Bg&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241127T021001Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1439&X-Amz-Credential=ASIAS4Y5VK7GIKOS3X3R%2F20241127%2Fap-southeast-2%2Fs3%2Faws4_request&X-Amz-Signature=3ce7de2b962f5c06ca2867181c4d6baff7bf1a289ea5c0ac1412427a3444e891",
    "type": "application/pdf",
    "status": "active",
    "name": "invoice-INAU0000000000064465.pdf",
    "purpose": "detail_report",
    "createdBy": "file-user@ezypay.com",
    "createdOn": "2024-09-25T05:30:11.49",
    "bucket": null
}

Retrieve Outstanding Collection Report

Use the Generate Outstanding Collection Reports API to generate the report. Provides reportFilters and sortField in the request body.
The file is returned in the response.

{
	"reportFilters" : ["NOT_YET_DUE", "FAILED_WITHOUT_FURTHER_RETRY"],
	"sortField" : "CUSTOMER_NAME"
}

Retrieve Merchant Transaction Report

Use the Generate Merchant Transaction Report API to generate the report. Filter by date providingfrom and to in request body.
The CSV file is returned in the response.

{
  "from": "2024-06-06",
  "to": "2024-09-03"
}

Transaction Date,Transaction Type,Currency,Amount,Customer Number,Customer Name,Merchant Number,Merchant Name,Transaction Source,Payment Method Type,Transaction Number,Document Number,Document Date,Item Type,Description,Accounting Code,Channel
2024-09-02,Payment,AUD,422.00,EZY223424,Yih Loong Chan,16654,Yih Loong Cafe NSW Business,Payment Processor,Visa,2899135,IN0000000000002845,2024-09-02,Setup Payment,random testing plan,B_2253,api
2024-09-02,Payment,AUD,95.48,EZY223424,Yih Loong Chan,16654,Yih Loong Cafe NSW Business,Payment Processor,Visa,2899135,IN0000000000002845,2024-09-02,Subscription Payment,random testing plan,,api
2024-09-02,Payment,AUD,121.33,EZY224713,Yih Loong Testing01,16654,Yih Loong Cafe NSW Business,Payment Processor,Visa,2899101,IN0000000000002842,2024-09-02,Subscription Payment,random testing plan,,api
2024-09-01,Payment,AUD,133.33,EZY223424,Yih Loong Chan,16654,Yih Loong Cafe NSW Business,Payment Processor,Visa,2895401,IN0000000000002806,2024-09-01,Subscription Payment,fitness subscription,B_2253,api
2024-09-01,Payment,AUD,133.33,EZY223424,Yih Loong Chan,16654,Yih Loong Cafe NSW Business,Payment Processor,Visa,2895400,IN0000000000002807,2024-09-01,Subscription Payment,fitness subscription,B_2253,api
2024-08-31,Failed Payment,AUD,-128.50,EZY223424,Yih Loong Chan,,,Payment Processor,Payto,2890834,IN0000000000002775,2024-08-31,Subscription Payment,random testing plan,,api
2024-08-31,Payment,AUD,-8.50,,,,Ezypay,Wallet,,,INAU0000000000063325,2024-08-31,Failed Payment Fee,Failed Payment Fee,,api
2024-08-31,Failed Payment,AUD,-128.50,EZY223424,Yih Loong Chan,,,Payment Processor,Payto,2890835,IN0000000000002774,2024-08-31,Subscription Payment,random testing plan,,api
2024-08-31,Payment,AUD,128.50,EZY223424,Yih Loong Chan,16654,Yih Loong Cafe NSW Business,Payment Processor,Payto,2890834,IN0000000000002775,2024-08-31,Subscription Payment,random testing plan,,api
2024-08-31,Payment,AUD,422.00,EZY223424,Yih Loong Chan,16654,Yih Loong Cafe NSW Business,Payment Processor,Visa,2890832,IN0000000000002773,2024-08-31,Setup Payment,random testing plan,B_2253,api
2024-08-31,Payment,AUD,120.11,EZY223424,Yih Loong Chan,16654,Yih Loong Cafe NSW Business,Payment Processor,Visa,2890832,IN0000000000002773,2024-08-31,Subscription Payment,random testing plan,,api
...

📘Note

Get started

Retrieve Settlement Reports

Retrieve Outstanding Collection Report

Retrieve Merchant Transaction Report

📘
Note