EZezypay

Refund an invoice

Changed on
put/billing/invoices/{invoiceId}/refund

Request

  • Base URL
    https://api-sandbox.ezypay.com/v2
  • URL
    https://api-sandbox.ezypay.com/v2/billing/invoices/{invoiceId}/refund
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://identity-sandbox.ezypay.com/token

Path parameters

invoiceIdstring required

Auto-generated identifier of the invoice.

Headers

merchantstring required

Merchant ID

Request body

amountnumber double

Partial amount to be refunded. This amount should be less than the invoice amount less Customer Fees. If not provided, it will be refunded in full.

Response

200

idstring
creditNoteIdstring
documentNumberstring
datestring
dueDatestring
scheduledPaymentDateunknown
statusstring
memounknown
customerIdstring
subscriptionIdunknown
subscriptionNameunknown
paymentMethodTokenstring
autoPaymentboolean
createdOnstring

Example response

{
  "id": "5cfda744-1dc5-4f21-b020-fb648429bce9",
  "creditNoteId": "5ca26fde-e8bc-4a6c-a2b6-27a64e9f5ce5",
  "documentNumber": "IN0000000000000628",
  "date": "2019-07-01",
  "dueDate": "2019-07-01",
  "status": "PROCESSING",
  "items": [
    {
      "description": "testing",
      "amount": {
        "currency": "NZD",
        "value": 100
      },
      "id": "110944ba-4f14-4ccf-bd72-9c5522ab5399",
      "type": "on_demand_payment",
      "discounted": {
        "currency": "NZD"
      }
    }
  ],
  "amount": {
    "currency": "NZD",
    "value": 100
  },
  "amountWithoutDiscount": {
    "currency": "NZD",
    "value": 100
  },
  "totalDiscounted": {
    "currency": "NZD"
  },
  "totalRefunded": {
    "currency": "NZD"
  },
  "totalTax": {
    "currency": "NZD"
  },
  "customerId": "4c999653-9473-472e-b478-d56d2a7572a9",
  "paymentMethodToken": "d178cea3-fdf9-4743-90d8-856af429ab18",
  "autoPayment": true,
  "createdOn": "2019-07-01T00:33:42.562"
}

Changes