# 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        | <p>Format: Numeric, 1-19<br>Description:<br>Input should be RPID in case IDType = RPID<br>Input should be Card Number in case IDType = CardNumber</p> |          |
| IDType | Y        | <p>Format options:<br>CardNumber<br>RPID<br>SavingAccount</p>                                                                                         |          |
| Status | N        | <p>Format:<br>ACTIVE (default)<br>ALL</p>                                                                                                             |          |

## Output Parameters:

| Name                   | Definition                                                                                          | Failure Case | Success Case | Comments                           |
| ---------------------- | --------------------------------------------------------------------------------------------------- | ------------ | ------------ | ---------------------------------- |
| ActiveHoldsTotalAmount | <p>Format: Numeric, 11<br>Description: Total amount of all active holds existing for Cardholder</p> | Not returned | Returned     |                                    |
| Amount                 | <p>Format: Numeric, 1-9<br>Description: The amount is in cents.</p>                                 | 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         | <p>Format: Numeric, 4<br>Description: XXXX-XXXX-XXXX-1234</p>                                       | 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                 | <p>Format:<br>ACTIVE (default)<br>ALL</p>                                                           | 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

```json
<?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>
```

```json
<?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>
```

```json
<?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>
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidocs.juicefin.com/apis/card-status-and-management/get-card-holds.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.