Get Recurring Application Transaction List

The Get Recurring Charge Transaction List API retrieves a paginated list of transactions associated with a specific recurring application charge.

Request Parameters

Public Request Parameters

📘

Path Parameters

ParameterTypeRequiredDescriptionExample
charge_idstringYesID of the recurring application chargerch_123456

Query Parameters

ParameterTypeRequiredDescriptionExample
cursorstringNoCursor for paginationnext_page_cursor
page_sizeint32NoPage size for the number of transactions to retrieve. Default to 1015
transaction_statusstringNoFilter transactions by statuspaid
paid_at_minstringNoMinimum payment date (ISO 8601 format)2023-01-01T00:00:00Z
paid_at_maxstringNoMaximum payment date (ISO 8601 format)2023-12-31T23:59:59Z

Response Explanation

Public Response Parameters

📘

Successful Response

ParameterTypeExampleDescription
codestring"success"Status indicator
messagestring"Inventory levels retrieved"Result description
data.transactionsarray of objects[ {...}, {...} ]List of transactions
data.cursorstringnext_page_cursorCursor for next page
data.has_morebooleantrueWhether there are more pages available

Transaction Object Structure

ParameterTypeExampleDescription
idstringtxn_123456Unique identifier for the transaction
charge_idstringchg_123456ID of the associated charge
pricestring19.99Transaction amount
usage_pricestring0.00Usage-based pricing amount
statusstringpaidTransaction status
paid_atstring2023-06-01T00:00:00ZPayment timestamp (ISO 8601 format)

Error Response

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestring``Error message
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!