Jump to Content
Home
Integration Guides
API Reference
Changelog
SUPPORT CENTRE
EZYPAY
API Reference
SUPPORT CENTRE
EZYPAY
Home
Integration Guides
API Reference
Changelog
Vault Payment Methods
All
Pages
Start typing to search…
JUMP TO
Overview
About Us
Authentication
Sandbox
Create Customer
Customer
Create a customer
post
List customers
get
Retrieve a customer
get
Update a customer
put
Create Payment Method
Payment Methods
List payment methods
get
Create a payment method
post
Retrieve primary payment method
get
Retrieve a payment method
get
Delete a payment method
del
Hosted Payment Page and Checkout
Get A Hosted Page Token
post
Create A Checkout Session
post
Disable a Checkout Session
del
Mandate Types
List mandate types
get
Get a mandate type
get
Create Invoice (Ad-Hoc)
Invoices
List invoices
get
Create an invoice
post
Retrieve an invoice
get
Update an invoice
put
Record an external payment for an invoice
post
Transactions
List transactions
get
Retrieve a transaction
get
Create Invoice (Subscription)
Plans
List plans
get
Create a plan
post
Retrieve a plan
get
Update a plan
put
Subscriptions
List subscriptions
get
Create a subscription
post
Preview a subscription
post
Retrieve a subscription
get
Activate a subscription
put
Cancel a subscription
put
Update subscription's payment method
put
Undo a subscription cancellation
post
Update subscription
put
Future Invoices
List future invoices
get
Update a future invoice
put
Delete a future invoice
del
Record an external payment for a future invoice
post
Failed Payment Scenario
Invoices
Write off an invoice
post
Retry a payment on an invoice
post
Payment Methods
Replace a payment method
put
Update primary payment method
put
Refunds
Refund
Refund an invoice
put
Credit Notes
List credit notes
get
Retrieve a credit note
get
Webhooks
Events
Resend event
post
Webhooks
List webhooks
get
Create webhook
post
List webhook notification logs
get
Retrieve webhook details
get
Update webhook
put
Delete webhook
del
Settlement
Settlements
List settlements
get
Generate a settlement document
post
Reports
Reports
Generate Outstanding Collections Report
post
Generate Merchant Transactions Report
post
File Service
Get File
get
Partner
Partner Invoices
List partner invoices
get
Create a partner invoice
post
Attempt payment on a partner invoice
post
Partner Subscriptions
List partner subscriptions
get
Create a partner subscription
post
List partner subscription add on usage
get
Record a partner subscription add on usage
post
Cancel a partner subscription
put
Merchant
Merchants
Retrieve a merchant
get
Retrieve collected next settlement amount
get
Retrieve a schedule of customer paid fees for Merchant
get
Merchant Connections
List merchant connections
get
Retrieve a merchant connection
get
TAP TO PAY
Tap To Pay
Register Terminal Device
post
Create A Terminal Invoice
post
List Terminal Invoices
get
Retrieve A Terminal Invoice
get
More
Terms and Conditions
Privacy and Security
Powered by
Vault Payment Methods
Ask AI
