Skip to main content

List Refund Transactions

GET 
/b/api/v1/dashboard/refund-transactions/

Overview​

The Refund Transactions API provides a paginated list of all refund transactions (both full and partial refunds) in the system. This endpoint is designed for merchants and internal systems to track and manage refunds.

Authentication​

This endpoint requires authentication using one of the following methods:

  • API Key: Include the Authorization header with your private API key (e.g., Api-Key your_key_here)
  • Basic Auth: Use Keycloak or standard Basic Authentication
  • JWT Token: Use Keycloak JWT authentication

Ordering​

Use the ordering parameter to sort results:

  • created - Oldest first
  • -created - Newest first (default)

Pagination​

The response is paginated using LimitOffsetPagination:

  • limit - Number of results per page
  • offset - Number of results to skip

Response includes:

  • count - Total number of matching records
  • next - URL for next page (null if no more pages)
  • previous - URL for previous page (null if on first page)
  • results - Array of refund transactions

Example Requests​

Get all refunds (default: newest first)​

GET /checkout/api/intl/v1/refund-transactions
Authorization: Api-Key your_api_key_here

Get refunds for a specific order​

GET /checkout/api/intl/v1/refund-transactions?order_no=ORDER-12345

Get pending refunds only​

GET /checkout/api/intl/v1/refund-transactions?state=refund_queued

Get refunds in a date range​

GET /checkout/api/intl/v1/refund-transactions?created_after=01/12/2025 00:00&created_before=31/12/2025 23:59

Combine multiple filters with pagination​

GET /checkout/api/intl/v1/refund-transactions?state=refunded&currency_code=KWD&limit=10&offset=0&ordering=-created

Notes​

  • The order_no filter searches by the parent transaction's order number, not the refund transaction itself
  • The product_type filter uses the parent transaction's type
  • Date filters use the format DD/MM/YYYY HH:MM (24-hour format)
  • The initiator field returns an empty object {} for refunds not initiated by a specific user

Request​

Responses​

Paginated list of refund transactions

Last updated on