Export Transactions (CSV)

GET 
/v1/transactions_exports

Stream a CSV export of the transactions recorded under your acquirer. The first row is a header row naming the selected columns. Use merchant_id to narrow the export to a single merchant, and any filter accepted by GET /v1/transactions (status, type, scheme, created_at[gte] / created_at[lte] ranges, etc.) to narrow the row set.

The response is streamed — rows are flushed in batches as they are read, so large exports start downloading immediately.

Required permission: orders_read.

Request

Query Parameters

merchant_id string

Narrow the result set to a single merchant, identified by the acquirer-assigned merchant_id (not the internal UUID).

count integer

Possible values: >= 1

Maximum number of rows to export.

columns string[]
Columns to include, in the order returned by the Columns endpoint. Repeat the parameter for each column. Omit to export all available columns.
Example: [id, order_id, type, status, amount, created_at]
status string[]

Possible values: [initiated, approved, failed, timeout, system_error]

Filter by transaction status. Repeat to match multiple statuses.

type string[]

Possible values: [verify, purchase, authorize, capture, void, refund, extension, reversal]

Filter by transaction type. Repeat to match multiple types.

created_at[gte] date-time
created_at[lte] date-time

Responses

200

CSV stream. The Content-Disposition header carries a dated filename.

text/csv

Schema

Schema

string

Example

id,order_id,type,status,amount,created_at
0194f9b2-9c42-7a2c-adf3-532a310fe172,0194f9b2-9c42-7a2c-adf3-532a310fe171,purchase,approved,10000,2025-02-12T10:26:59Z

401

Authentication failed.

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "Missing authentication information"
}

403

The API key lacks the required permission.

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "Unauthorized"
}

422

Validation error.

application/json

Schema

Schema

message stringrequired

errors

object

required

property name*

string[]

Array [

string

]

Example (from schema)

{
  "message": "The given data was invalid.",
  "errors": {
    "email": [
      "This field is missing."
    ]
  }
}

Loading...