EZezypay

Record an external payment for a future invoice

Changed on

Record payment from a customer that occurred outside the Ezypay system (for example an over-the-counter cash transaction) on a future invoice of a subscription.Ensures payments collected in advance externally from Ezypay can be reconciled and marked as paid. The future invoice will be issued immediately in advance as a paid invoice, with an external payment type recorded against it. Fee's will be allocated to the merchant, unless it was not attempted yet.

post/billing/futureinvoices/recordpayment

Request

  • Base URL
    https://api-sandbox.ezypay.com/v2
  • URL
    https://api-sandbox.ezypay.com/v2/billing/futureinvoices/recordpayment
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://identity-sandbox.ezypay.com/token

Headers

merchantstring required

Merchant ID

Request body

subscriptionIdstring required

Auto-generated unique identifier of the subscription.

cycleStartDatestring required

The billing cycle start date of the future invoice. Supported format is YYYY-MM-DD.

paymentMethodTypestring required

The external payment method used by the customer to pay for the invoice. Supported values are cash, cheque, card, others and bank_transfer.

Response

200

object required

Changes