# Instant-Issue-Card

## InstantIssueCard

The Instant Issue Card API performs enablement by card number for cards, which are anonymous. In addition, the API gets cardholder registration details and register an existing anonymous card to that cardholder.

## Input Parameters:

| Name                     | Required | Definition                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Comments                                             |
| ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| AddressLine1             | Y        | <p>Format: Alphanumeric, 1-30<br>Can contains as well all special characters beside: <, ></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                      |
| AddressLine2             | N        | <p>Format: Alphanumeric, 1-30<br>Can contains as well all special characters beside: <, ></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                      |
| Amount                   | N        | <p>Format: Numeric, 1-9<br>Description: The amount is in cents.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                      |
| CardNumber               | C        | Format: Numeric, 16                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                      |
| City                     | Y        | <p>Format: Alpha, 1-20<br>Can contains as well these special characters: /, -, space, comma, period, &</p>                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                      |
| Country                  | Y        | <p>Format: ISO Country code. Two characters.<br>Description: Based on ISO 3166-1 alpha-2 list.<br><http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2></p>                                                                                                                                                                                                                                                                                                                                                                                      | Value "US" expected                                  |
| DateOfBirth              | Y        | <p>Format: yyyy-mm-dd<br>Description: Cardholder must be above 17 years old</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                      |
| Description              | N        | Format: Alphanumeric, 1-30                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                      |
| DocExpirationDate        | C        | <p>Format: YYYY-MM-DD<br>Description: must be after DocIssueDate.<br>Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'</p>                                                                                                                                                                                                                                                                                                                                                                                          |                                                      |
| DocId                    | Y        | <p>Format: Alphanumeric, 3-16<br>Description: ID number of the government identification document used (defined in DocType)</p>                                                                                                                                                                                                                                                                                                                                                                                                              |                                                      |
| DocIssueDate             | C        | <p>Format: YYYY-MM-DD<br>Description: must be before DocExpirationDate<br>Conditional value required only when DocType is 'PASS' or 'MCN'</p>                                                                                                                                                                                                                                                                                                                                                                                                |                                                      |
| DocIssuer                | C        | <p>Format: Alphanumeric, 2<br>Description: Country/State code.<br>Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'</p>                                                                                                                                                                                                                                                                                                                                                                                             |                                                      |
| DocType                  | Y        | <p>Format options:<br>SSN<br>PASS<br>UDL<br>MCN<br>INMATE<br>Description: Closed list of values.Type of government identification document used: SSN- Social Security Number, PASS - Passport number, 'UDL' – US Drivers license number,'MCN' - Matricula consular ,INMATE.</p>                                                                                                                                                                                                                                                              |                                                      |
| Email                    | N        | <p>Format: a-z (upper or lower), numbers, dash and underscore, 5-40<br>Description: Possible pattern: <x@x.x></p>                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                      |
| Fax                      | N        | <p>Format: Numeric, 6-10<br>Description: the fax number.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                      |
| FirstName                | Y        | <p>Format: Alpha, 2-50<br>Can contains as well these special characters: /, -, space, comma, period, &</p>                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                      |
| IsReceiveSms             | N        | <p>Format options:<br>Enabled (the cardholder has requested to receive an SMS for transactions and therefore he get SMS's)<br>Disabled (the cardholder has requested to not receive an SMS for transactions and therefore he does not get SMS's)<br>Blank (the cardholder has not requested to receive an SMS for transactions and therefore he does not get SMS's)<br>Mail (the cardholder has requested to receive an mail for transactions and therefore he get mails)<br><br>Description:Defines if the cardholder gets an SMS/Mail.</p> |                                                      |
| IssueWithoutVerification | N        | <p>Format: Y/N<br>Description: Allows to issue a card without verification.<br>Closed list values</p>                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                      |
| LastName                 | Y        | <p>Format: Alpha, 2-50<br>Can contains as well these special characters: /, -, space, comma, period, &</p>                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                      |
| MiddleInitial            | N        | <p>Format: Alpha,1<br>Description: Middle name char of the cardholder.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                      |
| MobilePhone              | C        | <p>Format: Numeric, 6-10<br>Description: Mobile Phone number</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | MobilePhone is required only if IsReceiveSms=Enabled |
| OOWAnswer                | C        | Field:TBD                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | future                                               |
| OOWQuestionType          | N        | Field:TBD                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | future                                               |
| OperationType            | N        | <p>Format options:<br>CardNumber<br>RPID</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                      |
| Phone                    | Y        | <p>Format: Numeric, 6-10<br>Description: Phone number</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                      |
| ReturnOOWQuestions       | N        | Format: Y/N (N is default).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | future                                               |
| RPID                     | C        | Format: Numeric, 1-19                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                      |
| ShippingAddressLine1     | Y        | <p>Format: Alphanumeric, 30<br>Can contains as well all special characters beside: <, ></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                      |
| ShippingAddressLine2     | Y        | <p>Format: Alphanumeric, 30<br>Can contains as well all special characters beside: <, ></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                      |
| ShippingCity             | Y        | <p>Format: Alpha, 1-20<br>Can contains as well these special characters: /, -, space, comma, period,</p>                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                      |
| ShippingState            | Y        | Format: Alphanumeric, 2                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                      |
| ShippingZIP              | Y        | Format: Numeric, 5                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                      |
| SkipVerification         | N        | <p>Format Options: Y/N (default: N)<br>Description: Allow to skip verification attempt done by API. in such cases, the cardholder will be created in RNV (Registered Not Verified) mode</p>                                                                                                                                                                                                                                                                                                                                                  |                                                      |
| State                    | Y        | Format: Alphanumeric, 2                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                      |
| UserDefined1             | N        | <p>Format:<br>Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'<br>Size: 255</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                      |
| UserDefined2             | N        | <p>Format:<br>Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'<br>Size: 255</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                      |
| UserDefined3             | N        | <p>Format:<br>Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'<br>Size: 255</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                      |
| UserDefined4             | N        | <p>Format:<br>Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'<br>Size: 255</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                      |
| UserDefined5             | N        | <p>Format:<br>Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'<br>Size: 255</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                      |
| UserDefined6             | N        | <p>Format:<br>Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'<br>Size: 255</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                      |
| UserDefined7             | N        | <p>Format:<br>Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'<br>Size: 255</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                      |
| UserDefined8             | N        | <p>Format:<br>Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'<br>Size: 255</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                      |
| UserDefined9             | N        | <p>Format:<br>Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'<br>Size: 255</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                      |
| UserDefined10            | N        | <p>Format:<br>Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'<br>Size: 255</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                      |
| UserDefined11            | N        | <p>Format:<br>Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'<br>Size: 255</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                      |
| UserDefined12            | N        | <p>Format:<br>Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'<br>Size: 255</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                      |
| UserDefined13            | N        | <p>Format:<br>Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'<br>Size: 255</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                      |
| UserDefined14            | N        | <p>Format:<br>Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'<br>Size: 255</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                      |
| UserDefined15            | N        | <p>Format:<br>Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'<br>Size: 255</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                      |
| UseShippingDetails       | Y        | Format: Y/N (default)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                      |
| VerifyByIssuer           | Y        | Format: Y/N (default)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | future                                               |
| Zip                      | Y        | Format: Numeric, 5                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                      |

## Output Parameters:

| Name                          | Definition                                                                                                                                                                                                                                                                                                                                                 | Failure Case | Success Case | Comments     |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | ------------ |
| BankRoutingNumber             | Format: Alphanumeric, 9                                                                                                                                                                                                                                                                                                                                    | Not returned | Returned     |              |
| CardHolderState               | <p>Format options:<br>V<br>V-PNS<br>RNV<br>NRNV</p>                                                                                                                                                                                                                                                                                                        | Not returned | Returned     |              |
| CardNumber                    | Format: Numeric, 16                                                                                                                                                                                                                                                                                                                                        | Not returned | Returned     |              |
| DDA                           | Format: Numeric, 3-16                                                                                                                                                                                                                                                                                                                                      | Not returned | Returned     |              |
| OOWEligible                   | Format: Y/N                                                                                                                                                                                                                                                                                                                                                | Not returned | Returned     |              |
| ProductTypeName               | <p>Format: Alphanumeric, 1-120<br>Description: Each sub program in Praxell consists of one or more product types. A product type is a set of attributes that are applied to the cards that belong to this product type. The ProductTypeName field is the name of the product used when creating and issuing cards.</p>                                     | Not returned | Returned     |              |
| VerificationAttempts          | Format: Numeric, 2                                                                                                                                                                                                                                                                                                                                         | Not returned | Returned     |              |
| VerificationID                | Format: Alphanumeric, 50                                                                                                                                                                                                                                                                                                                                   | Not returned | Returned     |              |
| VerificationStatus            | <p>Format options:<br>If CH is verified, the options are:<br>VerifiedSSN<br>VerifiedByIssuer<br><br>If CH is not verified, the options are:<br>SSNVerificationRequired (if DocType is SSN & SkipVerification=Y)<br>DocumentaryVerificationRequired (if DocType is SSN & SkipVerification=N)<br>DocumentaryVerificationRequired (if DocType is not SSN)</p> | Not returned | Returned     |              |
| CardAvailableBalance          | Format: Numeric, 11                                                                                                                                                                                                                                                                                                                                        | Not returned | Returned     |              |
| RPID                          | Format: Numeric, 1-19                                                                                                                                                                                                                                                                                                                                      | Not returned | Returned     |              |
| IVRPhoneNumber                | Format: Numeric, 6-15                                                                                                                                                                                                                                                                                                                                      | Not returned | Returned     |              |
| ProgramURL                    | Format: Alphanumeric, 1000 (including ? : . )                                                                                                                                                                                                                                                                                                              | Not returned | Returned     |              |
| FeeAmount                     | Format: Numeric, 10                                                                                                                                                                                                                                                                                                                                        | Not returned | Returned     | Fees.Fee tag |
| ContextTransactionDescription | Format: Alphanumeric, 80                                                                                                                                                                                                                                                                                                                                   | Not returned | Returned     | Fees.Fee tag |
| ContextTransactionType        | Format: List of values: Credit, Debit                                                                                                                                                                                                                                                                                                                      | Not returned | Returned     | Fees.Fee tag |
| FeeAmount                     | Format: Numeric, 10                                                                                                                                                                                                                                                                                                                                        | Not returned | Returned     | Fees.Fee tag |
| FailedFee                     | Format: Y/N. Provide yes if there are some fees which are not taken for any reason                                                                                                                                                                                                                                                                         | Not returned | Returned     | Fee tag      |

## XML Samples

### Input XML

```json
<?xml version="1.0" ?>
<PraxellXMLRequest>
     <AuthenticationDetails>
	<UserName>hccne_fb_QA</UserName>
	<UserPassword>1q2w3e4r</UserPassword>
      <ClientSourceIP></ClientSourceIP>
 </AuthenticationDetails>
       <ServiceDetails>
	 <ServiceName>InstantIssueCard</ServiceName>
        <UniqueRequestId>5435435436</UniqueRequestId>
    </ServiceDetails>
        <Origin>
            <OriginType>Portal:pdp</OriginType>
        </Origin>
    <ServiceParams>
        <AddressLine1>fail</AddressLine1>
        <AddressLine2></AddressLine2>
        <Amount>10495</Amount>
        <CardNumber></CardNumber>
        <City>sdfsdf</City>
        <Country>US</Country>
        <DateOfBirth>1980-01-01</DateOfBirth>
        <Description></Description>
        <DocExpirationDate></DocExpirationDate>
        <DocId>231231231</DocId>
        <DocIssueDate></DocIssueDate>
        <DocIssuer></DocIssuer>
        <DocType>SSN</DocType>
        <Email></Email>
        <Fax></Fax>
        <FirstName>sdfsdfsdf</FirstName>
        <IsReceiveSms></IsReceiveSms>
        <IssueWithoutVerification>N</IssueWithoutVerification>
        <LastName>sdsdfsdf</LastName>
        <MiddleInitial></MiddleInitial>
        <MobilePhone></MobilePhone>
        <OperationType>CardNumber</OperationType>
        <Phone>2342342234</Phone>
        <RPID></RPID>
        <ShippingAddressLine1></ShippingAddressLine1>
        <ShippingAddressLine2></ShippingAddressLine2>
        <ShippingCity></ShippingCity>
        <ShippingState></ShippingState>
        <ShippingZIP></ShippingZIP>
        <SkipVerification></SkipVerification>
        <State>AL</State>
        <VerifyByIssuer>Y</VerifyByIssuer>
        <UseShippingDetails>234234234</UseShippingDetails>
        <Zip>234234234</Zip>
   </ServiceParams>
</PraxellXMLRequest>
```

```json
<?xml version="1.0"?>
<PraxellXMLResponse>
     <ResponseDetails>
        <ServiceName>InstantIssueCard</ServiceName>
        <SessionId>38553811201107063</SessionId>
        <StatusCode>0</StatusCode>
        <StatusName>StatusOK</StatusName>
        <StatusDescription>NA</StatusDescription>
        <ServiceDate>2011-06-29 11:07:39</ServiceDate>
        <ServiceId>38553811201107063</ServiceId>
    </ResponseDetails>
<ResponseParams>
    <BankRoutingNumber></BankRoutingNumber>
    <CardNumber></CardNumber>
    <CardHolderState>V-PNS</CardHolderState>
    <DDA></DDA>
    <ProductTypeName></ProductTypeName>
    <VerificationID>9772761</VerificationID>
    <VerificationStatus>VerifiedSSN</VerificationStatus>
    <VerificationAttempts>1</VerificationAttempts>
    <OOWEligible>N</OOWEligible>
    <CardAvailableBalance></CardAvailableBalance>
    <RPID></RPID>
    <IVRPhoneNumber></IVRPhoneNumber>
    <ProgramURL></ProgramURL>
    <Fees>
    <Fee>
    <FeeAmount></FeeAmount>
    <ContextTransactionDescription></ContextTransactionType>
    <ContextTransactionType></ProductTypeName>
    <FeeAmount></FeeAmount>
    </Fee>
    </Fees>
    <Fee>
    <FailedFee></FailedFee>
    </Fee>
    <ProductTypeName></ProductTypeName>
</ResponseParams>
</PraxellXMLResponse>
```

```json
<?xml version="1.0"?>
<PraxellXMLResponse>
     <ResponseDetails>
        <ServiceName>InstantIssueCard</ServiceName>
        <SessionId>38553811201107063</SessionId>
        <StatusCode>70000</StatusCode>
        <StatusName>Processor error</StatusName>
        <StatusDescription>NA</StatusDescription>
        <ServiceDate>2021-02-23 11:07:39</ServiceDate>
        <ServiceId>38553811201107063</ServiceId>
    </ResponseDetails>
</PraxellXMLResponse>
```