Skip to main content

List Payment Request Transactions (with Configurable Filters)

GET 
/b/api/v1/plugins/payment_request/transaction

List payment request transactions with configurable filter support.

Metadata (OPTIONS Request)​

Send an OPTIONS request to this endpoint to retrieve metadata including:

  • filters_data: Configurable filter fields with their types and options
  • export: Available export formats
  • actions: Available bulk actions
  • search_fields: Available search fields

Filter Types​

Select from predefined options. The options array contains available values.

Available dropdown filters:

  • state: Transaction state (pending, paid, failed, etc.)
  • currency_code: Currency (KWD, USD, EUR, etc.)
  • gateway_code: Payment gateway
  • initiator: User who created the transaction
  • product_type: Product type (e_commerce, payment_request, etc.)
  • seen: Whether transaction was viewed (Yes/No)
  • email_seen: Whether email notification was opened (Yes/No)

Example request:

GET /b/api/v1/plugins/payment_request/transaction/?state=pending&currency_code=KWD

DateTime Filters​

Filter by date/time range using _after and _before suffixes.

Available datetime filters:

  • created: Transaction creation date
  • modified: Last modification date
  • state_changed_at: When state last changed

Example request:

GET /b/api/v1/plugins/payment_request/transaction/?created_after=2024-01-01T00:00:00Z&created_before=2024-12-31T23:59:59Z

Amount Range Filters​

Filter by numeric range using _min and _max suffixes.

Example request:

GET /b/api/v1/plugins/payment_request/transaction/?amount_min=100&amount_max=500

Filter Configuration​

Filters are configured via the SearchConfig admin panel. Each merchant can customize which filters are available and their display order. Only active filters are returned in the OPTIONS response.

Boolean Virtual Fields​

Some filters like seen and email_seen are virtual fields that don't exist directly on the model but are computed from related fields (e.g., seen_at timestamp). These return boolean options (Yes/No) in the dropdown.

Request​

Responses​

Last updated on