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.
NOTEEzypay 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 Type | Description |
|---|---|
pricingcode | Made up of one of the 3 fee types:
|
description | Details on the type of fees created. |
appliesTo | What payment type that these fees will be applied too. The payment types are:
|
accountingCode | Accounting 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. |
chargingOption | This parameter accepts 3 options:
|
amount & percentage | Depending 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
}
}Updated 10 days ago