Skip to main content
GET
Getescheatmentreport

Authorizations

Authorization
string
header
required

JWT access token obtained from POST /v2/token.

Headers

X-Eposn-Customer-Token
string | null
X-Eposn-Merchant-Token
string | null

Path Parameters

programId
string | null
required
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

Query Parameters

jurisdiction
string | null
dormancy_days
integer
default:1095
Required range: 1 <= x <= 3650
cardId
string | null
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

Response

Successful Response

reportId
string
required
generatedAt
string<date-time>
required
jurisdiction
string
required
dormancyThresholdDays
integer
required
entries
EscheatmentReportEntryResponse · object[]
required
totalLiability
string
required
entriesCount
integer
required