EZezypay

Generate a settlement document

Changed on

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.

post/billing/settlements/{settlementNumber}/file

Request

  • Base URL
    https://api-sandbox.ezypay.com/v2
  • URL
    https://api-sandbox.ezypay.com/v2/billing/settlements/{settlementNumber}/file
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://identity-sandbox.ezypay.com/token

Path parameters

settlementNumberstring required

Auto-generated settlement run batch number

Headers

merchantstring required

Merchant ID

Request body

sendEmailboolean

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

localeobject

Locale of the report

documentTypestring

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.

merchantIdstring

Merchant ID

Response

200

object required

Changes