Sign in

v1

latestOpenAPI 3.1.02026-08-06142966.9 KB
charges

List Charges

List charges with cursor-based pagination.

Filters:

  • customer_id: Filter by customer UUID
  • instrument_id: Filter by instrument UUID
  • reference: Filter by exact reference match
  • created_at_from: Filter charges created on or after this date
  • created_at_to: Filter charges created on or before this date
  • result_at_from: Filter charges with result on or after this date
  • result_at_to: Filter charges with result on or before this date
  • instrument_identifier: Filter by instrument identifier (inline or linked)

Pagination:

  • cursor: Opaque cursor from previous response
  • Use next_cursor from response for next page
get/charges

Query parameters

limitinteger

Maximum number of records to return

Maximum number of records to return

cursorstring nullable

Cursor for pagination (use next_cursor from previous response)

Cursor for pagination (use next_cursor from previous response)

customer_idstring uuid nullable

Filter by customer ID

Filter by customer ID

instrument_idstring uuid nullable

Filter by instrument ID

Filter by instrument ID

referencestring nullable

Filter by reference

Filter by reference

created_at_fromstring date-time nullable

Filter charges created on or after this date

Filter charges created on or after this date

created_at_tostring date-time nullable

Filter charges created on or before this date

Filter charges created on or before this date

result_at_fromstring date-time nullable

Filter charges with result on or after this date

Filter charges with result on or after this date

result_at_tostring date-time nullable

Filter charges with result on or before this date

Filter charges with result on or before this date

instrument_identifierstring nullable

Filter by instrument identifier (searches both inline and linked instruments)

Filter by instrument identifier (searches both inline and linked instruments)

Headers

X-API-Keystring nullable

Response

Successful Response

limitinteger required
has_nextboolean
has_previousboolean
next_cursorstring nullable