GET
/v1/payment_recordsList Payment Records
Lists Payment Records for a given merchant. Use the creation-time filters and cursor parameters to restrict and paginate the results, and use expand when you need additional fields in each record. The response includes list metadata and indicates whether another page is available.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
created_afterintegeroptional
Return only Payment Records created after this Unix timestamp.
created_beforeintegeroptional
Return only Payment Records created before this Unix timestamp.
ending_beforestringoptional
Pagination cursor identifying the object before which to return the previous page. The value can contain up to 5,000 characters.
expandarray<string>optional
Names of fields to expand in each returned Payment Record. Each value can contain up to 5,000 characters.
limitintegeroptional
Maximum number of Payment Records to return. Must be between 1 and 100. Defaults to 10 when omitted.
starting_afterstringoptional
Pagination cursor identifying the object after which to return the next page. The value can contain up to 5,000 characters.
200Returns a list object containing Payment Records in `data`, the `list` object type, the list URL, and a `has_more` flag indicating whether another page is available.
dataarray<PaymentRecord>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
urlstringrequired
The URL where this list can be accessed.
defaultError response.
errorobjectrequired
Error handling
limit must be between 1 and 100 and defaults to 10 when omitted. Use created_after and created_before as Unix timestamps, and provide valid object IDs for starting_after or ending_before when paginating.