# Close-Card

## Close Card

The Close Card API allows closing a card.

## Input Parameters:

| Name       | Required | Definition                                                                                                                                                                                                                                                                                         | Comments                                  |
| ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| CardNumber | C        | Format: Numeric, 16                                                                                                                                                                                                                                                                                | Deprecated. Will be removed in the future |
| ID         | C        | <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     | C        | <p>Format options:<br>CardNumber<br>RPID<br>SavingAccount</p>                                                                                                                                                                                                                                      |                                           |
| ReasonCode | N        | <p>Format options:<br>CardExpired<br>CardReplaced<br>CIPException<br>CloseCardForDispute<br>Closed<br>ClosedByPM<br>Deceased<br>Excess-Chargeback<br>InsufficientKYC<br>InvalidArrowEyefiles<br>NegativeWriteOff<br>POBox<br>PrePurge<br>PurgedCard<br>PurgedFailedAtProcessor<br>ReadyToPrint</p> |                                           |

## Output Parameters:

| Name             | Definition          | Failure Case | Success Case | Comments |
| ---------------- | ------------------- | ------------ | ------------ | -------- |
| AvailableBalance | Format: Numeric, 11 | Not returned | Returned     |          |

## XML Samples

### Input XML

```json
<?xml version="1.0"?>
<PraxellXMLRequest>
  <AuthenticationDetails>
    <UserName>Yair_CSR_PM</UserName>
    <UserPassword>1q2w3e4r</UserPassword>
    <ClientSourceIP></ClientSourceIP> 
 </AuthenticationDetails>;
  <ServiceDetails>
    <UniqueRequestId>2598800</UniqueRequestId>
    <ServiceName>CloseCard</ServiceName>
  </ServiceDetails>
  <Origin>
    <OriginType>ExtAPI</OriginType>
  </Origin>
  <ServiceParams>
    <ID></ID>
    <IDType></IDType>
  </ServiceParams>
</PraxellXMLRequest>
```

```json
<PraxellXMLResponse>
 <ResponseDetails>
  <ServiceName>CloseCard</ServiceName>
  <SessionId>29833008200807032</SessionId>
  <StatusCode>0</StatusCode>
  <StatusName>StatusOK</StatusName>
  <StatusDescription>NA</StatusDescription>
  <ServiceDate>2008-03-11 08:07:20</ServiceDate>
  <ServiceId>29833008200807032</ServiceId>
 </ResponseDetails> 
 <ResponseParams>
  <AvailableBalance>902</AvailableBalance>
 </ResponseParams>
</PraxellXMLResponse>
```

```json
<?xml version="1.0"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>CloseCard</ServiceName>
    <SessionId>07071612200737105</SessionId>
    <StatusCode>70000</StatusCode>
    <StatusName>Processor error</StatusName>
    <StatusDescription>Processor error</StatusDescription>
    <ServiceDate>2021-10-01 12:37:50</ServiceDate>
    <ServiceId>07071612200737105</ServiceId>
  </ResponseDetails>
  <ResponseParams>
  </ResponseParams>
</PraxellXMLResponse>
```