EZezypay

Retrieve a transaction

Changed on

Retrieves the full details of a transaction.

get/billing/transactions/{transactionId}

Request

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

Path parameters

transactionIdstring required

Auto-generated unique identifier of the transaction.

Headers

merchantstring required

Merchant ID

Response

200

idstring
numberunknown
statusstring
createdOnstring
failedOnunknown
typestring
sourcestring
paymentMethodTypeunknown
paymentMethodDescriptionunknown
failedPaymentReasonunknown
channelstring

Example response

{
  "id": "501f0e13-b68f-4640-8e47-6bfac83c1940",
  "status": "SUCCESS",
  "createdOn": "2019-07-01T01:41:43.207",
  "amount": {
    "currency": "NZD",
    "value": 5.5,
    "type": "FIXED_AMOUNT"
  },
  "type": "PAYMENT",
  "source": "wallet",
  "document": {
    "id": "97f16bec-99e0-4cc8-ac3b-7cb3e8fcae9e",
    "type": "invoice"
  },
  "sender": {
    "id": "c556d40f-87b5-49f9-90e8-07a610dac1a7",
    "name": "high_st NameNZ",
    "type": "MERCHANT"
  },
  "receiver": {
    "name": "EZYPAY",
    "type": "EZYPAY"
  },
  "channel": "api"
}

Changes