TRtransfi
Settlement Reports

Send Settlement Report

Changed on

Generates the settlement report for a settlement batch and emails a time-limited download link to the report file.

The report is sent to the email addresses provided in emails when given, otherwise to the organization's configured email address. Every provided email must be a member of the authenticated organization and must have access to the TransFi dashboard.

The report is generated as a CSV file by default, or as an XLSX file when reportFormat is xlsx. It contains the customer details, settlement batch details, settlement account details, a settlement summary, and a per-order breakdown of the batch. The download link in the email is valid for 7 days.

Email delivery failures do not fail the request. The report is still generated, the recipients that could not be emailed are returned in failedRecipients, and s3Url is still returned when requestS3Link is true.

This endpoint is rate limited to 3 requests per 10 minutes. When the limit is exceeded, the API responds with HTTP 429 and a Retry-After header indicating when the request can be retried.

post/v3/settlement-reports

Request

Headers

MIDstring required
Example:SABCDEF_SCT8YW_NA

Merchant or sub-merchant MID

Request body

settlementIdstring required

Unique identifier of the settlement batch to report on

emailsstring[]

Optional recipient email addresses (maximum 5). Every email must be a member of the authenticated organization with access to the TransFi dashboard. When omitted, the report is sent to the organization's configured email address.

reportFormat'csv' | 'xlsx'

File format of the generated report. Defaults to csv.

requestS3Linkboolean

When true, the response also includes s3Url, the same time-limited download link that is sent by email. Defaults to false.

Example request

{
  "settlementId": "SB-1785323114916403",
  "emails": [
    "finance@merchant.com",
    "ops@merchant.com"
  ],
  "reportFormat": "xlsx",
  "requestS3Link": true
}

Response

Settlement report generated and emailed

statusstring

Changes