increase-test
GET/card_purchase_supplements

List Card Purchase Supplements

Lists Card Purchase Supplements, which contain additional information about card purchases such as settlement or refund details. Filter by Card Payment or creation time, and use cursor to retrieve subsequent pages of results.

7 parameters
cursorstringoptional
Returns the page of entries after this cursor.
limitintegeroptional
Maximum number of Card Purchase Supplements to return. Must be at least 1 and is capped at 100. Defaults to 100 when omitted.
Default:100
card_payment_idstringoptional
Filter supplements to those belonging to the specified Card Payment.
created_at.afterstringoptional
Return results after this timestamp in ISO 8601 date-time format.
created_at.beforestringoptional
Return results before this timestamp in ISO 8601 date-time format.
created_at.on_or_afterstringoptional
Return results at or after this timestamp in ISO 8601 date-time format.
created_at.on_or_beforestringoptional
Return results at or before this timestamp in ISO 8601 date-time format.

3 status codes
200Returns a list of Card Purchase Supplement objects and a `next_cursor` for retrieving the next page, or null when there are no further results.
dataarray<CardPurchaseSupplement>required
The contents of the list.
next_cursorstringrequired
A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.
4XXReturned when the request encounters a client-side error.
5XXReturned when the request encounters a server-side error.

Error handling

limit must be at least 1 and cannot exceed 100; it defaults to 100 when omitted. The created_at filters must use ISO 8601 date-time values.