API Reference
SUPPORT CENTREEZYPAY

Generate a settlement document

post
https://api-sandbox.ezypay.com/v2/billing/settlements//file

Generate a document report on your settlement. Returns a file ID for the specified document type. Provide this ID to the file download service API, which will return a URL to download the report. Please append the header called Accepted-Language, the locale values currently supported are en and zh_TW.

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

Auto-generated settlement run batch number

Body Params
boolean

Set sendEmail to true if you want to receive an automated email with this report attached to it.

string

The type of document generated from the settlement. Supported values are: tax_invoice: Generates a settlement tax invoice PDF. detail_report: Generates a full report (in .csv format) on the settlement status of payment collections from customers.

string

Merchant ID

Headers
string
required

Merchant ID

Responses

Updated 5 months ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 5 months ago