For AI agents: visit https://developer.ezypay.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Ezypay
HomeIntegration GuidesAPI ReferenceChangelog
SUPPORT CENTREEZYPAYEzypay
API Reference
SUPPORT CENTREEZYPAY
HomeIntegration GuidesAPI ReferenceChangelog

Overview

  • About Us
  • Authentication
  • Sandbox

Create Customer

  • Customer
    • Create a customerpost
    • List customersget
    • Retrieve a customerget
    • Update a customerput

Create Payment Method

  • Payment Methods
    • List payment methodsget
    • Create a payment methodpost
    • Retrieve primary payment methodget
    • Retrieve a payment methodget
    • Delete a payment methoddel
  • Vault Payment Methods
    • Create A Bank Payment Method Tokenpost
    • Create A QR Payment Method Tokenpost
  • Hosted Payment Page and Checkout
    • Get A Hosted Page Tokenpost
    • Create A Checkout Sessionpost
    • Disable a Checkout Sessiondel
  • Payment capture page Styling
  • Mandate Types
    • List mandate typesget
    • Get a mandate typeget

Create Invoice (Ad-Hoc)

  • Invoices
    • List invoicesget
    • Create an invoicepost
    • Retrieve an invoiceget
    • Update an invoiceput
    • Record an external payment for an invoicepost
    • Cancel a QR Payment requestput
  • Transactions
    • List transactionsget
    • Retrieve a transactionget

Create Invoice (Subscription)

  • Plans
    • List plansget
    • Create a planpost
    • Retrieve a planget
    • Update a planput
  • Subscriptions
    • List subscriptionsget
    • Create a subscriptionpost
    • Preview a subscriptionpost
    • Retrieve a subscriptionget
    • Activate a subscriptionput
    • Cancel a subscriptionput
    • Update subscription's payment methodput
    • Undo a subscription cancellationpost
    • Update subscriptionput
  • Future Invoices
    • List future invoicesget
    • Update a future invoiceput
    • Delete a future invoicedel
    • Record an external payment for a future invoicepost

Failed Payment Scenario

  • Invoices
    • Write off an invoicepost
    • Retry a payment on an invoicepost
  • Payment Methods
    • Replace a payment methodput
    • Update primary payment methodput

Refunds

  • Refund
    • Refund an invoiceput
  • Credit Notes
    • List credit notesget
    • Retrieve a credit noteget

Webhooks

  • Events
    • Resend eventpost
  • Webhooks
    • List webhooksget
    • Create webhookpost
    • List webhook notification logsget
    • Retrieve webhook detailsget
    • Update webhookput
    • Delete webhookdel

Settlement

  • Settlements
    • List settlementsget
    • Generate a settlement documentpost

Reports

  • Reports
    • Generate Outstanding Collections Reportpost
    • Generate Merchant Transactions Reportpost
  • File Service
    • Get Fileget

Partner

  • Partner Invoices
    • List partner invoicesget
    • Create a partner invoicepost
    • Attempt payment on a partner invoicepost
  • Partner Subscriptions
    • List partner subscriptionsget
    • Create a partner subscriptionpost
    • List partner subscription add on usageget
    • Record a partner subscription add on usagepost
    • Cancel a partner subscriptionput

Merchant

  • Merchants
    • Retrieve a merchantget
    • Retrieve collected next settlement amountget
    • Retrieve a schedule of customer paid fees for Merchantget
  • Merchant Connections
    • List merchant connectionsget
    • Retrieve a merchant connectionget

TAP TO PAY

  • Tap To Pay
    • Register Terminal Devicepost
    • Create A Terminal Invoicepost
    • List Terminal Invoicesget
    • Retrieve A Terminal Invoiceget

More

  • Terms and Conditions
  • Privacy and Security
Powered by 
  1. Create Payment Method

Payment capture page Styling

Updated 1 day ago


Disable a Checkout Session
Mandate Types
Did this page help you?

Updated 1 day ago


Disable a Checkout Session
Mandate Types
Did this page help you?