EZezypay

List settlements

Changed on

Retrieve a list of settlements and filter the results using the available options.

get/billing/settlements

Request

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

Query parameters

fromstring

Start date for range of settlements to view. Filter by settlement run date defined in settlementDate.

untilstring

End date for range of settlements to view. Filter by settlement run date defined in settlementDate.

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.

cursorstring

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.

Request body

merchantstring required

Merchant ID

Response

200

Example response

{
  "data": [
    {
      "number": "140637",
      "date": "2019-09-19",
      "revenue": {
        "currency": "AUD",
        "value": 212.24
      },
      "deduction": {
        "currency": "AUD",
        "value": 115.11
      },
      "amount": {
        "currency": "AUD",
        "value": 97.13
      },
      "settlementPayoutMethod": {
        "paymentMethodToken": "f36b0f16-d7c4-4937-9886-34f828596a3b",
        "bank": {
          "accountHolderName": "Automation Test AUSTRALIA",
          "last4": "6789",
          "bankNumber": "402052"
        }
      },
      "status": "success",
      "createdOn": "2019-09-19T07:34:50.310"
    }
  ],
  "paging": {
    "totalCount": 2
  }
}

Changes