repCardholders

📘 Cardholders Report API (repCardholders)

This API retrieves a list of cardholders based on selected date criteria and optional filters.


🔹 Overview

  • Returns a cardholders report

  • Supports filtering by date type, card status, product type, and user details

  • Output is returned in IXML format

  • Each record represents a single cardholder


🔑 Required Parameters

Parameter
Description

dateType

Defines the date filter type (e.g., issuance, creation, activation, setpin, verification, fulfillment, lastactivity, closure )

fromDate

Start date (format: YYYY-MM-DD)

toDate

End date (format: YYYY-MM-DD)

⚠️ dateType, fromDate, and toDate are mandatory fields. The API will not return results without these parameters.


⚙️ Optional Filter Parameters

All other <Param> fields are optional and can be used to refine results.

🧑 Cardholder Filters

  • firstName, lastName

  • govtIssuedId

  • PhoneNumber, address

💳 Card Filters

  • keyType, keyValue (e.g., card number)

  • cardStatus

  • replacementStatus

  • reasonCodeGroup

🏢 Organization / Product Filters

  • productType

  • bankOrgName

  • repInternalUserOrgId

  • repInternalOrgRole

🔎 Additional Filters

  • portalUserName, issuerUser

  • verificationStatus

  • primaryRpid, secondaryRpid

  • account_id

  • SubscriptionType

  • sourceIP

  • chState, feeLess

💡 If no optional filters are provided, the API returns all cardholders within the selected date range.


📤 Response

  • Format: IXML

  • Includes:

    • Report headers (field definitions)

    • Cardholder entries (rows)

  • Each row represents a single cardholder record


🧾 Key Features

  • Flexible filtering across multiple attributes

  • Supports pagination:

    • RowsPerPage

    • FromPos

  • Consistent schema (empty fields are still returned)

  • Supports different date types via dateType


✅ Summary

Type
Fields

Required

dateType, fromDate, toDate

Optional

All other parameters (filters)

Output

Cardholders report in XML format

XML Samples

Input XML

Output XML

Last updated