List API

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

Attribute

Name Type Description
object string

The string list.

location string

API path to retrieve the current list object.

data Array

Array of returned objects (charges, cards, ...).

from datetime

The earliest UTC date and time for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

limit integer

The number of records returned.

offset integer

The offset of the first record returned (i.e. how many records to skip from the beginning).

order string

The order of the list returned. Either chronological (earliest to latest) or reverse_chronological (latest to earliest). Sometimes null if no entries.

to datetime

The latest UTC date and time for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

total integer

Total amount of records between from and to.

Example

  • Json Response