Export Refund Transactions

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

Overview

The Export Refund Transactions API generates a downloadable report (CSV or XLSX) of refund transactions. This endpoint is designed for merchants and internal systems to export refund data for reporting, reconciliation, and analysis purposes.

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

Query Parameters

Export Options

• file_format - Export format (default: csv)
  • csv - Comma-separated values
  • xlsx - Microsoft Excel format
• fields - Comma-separated list of fields to include in export (optional, all fields if not specified)
• language - Language for export headers (default: en)

Notes

• The order_no filter searches by the parent transaction's order number
• The product_type filter uses the parent transaction's type
• Large exports may take some time to generate; the file URL will be available once complete

Responses

201

Report generated successfully with download URL

401

403