Retrieve Ezypay Customer Paid Fees

This page explains how integrators would be able to use Ezypay's API to identity all fees that will be customer paid.

๐Ÿ“˜

NOTE

Ezypay fees can either be charged to the customer or absorbed by the merchant depending on what the merchants decide. This will be configured during Ezypay's merchant on-boarding process.

A detailed explanation on what type of Ezypay fees are available can is explained in this link

All fees displayed from the response of this API will only include customer paid fees. Merchant paid fees will not be available using this API.

1. Call Ezypay's Fees Pricing API

[GET] https://api-global.ezypay.com/v2/billing/merchant/pricing/fees

The fees displayed will be dependent on the merchant ID that is provided.

Parameter TypeDescription
pricingcodeMade up of one of the 3 fee types:
1) transaction_fee (Either Bank or Credit Card transaction fees).

2) load_fee (This is a once off charge for first time transactions from a new customer).

3) failed_payment_fee (A penalty that incur for a payment that failed).
descriptionDetails on the type of fees created.
appliesToWhat payment type that these fees will be applied too. The payment types are:

1) BANK - This fee option only applies to Bank transactions.

2) MASTERCARD - This fee option only applies to Mastercard transactions.

3) VISA - This fee option only applies to VISA transactions.

4) AMEX - This fee option only applies to VISA transactions.

NOTE:
If the applies parameter is "[]", this will mean that it is applicable to all.
accountingCodeAccounting Code can be use as a method to identity a unique payment option. For example there might be 2 fees option for a VISA card with different pricing.

If the Invoice was created with an accounting code that is tied to a pricing option, that pricing option will be used instead of the default.
chargingOptionThis parameter accepts 3 options:
1) Amount - A fixed amount is added on the invoice amount.

2) Percentage - A percentage is added on the invoice amount.

3) Both - A percentage and a fixed amount is added on the invoice amount.
amount & percentageDepending on the "chargingOption" the values will be added to the respective parameter.

Below is a sample body on how the response from the Fee Pricing API looks like:

{
    "data": [
        {
            "pricingCode": "failed_payment_fee",
            "description": "Failed Payment Fee",
            "appliesTo": [],
            "accountingCode": null,
            "chargingOption": "AMOUNT",
            "amount": 12.00,
            "percentage": null
        },
        {
            "pricingCode": "transaction_fee",
            "description": "Transaction Fee",
            "appliesTo": [
                "VISA"
            ],
            "accountingCode": null,
            "chargingOption": "PERCENTAGE",
            "amount": null,
            "percentage": 1.49
        },
        {
            "pricingCode": "transaction_fee",
            "description": "Transaction Fee",
            "appliesTo": [
                "MASTERCARD"
            ],
            "accountingCode": null,
            "chargingOption": "PERCENTAGE",
            "amount": null,
            "percentage": 1.49
        },
        {
            "pricingCode": "transaction_fee",
            "description": "Transaction Fee",
            "appliesTo": [
                "BANK"
            ],
            "accountingCode": null,
            "chargingOption": "AMOUNT",
            "amount": 0.17,
            "percentage": null
        },
        {
            "pricingCode": "load_fee",
            "description": "Load Fee",
            "appliesTo": [],
            "accountingCode": null,
            "chargingOption": "AMOUNT",
            "amount": 2.20,
            "percentage": null
        }
    ],
    "paging": {
        "nextUrl": null,
        "nextCursor": 0,
        "limit": 5,
        "totalCount": 5
    }
}