EZezypay

List transactions

Changed on

Get a list of of transactions for a specific customer or invoice. The transactions are returned sorted by creation date, with the most recently created transactions appearing first.

get/billing/transactions

Request

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

Query parameters

transactionNumberstring

Transaction identifier generated by the payment processor.

senderIdstring

Identifier of the sender who sent the funds.

receiverIdstring

Identifier of the recipient who received the funds.

documentIdstring

Identifier of the document that triggered this transaction.

limitinteger

To paginate a large result set, use the 'limit' argument to limit the number of results returned per page up to a maximum of 100 records. For example, limit = 10 shows results 1-10. The default returned result would be 100.

cursorinteger

An cursor for use in pagination. Specify the number of objects to skip to fetch the next page of objects. For example, limit=10 and cursor=10 will show results for record 11 - 20.

fromstring date

Start date for range of transactions to view. Filter by date defined in createdOn. Supported format is YYYY-MM-DD.

untilstring date

End date for range of transactions to view. Filter by date defined in createdOn. Supported format is YYYY-MM-DD.

statusstring

State of the transaction attempt. Supported values are success, processing, failed or settled.

Headers

merchantstring required

Merchant ID

Response

200

Example response

{
  "data": [
    {
      "id": "10a59bcf-12fe-4686-b84d-3a53eb7fcea2",
      "status": "SUCCESS",
      "createdOn": "2019-07-01T03:24:05.555",
      "amount": {
        "currency": "NZD",
        "value": 0.89,
        "type": "FIXED_AMOUNT"
      },
      "type": "PAYMENT",
      "source": "wallet",
      "document": {
        "id": "769c065e-ea7a-43ae-bcad-06b8da7dd07a",
        "type": "invoice"
      },
      "sender": {
        "id": "c556d40f-87b5-49f9-90e8-07a610dac1a7",
        "name": "high_st NameNZ",
        "type": "MERCHANT"
      },
      "receiver": {
        "name": "EZYPAY",
        "type": "EZYPAY"
      },
      "channel": "api"
    }
  ],
  "paging": {
    "nextUrl": "https://api-staging.ezypay.com/v2/billing/transactions?limit=10&cursor=10",
    "nextCursor": 10,
    "limit": 10,
    "totalCount": 2
  }
}

Changes