Retrieve Statement

The get statement API endpoint allows partners to get a file URL to download a particular monthly statement for a merchant

POST https://<PayEngine-host>/api/merchant/:merchantId/statements/:statementID/view

Path Parameters

Name	Type	Description
merchantId*	string	PayEngine merchant ID
statementId*	string	Merchant statement ID for a merchant

200: OK

Field Definitions

This API will return an array of the following object.

Field Name	Type	Description	Required?
file_url	string	File URL to download the requested merchant statement	Required

Sample Request

curl --location --request POST '<API_HOST>/api/merchant/1cc7b594-b80f-4227-a0fa-299c4c6ce8ab/statements/7a307bdb-6169-4901-b036-226e842caea6/view' \
--header 'Authorization: Basic <API_KEY>'

Sample Response

{
"file_url": "https://merchant-statement-live.s3.us-east-2.amazonaws.com/May_2024_Statements_Develocorp%2C_Inc..pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&
}