/
EZ
ezypay
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
get
/billing/customers
List customers
post
/billing/customers
Create a customer
get
/billing/customers/{customerId}
Retrieve a customer
put
/billing/customers/{customerId}
Update a customer
get
/billing/customers/{customerId}/paymentmethods
List payment methods
post
/billing/customers/{customerId}/paymentmethods
Create a payment method
get
/billing/customers/{customerId}/paymentmethods/primary
Retrieve primary payment method
get
/billing/customers/{customerId}/paymentmethods/{paymentMethodToken}
Retrieve a payment method
delete
/billing/customers/{customerId}/paymentmethods/{paymentMethodToken}
Delete a payment method
post
/billing/checkout
Create A Checkout Session
delete
/billing/checkout/{checkoutId}
Disable a Checkout Session
get
/billing/invoices
List invoices
post
/billing/invoices
Create an invoice
get
/billing/invoices/{invoiceId}
Retrieve an invoice
put
/billing/invoices/{invoiceId}
Update an invoice
post
/billing/invoices/{invoiceId}/recordpayment
Record an external payment for an invoice
get
/billing/invoices/batches
List invoice batches
post
/billing/invoices/batches
Create an invoice batch
get
/billing/invoices/batches/{invoiceBatchId}
Retrieve an invoice batch
get
/billing/transactions
List transactions
get
/billing/transactions/{transactionId}
Retrieve a transaction
get
/billing/plans
List plans
post
/billing/plans
Create a plan
get
/billing/plans/{planId}
Retrieve a plan
put
/billing/plans/{planId}
Update a plan
get
/billing/subscriptions
List subscriptions
post
/billing/subscriptions
Create a subscription
post
/billing/subscriptions/preview
Preview a subscription
get
/billing/subscriptions/{subscriptionId}
Retrieve a subscription
put
/billing/subscriptions/{subscriptionId}
Update subscription
put
/billing/subscriptions/{subscriptionId}/activate
Activate a subscription
put
/billing/subscriptions/{subscriptionId}/cancel
Cancel a subscription
put
/billing/subscriptions/{subscriptionId}/paymentmethod/{paymentMethodToken}
Update subscription's payment method
post
/billing/subscriptions/{subscriptionId}/undo-cancel
Undo a subscription cancellation
get
/billing/futureinvoices
List future invoices
put
/billing/futureinvoices
Update a future invoice
delete
/billing/futureinvoices
Delete a future invoice
post
/billing/futureinvoices/recordpayment
Record an external payment for a future invoice
post
/billing/invoices/{invoiceId}/writeoff
Write off an invoice
post
/billing/invoices/{invoiceId}/retrypayment
Retry a payment on an invoice
put
/billing/customers/{customerId}/paymentmethods/{paymentMethodToken}/new
Replace a payment method
put
/billing/customers/{customerId}/paymentmethods/{paymentMethodToken}/primary
Update primary payment method
put
/billing/invoices/{invoiceId}/refund
Refund an invoice
get
/billing/creditnotes
List credit notes
get
/billing/creditnotes/{creditNoteId}
Retrieve a credit note
get
/billing/settlements
List settlements
post
/billing/settlements/groupedbyaccountingcode/file
Generate group settlement report by accounting code
post
/billing/settlements/groupedbytransactionstatus/file
Generate group settlement report by transaction status
post
/billing/settlements/{settlementNumber}/file
Generate a settlement document
post
/billing/reports/outstandingcollectionsreport/generate
Generate Outstanding Collections Report
post
/billing/reports/merchanttransactions
Generate Merchant Transactions Report
get
/files/{fileId}
Get File
get
/partnerinvoices
List partner invoices
post
/partnerinvoices
Create a partner invoice
post
/retrypartnerinvoices/{partnerInvoiceId}
Attempt payment on a partner invoice
get
/partnersubscriptions
List partner subscriptions
post
/partnersubscriptions
Create a partner subscription
get
/partnersubscriptions/{partnerSubscriptionId}/addons/{partnerSubscriptionAddOnCode}
List partner subscription add on usage
post
/partnersubscriptions/{partnerSubscriptionId}/addons/{partnerSubscriptionAddOnCode}/recordusage
Record a partner subscription add on usage
put
/partnersubscriptions/{partnerSubscriptionId}/cancel
Cancel a partner subscription
post
/email
Add email address for merchant contact
get
/email/{merchantContactId}
Get email addresses by merchant contact id
put
/email/{emailAddressId}
Update an existing email address
get
/billing/merchant
Retrieve a merchant
put
/billing/merchant/failedpaymenthandling
Update a merchant's failed payment handling
get
/billing/merchant/nextSettlement/{merchantId}
Retrieve collected next settlement amount
put
/billing/merchant/notificationsettings
Update a merchant's notification settings
get
/billing/merchant/pricing/fees
Retrieve a schedule of customer paid fees for Merchant
get
/merchantconnections
List merchant connections
post
/merchantconnections
Create a merchant connection
get
/merchantconnections/{merchantConnectionId}
Retrieve a merchant connection
put
/merchantconnections/{merchantConnectionId}/activate
Activate a merchant connection
put
/merchantconnections/{merchantConnectionId}/cancel
Cancel a merchant connection
post
/merchantcontact
Create merchant's contact by type
get
/merchantcontact/{merchantContactId}
Get merchant contact by merchant contact id
put
/merchantcontact/{merchantContactId}
Update merchant contact by merchant contact Id
delete
/merchantcontact/{merchantContactId}
Delete merchant contact by merchant contact id
post
/billing/terminal/register
Register Terminal Device
get
/billing/terminal/invoices
List Terminal Invoices
post
/billing/terminal/invoices
Create A Terminal Invoice
get
/billing/terminal/invoices/{invoiceId}
Retrieve A Terminal Invoice
put
/billing/invoices/{invoiceId}/cancel
Cancel a QR Payment request
get
/billing/styles/{styleId}
Retrieve a Styling
post
/billing/styles
Create a Styling
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Record an external payment for an invoice
post
/billing/invoices/{invoiceId}/recordpayment
Nov 3, 2026
924be4030f56
Revision changes
info
endpoint added