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

destServer=debitAppServer2&data=<?xml version="1.0" ?>
<PraxellMessage>
 <ServiceRequest>
  <UserName>test_pm</UserName>
  <UserPassword>test_pm</UserPassword>
  <ServiceName>Report</ServiceName>
  <UniqueRequestId>1212121212121213</UniqueRequestId>
  <OriginType>Portal:pdp</OriginType>
  <ReportName>repCardholders</ReportName>
  <SourceName>Default</SourceName>
  <WhereName>Advanced</WhereName>
  <GroupByName>Default</GroupByName>
  <OrderByName>Default</OrderByName>
  <FormatName>IXML</FormatName>
  <OutputName>ProgMngr</OutputName>
  <RowsPerPage>50</RowsPerPage>
  <FromPos>1</FromPos>
  <NumberOfRows></NumberOfRows>        
   <Param Name="repInternalUserOrgId" Value="" Operator=""/>
   <Param Name="fromDate" Value="2018-03-29" Operator=""/>
   <Param Name="toDate" Value="2018-03-29" Operator=""/>
   <Param Name="childName" Value="" Operator=""/>
   <Param Name="keyType" Value="cardNumber" Operator=""/>
   <Param Name="keyValue" Value="" Operator=""/>
   <Param Name="firstName" Value="" Operator=""/>
   <Param Name="lastName" Value="" Operator=""/>
   <Param Name="repInternalOrgRole" Value="" Operator=""/>
   <Param Name="govtIssuedId" Value="" Operator=""/>
   <Param Name="cardStatus" Value="SPND" Operator=""/>
   <Param Name="reasonCodeGroup" Value="UnactivatedCard" Operator=""/>
   <Param Name="productType" Value="111" Operator=""/>
   <Param Name="bankOrgName" Value="" Operator=""/>
   <Param Name="replacementStatus" Value="" Operator=""/>
   <Param Name="sourceIP" Value="" Operator=""/>
   <Param Name="dateType" Value="issuance" Operator=""/>
   <Param Name="feeLess" Value="" Operator=""/>
   <Param Name="chState" Value="" Operator=""/>
   <Param Name="issuerUser" Value="" Operator=""/>
   <Param Name="portalUserName" Value="XYZ" Operator=""/>
   <Param Name="address" Value="" Operator=""/>
   <Param Name="verificationStatus" Value="" Operator=""/>
   <Param Name="primaryRpid" Value="" Operator=""/>
   <Param Name="secondaryRpid" Value="" Operator=""/>
   <Param Name="SubscriptionType" Value="" Operator=""/>
   <Param Name="PhoneNumber" Value="" Operator=""/>
   <Param Name="account_id" Value="" Operator=""/>
 </ServiceRequest>
</PraxellMessage>

Output XML

<praxellmessage>
  <serviceresponse>
    <servicecode>Report</servicecode>
    <servicestatusid>0</servicestatusid>
    <servicestatusname>0</servicestatusname>
    <updatedate>2026-04-15T12:26:41</updatedate>
    <sessionid>159111de-008c-4a34-a2b2-bb05c17f0307</sessionid>
    <serviceid>159111de-008c-4a34-a2b2-bb05c17f0307</serviceid>

    <reportoutput>
      <![CDATA[
<report-data>

  <report-headers>
    <header name="more">Actions</header>
    <header name="card_number">Card Number</header>
    <header name="full_name">Name</header>
    <header name="rpid_">RPID</header>
    <header name="dda_">DDA</header>
    <header name="fbe_dda">FBE DDA</header>
    <header name="virtual">Virtual</header>
    <header name="card_status">Status</header>
    <header name="status_reason">Status Reason</header>
    <header name="ch_state">CH State</header>
    <header name="LAST_KNOWN_BALANCE">Bal.</header>
    <header name="LAST_KNOWN_HOLD">Holds Bal.</header>
    <header name="LAST_ACTIVITY_DATE">Last Activity</header>
    <header name="user_name">Username</header>
    <header name="first_name">First Name</header>
    <header name="middle_initial">Middle Initial</header>
    <header name="last_name">Last Name</header>
    <header name="address_line_1">Address 1</header>
    <header name="address_line_2">Address 2</header>
    <header name="city">City</header>
    <header name="state">State</header>
    <header name="zip">Zip</header>
    <header name="ship_to_address_line_1">Shipping Address Line 1</header>
    <header name="ship_to_address_line_2">Shipping Address Line 2</header>
    <header name="ship_to_city">Shipping City</header>
    <header name="ship_to_state">Shipping State</header>
    <header name="ship_to_zip">Shipping Zip</header>
    <header name="email">Mail</header>
    <header name="phone">Phone</header>
    <header name="mobile_phone">Mobile</header>
    <header name="INT_PHONE_NUMBER">International Phone Number</header>
    <header name="should_get_sms">SMS Enabled</header>
    <header name="SUBSCRIBE_TO_EMAIL">Subscribe To E-mail</header>
    <header name="active_early_access">Early Access</header>
    <header name="date_of_birth">Date of Birth</header>
    <header name="issuing_org">Issuer</header>
    <header name="product_type">Product Type</header>
    <header name="bank_org_name">Issuing Bank</header>
    <header name="proc_account_number">Processor Account</header>
    <header name="social_security_number">Gov't Issued ID</header>
    <header name="doc_type_id">Gov't ID Type</header>
    <header name="doc_issue_date">Gov't ID Issue Date</header>
    <header name="doc_expiration_date">Gov't ID Expiration Date</header>
    <header name="suspend_reason_type">SPND Reason Type</header>
    <header name="replacement_status">Replacement Status</header>
    <header name="VERIFICATION_RESULT">Verification Status</header>
    <header name="VERIFICATION_RESULT_DESC">Verification Detailed Status</header>
    <header name="VERIFICATION_ID">Verification ID</header>
    <header name="VERIFICATION_DATE">Verified</header>
    <header name="E_SIGN_ACCEPTED_DATE">ESign Acceptance Date</header>
    <header name="ALT_E_SIGN_ACCEPTED_DATE">Alt ESign Acceptance Date</header>
    <header name="card_order_date">Card Created</header>
    <header name="expiration_date">Card Expiration Date</header>
    <header name="LAST_PIN_CHANGE_DATE">Last Set PIN Date</header>
    <header name="activation_date">Card activation date</header>
    <header name="issue_date">Card Issue date</header>
    <header name="CH_ACTIVATION_DATE">CH Activation Date</header>
    <header name="last_close_date">Close Date</header>
    <header name="is_fees_less">Is Fee Less</header>
    <header name="account_id">Account Id</header>
    <header name="CLIENT_SOURCE_IP">Source IP</header>
    <header name="CARD_ISSUANCE_DESC">Card Issuance Description</header>
    <header name="FULFILLMENT_FILE_NAME">Card Fulfillment File</header>
    <header name="FULFILLMENT_DATE">Card Fulfillment Date</header>
    <header name="CAMPAIGN_CODE">Campaign ID</header>
    <header name="REFERRAL_CODE">Referral Code</header>
    <header name="ACTIVATION_USER_NAME">Activation User Name</header>
    <header name="card_type">Card Type</header>
    <header name="USER_DEFINED_1">User Defined Field 1</header>
    <header name="USER_DEFINED_2">User Defined Field 2</header>
    <header name="USER_DEFINED_3">User Defined Field 3</header>
    <header name="USER_DEFINED_4">User Defined Field 4</header>
    <header name="USER_DEFINED_5">User Defined Field 5</header>
    <header name="USER_DEFINED_6">User Defined Field 6</header>
    <header name="USER_DEFINED_7">User Defined Field 7</header>
    <header name="USER_DEFINED_8">User Defined Field 8</header>
    <header name="USER_DEFINED_9">User Defined Field 9</header>
    <header name="USER_DEFINED_10">User Defined Field 10</header>
    <header name="USER_DEFINED_11">User Defined Field 11</header>
    <header name="USER_DEFINED_12">User Defined Field 12</header>
    <header name="USER_DEFINED_13">User Defined Field 13</header>
    <header name="USER_DEFINED_14">User Defined Field 14</header>
    <header name="USER_DEFINED_15">User Defined Field 15</header>
    <header name="AUTHORIZED_USER">Authorized User</header>
    <header name="LABEL_ON_CARD">Label on card</header>
    <header name="LABEL_ON_NEXT_CARD">Label on next card</header>
    <header name="LAST_ACTIVITY_TYPE">Last Activity Type</header>
    <header name="LAST_ACTIVITY_STATE">Last Activity State</header>
    <header name="LAST_ACTIVITY_SUCCESS">Last Activity Success</header>
    <header name="ALL_ACTIVITIES">All Activities</header>
    <header name="CARDHOLDER_BANK_NAME">Cardholder Bank</header>
    <header name="CARDHOLDER_ACCOUNT_NUMBER">Cardholder Account Number</header>
    <header name="CARDHOLDER_ACCOUNT_NAME">Cardholder Account Name</header>
    <header name="CARDHOLDER_BANK_ROUTING">Cardholder Bank Routing</header>
    <header name="INT_ADDRESS_LINE_1">International Address Line 1</header>
    <header name="INT_ADDRESS_LINE_2">International Address Line 2</header>
    <header name="INT_CITY">International City</header>
    <header name="INT_STATE_PROVINCE_REGION">International State/Region</header>
    <header name="INT_COUNTRY">International Country</header>
    <header name="INT_ZIP_POSTAL_CODE">International Zip</header>
    <header name="INT_DOC_ID">International Document ID</header>
    <header name="INT_DOC_TYPE">International Document Type</header>
    <header name="INT_ADDRESS">Use International Address</header>
    <header name="LANGUAGE">Language</header>
    <header name="MIDDLE_NAME">Middle Name</header>
    <header name="SUR_NAME">Surname</header>
    <header name="ADDITIONAL_ID_EXPIRATION_DATE">Additional ID Expiration</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_NAME1">Provider Name 1</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_ID1">Provider ID 1</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_CREATION_DATE1">Provider Creation Date 1</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_LAST_UPDATE_DATE1">Provider Update Date 1</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_ADDITIONAL_INFO1">Provider Info 1</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_NAME2">Provider Name 2</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_ID2">Provider ID 2</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_CREATION_DATE2">Provider Creation Date 2</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_LAST_UPDATE_DATE2">Provider Update Date 2</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_ADDITIONAL_INFO2">Provider Info 2</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_NAME3">Provider Name 3</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_ID3">Provider ID 3</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_CREATION_DATE3">Provider Creation Date 3</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_LAST_UPDATE_DATE3">Provider Update Date 3</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_ADDITIONAL_INFO3">Provider Info 3</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_NAME4">Provider Name 4</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_ID4">Provider ID 4</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_CREATION_DATE4">Provider Creation Date 4</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_LAST_UPDATE_DATE4">Provider Update Date 4</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_ADDITIONAL_INFO4">Provider Info 4</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_NAME5">Provider Name 5</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_ID5">Provider ID 5</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_CREATION_DATE5">Provider Creation Date 5</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_LAST_UPDATE_DATE5">Provider Update Date 5</header>
    <header name="EXTERNAL_PAYMENT_PROVIDER_ADDITIONAL_INFO5">Provider Info 5</header>
  </report-headers>

  <report-entries>
    <row>
	  <entry name="more">actions</entry>
	  <entry name="card_number">1111</entry>
	  <entry name="full_name">Jhon Doe</entry>
	  <entry name="rpid_">123654789</entry>
	  <entry name="dda_">NA</entry>
	  <entry name="fbe_dda"></entry>
	  <entry name="virtual">PrintedCard</entry>
	  <entry name="card_status">SPND</entry>
	  <entry name="status_reason">Unactivated Replacement Card</entry>
	  <entry name="ch_state">V-PNS</entry>
	  <entry name="LAST_KNOWN_BALANCE">5765</entry>
	  <entry name="LAST_KNOWN_HOLD">0</entry>
	  <entry name="LAST_ACTIVITY_DATE">04-08-2026 00:18:08</entry>
	  <entry name="user_name">babyshow69</entry>
	  <entry name="first_name">Jhon</entry>
	  <entry name="middle_initial"></entry>
	  <entry name="last_name">Doe</entry>
	  <entry name="address_line_1">3589 umbrella Ave</entry>
	  <entry name="address_line_2"></entry>
	  <entry name="city">New York</entry>
	  <entry name="state">OH</entry>
	  <entry name="zip">11201</entry>
	  <entry name="ship_to_address_line_1"></entry>
	  <entry name="ship_to_address_line_2"></entry>
	  <entry name="ship_to_city"></entry>
	  <entry name="ship_to_state"></entry>
	  <entry name="ship_to_zip"></entry>
	  <entry name="email">[e-mail]</entry>
	  <entry name="phone">1234567895</entry>
	  <entry name="mobile_phone">1234567895</entry>
	  <entry name="INT_PHONE_NUMBER"></entry>
	  <entry name="should_get_sms"></entry>
	  <entry name="SUBSCRIBE_TO_EMAIL"></entry>
	  <entry name="active_early_access">Y</entry>
	  <entry name="date_of_birth">04-18-2001 00:00:00</entry>
	  <entry name="issuing_org">issue_Company_17144</entry>
	  <entry name="product_type">Juice5_Bulk EMV (P)</entry>
	  <entry name="bank_org_name">First Century Bank NC</entry>
	  <entry name="proc_account_number">1234</entry>
	  <entry name="social_security_number">1234567895</entry>
	  <entry name="doc_type_id">SSN</entry>
	  <entry name="doc_issue_date"></entry>
	  <entry name="doc_expiration_date"></entry>
	  <entry name="suspend_reason_type"></entry>
	  <entry name="replacement_status"></entry>
	  <entry name="VERIFICATION_RESULT">VerifiedSSN</entry>
	  <entry name="VERIFICATION_RESULT_DESC">VerifiedSSN</entry>
	  <entry name="VERIFICATION_ID">1234567895</entry>
	  <entry name="VERIFICATION_DATE">12-30-2024 14:49:05</entry>
	  <entry name="E_SIGN_ACCEPTED_DATE"></entry>
	  <entry name="ALT_E_SIGN_ACCEPTED_DATE"></entry>
	  <entry name="card_order_date">04-14-2026 14:05:16</entry>
	  <entry name="expiration_date">04-30-2029 00:00:00</entry>
	  <entry name="LAST_PIN_CHANGE_DATE"></entry>
	  <entry name="activation_date">12-30-2024 14:49:04</entry>
	  <entry name="issue_date">04-14-2026 14:05:16</entry>
	  <entry name="CH_ACTIVATION_DATE"></entry>
	  <entry name="last_close_date"></entry>
	  <entry name="is_fees_less">N</entry>
	  <entry name="account_id">1234567895</entry>
	  <entry name="CLIENT_SOURCE_IP"></entry>
	  <entry name="CARD_ISSUANCE_DESC"></entry>
	  <entry name="FULFILLMENT_FILE_NAME">Cards_for_Fulfillment_2026-04-14_1902.xml</entry>
	  <entry name="FULFILLMENT_DATE">04-14-2026 19:04:17</entry>
	  <entry name="CAMPAIGN_CODE"></entry>
	  <entry name="REFERRAL_CODE"></entry>
	  <entry name="ACTIVATION_USER_NAME">issue_Company_17144</entry>
	  <entry name="card_type">GPR</entry>
	  <entry name="USER_DEFINED_1">juice_1.eps</entry>
	  <entry name="USER_DEFINED_2"></entry>
	  <entry name="USER_DEFINED_3">0 (PrintedCard)</entry>
	  <entry name="USER_DEFINED_4"></entry>
	  <entry name="USER_DEFINED_5">juicefin.com/juice5</entry>
	  <entry name="USER_DEFINED_6">https://juicefin.com/mobile</entry>
	  <entry name="USER_DEFINED_7">SAY GOODBYE TO EVERYTHING ELSE IN YOUR WALLET</entry>
	  <entry name="USER_DEFINED_8">juicefin.com/cardholders</entry>
	  <entry name="USER_DEFINED_9">[phone]</entry>
	  <entry name="USER_DEFINED_10">juicefin.com/juice5</entry>
	  <entry name="USER_DEFINED_11"></entry>
	  <entry name="USER_DEFINED_12">INITIATE</entry>
	  <entry name="USER_DEFINED_13">PTJuice5_Bulk EMV:TOPTJuice5_Bulk EMV:CHA01:FORM00</entry>
	  <entry name="USER_DEFINED_14"></entry>
	  <entry name="USER_DEFINED_15"></entry>
	  <entry name="AUTHORIZED_USER">NA</entry>
	  <entry name="LABEL_ON_CARD"></entry>
	  <entry name="LABEL_ON_NEXT_CARD"></entry>
	  <entry name="LAST_ACTIVITY_TYPE"></entry>
	  <entry name="LAST_ACTIVITY_STATE"></entry>
	  <entry name="LAST_ACTIVITY_SUCCESS"></entry>
	  <entry name="ALL_ACTIVITIES"></entry>
	  <entry name="CARDHOLDER_BANK_NAME"></entry>
	  <entry name="CARDHOLDER_ACCOUNT_NUMBER"></entry>
	  <entry name="CARDHOLDER_ACCOUNT_NAME"></entry>
	  <entry name="CARDHOLDER_BANK_ROUTING"></entry>
	  <entry name="INT_ADDRESS_LINE_1"></entry>
	  <entry name="INT_ADDRESS_LINE_2"></entry>
	  <entry name="INT_CITY"></entry>
	  <entry name="INT_STATE_PROVINCE_REGION"></entry>
	  <entry name="INT_COUNTRY"></entry>
	  <entry name="INT_ZIP_POSTAL_CODE"></entry>
	  <entry name="INT_DOC_ID"></entry>
	  <entry name="INT_DOC_TYPE"></entry>
	  <entry name="INT_ADDRESS"></entry>
	  <entry name="LANGUAGE"></entry>
	  <entry name="MIDDLE_NAME"></entry>
	  <entry name="SUR_NAME"></entry>
	  <entry name="ADDITIONAL_ID_EXPIRATION_DATE"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_NAME1"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_ID1"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_CREATION_DATE1"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_LAST_UPDATE_DATE1"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_ADDITIONAL_INFO1"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_NAME2"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_ID2"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_CREATION_DATE2"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_LAST_UPDATE_DATE2"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_ADDITIONAL_INFO2"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_NAME3"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_ID3"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_CREATION_DATE3"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_LAST_UPDATE_DATE3"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_ADDITIONAL_INFO3"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_NAME4"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_ID4"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_CREATION_DATE4"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_LAST_UPDATE_DATE4"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_ADDITIONAL_INFO4"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_NAME5"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_ID5"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_CREATION_DATE5"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_LAST_UPDATE_DATE5"></entry>
	  <entry name="EXTERNAL_PAYMENT_PROVIDER_ADDITIONAL_INFO5"></entry>
	</row>
  </report-entries>

</report-data>
      ]]>
    </reportoutput>

    <numberofrows>1</numberofrows>
  </serviceresponse>
</praxellmessage>