Send Settlement Report

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 organization's configured email address. The settlement batch must belong to the authenticated organization; a settlement batch of another organization cannot be requested.

The report is an XLSX file containing 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.

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Unique identifier of the settlement batch to report on

Headers
string
required

Merchant or sub-merchant MID

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json