General Ledger
Retrieve paginated general ledger data
The event_type filter accepts AUTHORIZATION, SETTLEMENT, REVERSAL, CANCELLATION, FORCE_CAPTURE, or REFUND. Sort by transaction_id, event_id, transaction_reference, event_type, transaction_type_id, or occurred_at.
get/v1/general-ledger-data
Request
- Base URLhttp://<host-url>
- URLhttp://<host-url>/v1/general-ledger-data
- AuthHTTP bearer
Query parameters
transaction_idinteger
event_idstring uuid
schema_versioninteger
transaction_referencestring
transaction_identifierstring
parent_transaction_idinteger
event_type'AUTHORIZATION' | 'SETTLEMENT' | 'REVERSAL' | 'CANCELLATION' | 'FORCE_CAPTURE' | 'REFUND'
transaction_type_idinteger
amountnumber
currencystring
transaction_date_time_fromstring date-time
transaction_date_time_tostring date-time
occurred_at_fromstring date-time
Inclusive ISO-8601 start instant converted to tenant-local time before filtering
occurred_at_tostring date-time
Inclusive ISO-8601 end instant converted to tenant-local time before filtering
page_numberinteger required
page_sizeinteger required
sort_by'transaction_id' | 'event_id' | 'transaction_reference' | 'event_type' | 'transaction_type_id' | 'occurred_at' required
sort_direction'ASC' | 'DESC' required
Headers
unique-request-idstring
Unique identifier of a request.
Response
General ledger data retrieved successfully
Changes
No recorded changes to this operation across all 1 revision of this API.