JUMP TOOverviewAbout UsAuthenticationSandboxCreate CustomerCustomerCreate a customerpostList customersgetRetrieve a customergetUpdate a customerputCreate Payment MethodPayment MethodsList payment methodsgetCreate a payment methodpostRetrieve primary payment methodgetRetrieve a payment methodgetDelete a payment methoddeleteHosted Payment Page and CheckoutGet A Hosted Page TokenpostCreate A Checkout SessionpostDisable a Checkout SessiondeleteCreate Invoice (Ad-Hoc)InvoicesList invoicesgetCreate an invoicepostRetrieve an invoicegetUpdate an invoiceputRecord an external payment for an invoicepostInvoiceBatchesList invoice batchesgetCreate an invoice batchpostRetrieve an invoice batchgetTransactionsList transactionsgetRetrieve a transactiongetCreate Invoice (Subscription)PlansList plansgetCreate a planpostRetrieve a plangetUpdate a planputSubscriptionsList subscriptionsgetCreate a subscriptionpostPreview a subscriptionpostRetrieve a subscriptiongetActivate a subscriptionputCancel a subscriptionputUpdate subscription's payment methodputUndo a subscription cancellationpostUpdate subscriptionputFuture InvoicesList future invoicesgetUpdate a future invoiceputDelete a future invoicedeleteRecord an external payment for a future invoicepostFailed Payment ScenarioInvoicesWrite off an invoicepostRetry a payment on an invoicepostPayment MethodsReplace a payment methodputUpdate primary payment methodputRefundsRefundRefund an invoiceputCredit NotesList credit notesgetRetrieve a credit notegetWebhooksEventsResend eventpostWebhooksList webhooksgetCreate webhookpostList webhook notification logsgetRetrieve webhook detailsgetUpdate webhookputDelete webhookdeleteSettlementSettlementsList settlementsgetGenerate a settlement documentpostReportsReportsGenerate Outstanding Collections ReportpostGenerate Merchant Transactions ReportpostFile ServiceGet FilegetPartnerPartner InvoicesList partner invoicesgetCreate a partner invoicepostAttempt payment on a partner invoicepostPartner SubscriptionsList partner subscriptionsgetCreate a partner subscriptionpostList partner subscription add on usagegetRecord a partner subscription add on usagepostCancel a partner subscriptionputMerchantContact Email AddressAdd email address for merchant contactpostGet email addresses by merchant contact idgetUpdate an existing email addressputMerchantsRetrieve a merchantgetRetrieve collected next settlement amountgetRetrieve a schedule of customer paid fees for MerchantgetMerchant ConnectionsList merchant connectionsgetRetrieve a merchant connectiongetMerchant ContactCreate merchant's contact by typepostGet merchant contact by merchant contact idgetUpdate merchant contact by merchant contact IdputDelete merchant contact by merchant contact iddeleteNotesNotesCreate A NotepostRetrieve A NotegetList NotesgetUpdate A NoteputDelete A NotedeletePayToMandate TypesList mandate typesgetGet a mandate typegetMoreTerms and ConditionsPrivacy and SecurityList settlementsget https://api-sandbox.ezypay.com/v2/billing/settlementsRetrieve a list of settlements and filter the results using the available options.
