Get Card Holds

Get Card Holds

The Get Card Holds API provides a list of existing holds for a specific card.

Input Parameters:

Name	Required	Definition	Comments
ID	Y	Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
IDType	Y	Format options: CardNumber RPID SavingAccount
Status	N	Format: ACTIVE (default) ALL

Output Parameters:

Name	Definition	Failure Case	Success Case	Comments
ActiveHoldsTotalAmount	Format: Numeric, 11 Description: Total amount of all active holds existing for Cardholder	Not returned	Returned
Amount	Format: Numeric, 1-9 Description: The amount is in cents.	Not returned	Returned	Returned as part of Holds/Hold tag
Date	Format: YYYY-MM-DD	Not returned	Returned	Returned as part of Holds/Hold tag
ExpirationDate	Format: MMYY	Not returned	Returned	Returned as part of Holds/Hold tag
HoldAccountNumber	Format: Alphanumeric, 11	Not returned	Returned	Returned as part of Holds/Hold tag
HoldAccountType	Format: Alphanumeric, 1	Not returned	Returned	Returned as part of Holds/Hold tag
HoldCardNumber	Format: Numeric, 4 Description: XXXX-XXXX-XXXX-1234	Not returned	Returned	Returned as part of Holds/Hold tag
HoldsNumber	Format: Numeric, 11	Not returned	Returned
Merchant	Format: Alphanumeric, 25	Not returned	Returned	Returned as part of Holds/Hold tag
MerchantCategoryCode	Format: Alphanumeric, 4	Not returned	Returned	Returned as part of Holds/Hold tag
ReferenceNumber	Format: Alphanumeric, 32	Not returned	Returned	Returned as part of Holds/Hold tag
Status	Format: ACTIVE (default) ALL	Not returned	Returned	Returned as part of Holds/Hold tag
Time	Format: HH:MM:SS	Not returned	Returned	Returned as part of Holds/Hold tag
Terminal	Format: Alphanumeric, 8	Not returned	Returned	Returned as part of Holds/Hold tag

XML Samples

Input XML

<?xml version="1.0"?>
<PraxellXMLRequest>
  <AuthenticationDetails>
    <UserName></UserName>
    <UserPassword></UserPassword>
    <ClientSourceIP></ClientSourceIP> 
 </AuthenticationDetails>;
  <ServiceDetails>
    <ServiceName>GetCardHolds</ServiceName>
    <UniqueRequestId></UniqueRequestId>
  </ServiceDetails>
  <Origin>
    <OriginType></OriginType>
  </Origin>
  <ServiceParams>
   <ID></ID>
   <IDType></IDType> 
   <Status></Status> 
  </ServiceParams>
</PraxellXMLRequest>

<?xml version="1.0"?>
<PraxellXMLResponse>
     <ResponseDetails>
        <ServiceName>GetCardHolds</ServiceName>
        <SessionId>40707619200940113</SessionId>
        <StatusCode>0</StatusCode>
        <StatusName>StatusOK</StatusName>
        <StatusDescription>NA</StatusDescription>
        <ServiceDate>2009-11-25 19:40:38</ServiceDate>
        <ServiceId>40707619200940113</ServiceId>
    </ResponseDetails>
    <ResponseParams>
        <ActiveHoldsTotalAmount>120865</ActiveHoldsTotalAmount>
        <HoldsNumber>03</HoldsNumber>
        <Holds>
            <Hold>
                <Date>2009-10-25</Date>
                <Time>08:00:07</Time>
                <Terminal>NA</Terminal>
                <Merchant>PLAZA BAGELS AND DELI</Merchant>
                <Amount>0.05</Amount>
                <ExpirationDate>10/28/2009</ExpirationDate>
                <Status>A</Status>
                <ReferenceNumber>202959</ReferenceNumber>
                <HoldAccountNumber>91030093856</HoldAccountNumber>
                <HoldAccountType>D</HoldAccountType>
                <HoldCardNumber>9999999999998060</HoldCardNumber>
                <MerchantCategoryCode>5812</MerchantCategoryCode>
            </Hold>
            <Hold>
                <Date>2009-10-25</Date>
                <Time>07:19:53</Time>
                <Terminal>NA</Terminal>
                <Merchant>KINGS SUPERMKTS #46</Merchant>
                <Amount>3.60</Amount>
                <ExpirationDate>11/03/2009</ExpirationDate>
                <Status>A</Status>
                <ReferenceNumber>010282</ReferenceNumber>
                <HoldAccountNumber>91030093856</HoldAccountNumber>
                <HoldAccountType>D</HoldAccountType>
                <HoldCardNumber>9999999999998060</HoldCardNumber>
                <MerchantCategoryCode>5411</MerchantCategoryCode>
            </Hold>
            <Hold>
                <Date>2009-10-25</Date>
                <Time>06:52:26</Time>
                <Terminal>NA</Terminal>
                <Merchant>TIRE TECH &amp; AUTO REPAI</Merchant>
                <Amount>1205.00</Amount>
                <ExpirationDate>11/03/2009</ExpirationDate>
                <Status>A</Status>
                <ReferenceNumber>004246</ReferenceNumber>
                <HoldAccountNumber>91030093856</HoldAccountNumber>
                <HoldAccountType>D</HoldAccountType>
                <HoldCardNumber>9999999999998060</HoldCardNumber>
                <MerchantCategoryCode>5541</MerchantCategoryCode>
            </Hold>
        </Holds>
    </ResponseParams>
</PraxellXMLResponse>

<?xml version="1.0"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>GetCardHolds</ServiceName>
    <SessionId>07071612200737105</SessionId>
    <StatusCode>70029</StatusCode>
    <StatusName>Data not found (cardholder not found)</StatusName>
    <StatusDescription>Data not found (cardholder not found)</StatusDescription>
    <ServiceDate>2021-10-01 12:37:50</ServiceDate>
    <ServiceId>07071612200737105</ServiceId>
  </ResponseDetails>
  <ResponseParams>
  </ResponseParams>
</PraxellXMLResponse>