Skip to main content
GET
Get account statement

Authorizations

Authorization
string
header
required

YuvexPay API key. Include as Authorization: Bearer ypk_<env>_<kid>_<secret> where <env> is test (sandbox) or live (production). Create and manage keys in the dashboard under Settings > API Keys.

Query Parameters

startDate
string
required

Start date in YYYY-MM-DD format.

Pattern: ^\d{4}-\d{2}-\d{2}$
endDate
string
required

End date in YYYY-MM-DD format.

Pattern: ^\d{4}-\d{2}-\d{2}$
format
enum<string>
default:html

Output format.

Available options:
html,
text

Response

Statement generated.

content
string

The statement content in the requested format.