List API

Several API requests return lists of objects allowing for paging through large result sets. Lists are delivered in chronological order by default.

Attributes

Name	Type	Description
object	string	The string `list`.
location	string	API path to retrieve the current `list` object.
data	array	Returned records.
from	string	Earliest UTC datetime for returned records in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`).
limit	integer	Number of records returned.
offset	integer	Offset of the first record returned (i.e. how many records to skip from the beginning).
order	string	Order of records returned.
to	string	Latest UTC datetime for returned records in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`).
total	integer	Total amount of records between the dates `from` and `to`.

Example

JSON Response

{
  "object": "list",
  "from": "1970-01-01T00:00:00Z",
  "to": "2019-07-23T01:19:35Z",
  "offset": 0,
  "limit": 20,
  "total": 0,
  "order": "chronological",
  "location": "/customers/cust_test_no1t4tnemucod0e51mo/cards",
  "data": [
    {
      "object": "card",
      "id": "card_test_5fvso3hd5sdlh2n47u1",
      "livemode": false,
      "location": "/customers/cust_test_5fvso4s8fo3tluea6lb/cards/card_test_5fvso3hd5sdlh2n47u1",
      "created_at": "2019-05-13T04:36:56Z",
      "deleted": false,
      "street1": null,
      "street2": null,
      "city": "Bangkok",
      "state": null,
      "postal_code": "10320",
      "country": "gb",
      "phone_number": null,
      "financing": "credit",
      "bank": "Bank of the Unbanked",
      "last_digits": "4242",
      "brand": "Visa",
      "expiration_month": 12,
      "expiration_year": 2022,
      "fingerprint": "XjOdjaoHRvUGRfmZacMPcJtm0U3SEIIfkA7534dQeVw=",
      "name": "Somchai Prasert",
      "security_code_check": true
    }
  ]
}