Ezypay's Help Centre
Settlement Report CSV Guide
What is the settlement report?
The Settlement Report provides a comprehensive summary of payments that were settled to you from Ezypay. Each report contains consolidated data from all successful payment settlements including transactions details such as customer details, document details, payout amounts, and fees.
External payments made outside the Ezypay system (i.e. a customer paying cash over the counter for their subscription) will not appear in the Settlement Report.
Example Settlement Report
What can I do with my settlement report?
The Settlement Report is generated as a Comma-Separated-Value (or .csv) file format, which can be viewed as it is or easily imported into your software accounting system of choice. You can manipulate the Settlement Report to produce your own lists and report variations based on the data provided. Example actions you can perform are:
Filter column headers
You can hide what you don't want to see and select what you do. Filters can be used to narrow down the data in your worksheet and hide parts of it from view. For example, if you want to only view your revenue, under the Type column, filter for Revenue and deselect Deductions.
Software such as Microsoft Excel allow you to easily add filters to the cell column headers. Refer to the official Excel help center for instructions on sorting and filtering columns.
Calculate total sums
You can calculate the total sum of an entire column of numbers, such as the Total Amount column. Software such as Microsoft Excel will show the total sum at the bottom of your table when you highlight a column of numbers.
Search a column
You can search for a specific entry in a column. For example, you can search the Customer Name column for a specific customer to retrieve all transactions related to that customer within the Settlement Report.
What do the columns mean?
Within the report, there will be multiple column headers. You can filter these columns to control what you see.
The table below describes each column and their meaning in the report:
Column | Column Name | Description | |
A | Type | The type of settlement: Revenue Funds paid to your merchant account. Revenue will usually come from your customers. View the Transaction Type and Invoice Item Type columns to find out more about where your revenue is coming from. Deduction Funds deducted from your merchant account. Deductions can come from Ezypay fees, your customer refunds, or payments to partner merchants. View the Customer Name or Merchant Name column to identify who is deducting your funds and the Transaction Type and Invoice Item Type columns to find out what the deduction is for. | |
AA | External Invoice ID | External Invoice ID refers to the Invoices issued by Partners to their Customers | |
AB | Customer Reference Number | Unique identification of the Customers by Merchants | |
B | Description | Additional description of the item. This text follows what was written in the invoice item description. | |
C | Currency | Three letter ISO 4217 currency code for the amount. | |
D | Amount | The item amount exclusive of tax. After discount applied (if applicable). | |
E | Tax Amount | The tax amount applied to the item. Auto-calculated based on tax rate provided in the subscription or on-demand invoice. If you had not specified a tax rate, will follow the default tax rate under your merchant settings. | |
F | Total Amount | The total item amount including tax. | |
G | Customer Number | Only applicable for customer payments. Auto-generated Ezypay’s numeric identifier of the customer. | |
H | Customer Name | Only applicable for customer payments. The customer's first name and last name. | |
I | Merchant Number | Only applicable for partner payments. Auto-generated Ezypay’s numeric identifier of the merchant who is receiving or making payments to you. | |
J | Merchant Name | Only applicable for partner payments. The trading name of the merchant who is receiving or making payments to you. | |
K | Merchant Legal Name | Only applicable for partner payments. The legally registered name of the merchant who is receiving or making payments to you. | |
L | Revenue Share Source Number | Only applicable for partner payments. Auto-generated Ezypay’s numeric identifier of the merchant who is source of the revenue share. | |
M | Revenue Share Source Name | Only applicable for partner payments. The legally registered name of the merchant who is source of the revenue share. This is the original merchant whose revenue Ezypay has collected from which is now distributed to you or deducted from you to pay another merchant. | |
N | Transaction Number | Only applicable for customer payments. The transaction number associated with the payment or refund. | |
O | Transaction Date | Only applicable for customer payments. The date the transaction was processed. | |
P | Document Date | The issue date of a document. Note: A "document" refers to an invoice, credit note, partner transfer invoice or adjustment note. | |
Q | Document Number | Auto-generated numeric identifier of the document. Note: A "document" refers to an invoice, credit note, partner transfer invoice or adjustment note. | |
R | Associated Document Number | A reference to the document number used to indicate the original transaction. For example, a credit note's associated number will be the original invoice document number. | |
S | Accounting Code | The accounting code associated to revenue collected from this payment. This text follows what was written in the invoice. | |
T | Payment Method Type | Only applicable for customer payments. The payment method type of the transaction, e.g. Visa, Mastercard, Bank. | |
U | Transaction Type | Specifies what kind of transaction occurred. The transaction types are: Payment / Failed Payment Ezypay collected payments from customers. Unsuccessful collection will be returned as Failed Payment. Refund / Failed Refund Payment refund from merchant to customer. Chargeback / Reverse Chargeback Ezypay deducted funds from the merchant for chargeback. Fee Refund / Fee Discount Ezypay refunded or waived an Ezypay fee. Partner Payment / Failed Partner Payment Fund transfers between merchants. Partner Revenue Share / Failed Partner Revenue Share Fund distributions between merchants. Fee Revenue Share Ezypay fees sharing with merchants. Adjustment Ezypay made an adjustment to the merchant settlement funds. Settlement Funds were settled to your merchant account. | |
V | Invoice Item Type | Provides details on what the payment was for. Customer related payments:
Ezypay fees:
Payments between partner merchants:
Fund adjustments made by Ezypay:
| |
W | Country | The country of the merchant of the settlement report. Follows two letter ISO 3166-1 alpha-2 country code format. | |
X | Partner Payment Source | Only applicable for partner payments. The source merchant from which the payment was originally taken from. | |
Y | Channel | Specifies channel used by the transaction to reach Ezypay. The possible channels are:
online_payment_recovery The payment is collected via a Pay Now link.
online_checkout The payment is collected via a checkout page.
api All others, except those listed above. | |
Z | Document ID | Auto-generated unique ID of the document in Universally Unique Identifier (UUID) format. Used in APIs and webhooks to identify a specific document. Note: A "document" refers to an invoice, credit note, partner transfer invoice or adjustment note. |
Revenue reconciliation
To obtain... | Steps |
Total settlement amount How much Ezypay should remit to you | Sum up the total in Total Amount column. |
Total revenue A sum of all incoming payments into your account; includes deductions that failed and therefore were not made, hence credited back into your account. |
Tip: Refer to the Invoice Item Type column to find out which revenue stream the money was from. |
Total deduction A sum of all outgoing payments from your account; includes payments that Ezypay failed to collect on your behalf. |
Tip: Refer to the Invoice Item Type column to find out what the deduction was for. |
Customer reconciliation
To obtain... | Steps |
Total collection from customers | (Sum total of Part A) minus (Sum total of Part B) Part A: Total attempted collection
Part B: Total failed payments
|
Total revenue from subscriptions only |
The calculation will include transaction types of Payment, Failed Payment, Refund, Failed Refund, Chargeback and Reverse Chargeback. |
Total revenue from on-demand invoice payments only |
The calculation will include transaction types of Payment, Failed Payment, Refund, Failed Refund, Chargeback and Reverse Chargeback. |
Total revenue from a specific customer |
|
Total deductions for customer refunds |
|
Deduction for Ezypay fees
To obtain... | Steps |
Total deduction of Ezypay fees | (Sum total of Part A) minus (Sum total of Part B) Part A: Ezypay fees deducted
Part B: Ezypay fees refunded or waived
|
Who is the fee charged for? | Refer to the Customer Name column. If the name is not populated, then refer to the Document Number or Associated Document Number column to obtain the reference number. Use the reference number to search for the corresponding Invoice or Credit Note in your integrated system/platform. You should then be able to view the customer details. |
Partner merchant reconciliation
To obtain... | Steps |
Total revenue/deduction from partner merchants |
|
What is the partner payment charged for? | Refer to the Description and Merchant Name columns. |
Adjustments
Adjustments are made by Ezypay to adjust funds for various reasons.
In Transaction Type column, filter for Adjustment.
Refer to the Description column for more details relating to the adjustment.
FAQ
Why are my merchant columns empty?
Merchant columns are only used for transactions involving partner merchants. If you do not have any active partner plans, your merchant columns will be empty.
I was charged an Ezypay fee (e.g. Transaction Fee), but the customer column is empty. How do I reconcile this fee with my customer payment?
All related transactions will have the same Associated Number (which in this scenario, would be the customer's original invoice Document No). You can use this Associated Number to find the transaction that the fee was charged for.
- 1.First, copy the Associated Number of the fee you want to check. For example 7875.
- 2.Sort your list by the Associated Number.
- 3.Search for the Associated Number 7875. The related customer transaction will have the same Associated Number as shown below:
I was charged an Ezypay fee (e.g. Transaction Fee), but cannot find the transaction associated to this fee?
If you find fee charges that have no related transactions (i.e. you cannot find a transaction with the same Associated Number as the fee), it is likely your revenue has not been released. Ezypay charges fees as and when a transaction occurs. Your revenue however, is subjected to a Transaction Holding Period and will be released later. You should be able to reconcile that fee with the corresponding transaction in the next settlement report.
Ezypay fees
Ezypay charges fees when you or your customers use Ezypay services.
Note: If you want to charge your customer your own fees, such as setup or joining fees, please use the plan's setup payment or add-on payment option instead. The term "fees" strictly refers to Ezypay fees.
The following are the fees that Ezypay charges.
Ezypay Fee | Payable By | Fee is charged when... |
Transaction Fee | Merchant or Customer | When a customer transaction is processed through a payment processor. |
Load Fee | Merchant or Customer | When a transaction is processed on the first invoice for the new customer. |
Failed Payment Fee | Merchant or Customer | When a transaction failed. |
Refund Fee | Merchant Only | When a refund transaction is processed. |
Who pays the Ezypay Fees
Ezypay fees (with exception of the refund fee) can be configured to be paid by the merchant or customer. However, these customer paid fees can be automatically transferred to the merchant if:
- a paid invoice is refunded.
- payment for past due invoice has been collected externally.
- a past due invoice is written off.
Note: Not all these conditions may apply. Contact Ezypay Support for more details on your merchant fee pricing rules.