Integration Guides
EZYPAYHOW EZYPAY WORKSPARTNERS

Display Customer Paid Fees

Suggest Edits

Ezypay is committed to helping businesses provide customers with clear visibility of any extra fees they may incur. By leveraging Ezypay's Customer Paid Fees API, integrators can retrieve fee information and include it seamlessly within their platform.

Understanding Ezypay fees API response

The Customer Paid Fees API provides detailed information about fees that apply to customers. Below is a breakdown of the API response parameters:

ParametersDescription
pricingCodeThe fee type. Applicable value failed_payment_fee, transaction_fee, load_fee
descriptionVerbal description of the fee
appliesToSpecifies applicable payment methods (e.g., VISA, MASTERCARD, BANK) in an array. If null, the fee applies to all payment methods.
accountingCodeIndicates the accounting code for the fee. If null, it applies to all transactions.
chargingOptionHow the fee is charged:
a) AMOUNT - Fixed amount
b) PERCENTAGE - Percentage of the transaction
c) BOTH - Fixed amount plus percentage of the transaction
amountThe fixed fee amount.
percentageThe percentage charged based on the transaction amount.

Example API response

{
  "data": [
    {
      "pricingCode": "failed_payment_fee",
      "description": "Failed Payment Fee",
      "appliesTo": [],
      "accountingCode": null,
      "chargingOption": "AMOUNT",
      "amount": 8.5,
      "percentage": 0
    },
    {
      "pricingCode": "transaction_fee",
      "description": "Card Fee",
      "appliesTo": [
        "MASTERCARD",
        "VISA"
      ],
      "accountingCode": null,
      "chargingOption": "BOTH",
      "amount": 0.5,
      "percentage": 0.37
    },
    {
      "pricingCode": "transaction_fee",
      "description": "Bank Fee",
      "appliesTo": [
        "BANK"
      ],
      "accountingCode": null,
      "chargingOption": "BOTH",
      "amount": 0.35,
      "percentage": 0.15
    },
    {
      "pricingCode": "load_fee",
      "description": "Load Fee",
      "appliesTo": [],
      "accountingCode": null,
      "chargingOption": "AMOUNT",
      "amount": 2,
      "percentage": 0
    }
  ],
  "paging": {
    "nextUrl": null,
    "nextCursor": 0,
    "limit": 4,
    "totalCount": 4
  }
}

Using the above response, the fees can be summarised as:

  1. Failed Payment Fee: $8.50 (applies to all payment methods).
  2. Card Fee (Visa/Mastercard): $0.50 + 0.37% of the transaction amount.
  3. Bank Fee (Direct Debit): $0.35 + 0.15% of the transaction amount.
  4. Load Fee: $2.00 (applies to all payment methods).

🚧

Important

The API only returns customer-paid fees. These fees must be displayed to customers as additional charges.

Examples of displaying fees

Updated about 1 month ago