v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Gift Card Reports

Download Scheduled Report

Generate and stream the latest report data for a schedule.

Defaults to the last 30 days of transactions regardless of the schedule's configured period. The response Content-Disposition header carries the suggested filename derived from the schedule name and current date.

get/v2/giftcards/programs/{programId}/reports/scheduled/{scheduleId}/download

Path parameters

programIdstring required
Example:5eb7cf5a86d9755df3a6c593
scheduleIdstring required

Query parameters

cardIdstring
Example:5eb7cf5a86d9755df3a6c593

Headers

X-Eposn-Customer-Tokenstring nullable
X-Eposn-Merchant-Tokenstring nullable

Response

Successful Response

{"stackTrail":"paths:/v2/giftcards/programs/{programId}/reports/scheduled/{scheduleId}/download:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}