EZezypay

Retrieve a credit note

Changed on

Get the full details of a credit note

get/billing/creditnotes/{creditNoteId}

Request

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

Path parameters

creditNoteIdstring required

Auto-generated identifier of the credit note.

Headers

merchantstring required

Merchant ID

Response

200

idstring
invoiceIdstring
documentNumberstring
datestring
statusstring
reasonstring
customerIdstring
paymentMethodTokenstring

Example response

{
  "id": "adfd27f3-1443-44d7-a343-62802131dd21",
  "invoiceId": "d3b774c5-13b3-4461-935d-00abc26c0e8c",
  "documentNumber": "CN0000000000000001",
  "date": "2019-04-01",
  "status": "PAID",
  "items": [
    {
      "amount": {
        "currency": "NZD",
        "value": 1.24
      },
      "tax": {
        "rate": 0.1
      },
      "id": "4c59b609-8e8f-4685-8f76-30492c865f4c",
      "type": "transaction_fee"
    }
  ],
  "amount": {
    "currency": "NZD",
    "value": 1.24
  },
  "totalTax": {
    "currency": "NZD"
  },
  "reason": "REFUND",
  "customerId": "4c999653-9473-472e-b478-d56d2a7572a9",
  "paymentMethodToken": "d178cea3-fdf9-4743-90d8-856af429ab18"
}

Changes