Jump to Content

Home Integration Guides API Reference Changelog

EZYPAY HOW EZYPAY WORKS PARTNERS

API Reference

EZYPAY HOW EZYPAY WORKS PARTNERS

Overview

About Us
Authentication
Sandbox

Create Customer

Customer

Create Payment Method

Payment Methods
Vault Payment Methods
Hosted Payment Page and Checkout

Create Invoice (Ad-Hoc)

Invoices
InvoiceBatches
Transactions
- List transactionsget
- Retrieve a transactionget

Create Invoice (Subscription)

Plans
Subscriptions
Future Invoices

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

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
Partner Subscriptions

Merchant

Contact Email Address
Merchants
Merchant Connections
- List merchant connectionsget
- Retrieve a merchant connectionget
Merchant Contact

Notes

Notes

PayTo

Mandate Types
- List mandate typesget
- Get a mandate typeget

More

Terms and Conditions
Privacy and Security

Overview

About Us
Authentication
Sandbox

Create Customer

Customer

Create Payment Method

Payment Methods
Vault Payment Methods
Hosted Payment Page and Checkout

Create Invoice (Ad-Hoc)

Invoices
InvoiceBatches
Transactions
- List transactionsget
- Retrieve a transactionget

Create Invoice (Subscription)

Plans
Subscriptions
Future Invoices

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

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
Partner Subscriptions

Merchant

Contact Email Address
Merchants
Merchant Connections
- List merchant connectionsget
- Retrieve a merchant connectionget
Merchant Contact

Notes

Notes

PayTo

Mandate Types
- List mandate typesget
- Get a mandate typeget

More

Terms and Conditions
Privacy and Security

File Service

The file service API allows users to check the status of a generating file and provides a link to download generated files once finished generating.