EZezypay

Generate group settlement report by transaction status

Changed on

Generate a group settlement report by transaction status.

post/billing/settlements/groupedbytransactionstatus/file

Request

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

Headers

merchantstring required

Merchant ID

Request body

dateFromstring

Start date (inclusive) that the Group Settlement Report should cover, in format YYYY-MM-DD.

dateTostring

End date (inclusive) that the Group Settlement Report should cover, in format YYYY-MM-DD.

documentTypestring

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

merchantIdsstring[]

Restrict the Group Settlement Report to a specified set of Merchants.

Response

200

object required

Changes