# Suspend Card

## Suspend Card

The Suspend Card API suspends a card.

*Beginning on 10/15/2023, The Suspend Card API has been enhanced to accept RPID in addition to the standard CardNumber. While the API traditionally requires CardNumber, it now accommodates an alternative identifier: by including the IDType, you can specify RPID to utilize RPID for identification within the API.*

## 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>                                                                                                                                                                                                                                                                                                                                                                                                                      |                                           |
| Description    | N        | Format: Alphanumeric, 1-30                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                           |
| ReasonCode     | Y        | <p>Format options:<br>Arbitration<br>ByPM<br>CIPExceptionSus<br>Confirmed Fraud<br>Dispute<br>Lost<br>Lost-Stolen<br>Other<br>Poss Fraud<br>Poss Fraud Warm Address<br>Poss Fraud Warm Source IP<br>PrimaryCardSuspension<br>ProcSuspectedFraudWithNotes<br>ReDisputed<br>ReplaceFailure<br>ReplacementCardRequired<br>Represented<br>Stolen<br>StoreError<br>SuspectedFraud<br>TransactionCompletenessException<br>UnactivatedCard<br>UnactivatedReplacementCard<br>Violation</p> |                                           |
| ReasonCodeType | C        | <p>Format options:<br>LN DefinitionViolation<br>SystemViolation<br>PeriodViolation<br>BalanceViolation</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>test_pm</UserName>
    <UserPassword>test_pm</UserPassword>
    <ClientSourceIP></ClientSourceIP> 
 </AuthenticationDetails>; 
  <ServiceDetails>
      <ServiceName>SuspendCard</ServiceName>
      <UniqueRequestId>1212121212121213</UniqueRequestId>
   </ServiceDetails>
   <Origin>
       <OriginType>ExtAPI</OriginType>
   </Origin>
   <ServiceParams>
    <ID></ID>
    <IDType></IDType>
    <Description></Description>
    <ReasonCode>Lost</ReasonCode>
    <CardNumber></CardNumber>
  </ServiceParams>
</PraxellXMLRequest>
```

```json
<?xml version="1.0"?>
<PraxellXMLResponse>
    <ResponseDetails>
        <ServiceName>SuspendCard</ServiceName>
        <SessionId>05200637022706028152</SessionId>
        <StatusCode>0</StatusCode>
        <StatusName>StatusOK</StatusName>
        <StatusDescription>NA</StatusDescription>
        <ServiceDate>2007-05-27 06:17:54</ServiceDate>
        <ServiceId>05200637022706028152</ServiceId>
    </ResponseDetails>
    <ResponseParams>
        <AvailableBalance>1999</AvailableBalance>
    </ResponseParams>
</PraxellXMLResponse>
```

```json
<?xml version="1.0"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>SuspendCard</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>
```