New-Card

NewCard

The New Card API creates a new card for the given cardholder. The card will be sent through fullfilemnt (probably post mail) and its number and account are created in realtime. Card physical creation is done once, daily, by a batch file sent to the fulfillment house. The API contains all data relevant to cardholder (as address, city, etc).

Input Parameters:

Name
Required
Definition
Comments

AddressLine1

Y

Format: Alphanumeric, 1-30 Can contains as well all special characters beside: <, >

AddressLine2

N

Format: Alphanumeric, 1-30 Can contains as well all special characters beside: <, >

CampaignCode

N

Format: Alphanumeric, 1-120

City

Y

Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period, &

DateOfBirth

Y

Format: yyyy-mm-dd Description: Cardholder must be above 17 years old

DocExpirationDate

C

Format: YYYY-MM-DD Description: must be after DocIssueDate. Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'

Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN' AND SecondaryCard param exist and is different than “Y”

DocId

Y

Format: Alphanumeric, 3-16 Description: ID number of the government identification document used (defined in DocType)

DocIssueDate

C

Format: YYYY-MM-DD Description: must be before DocExpirationDate Conditional value required only when DocType is 'PASS' or 'MCN'

Conditional value required only when DocType is 'PASS' or 'MCN' AND SecondaryCard param exist and is different than “Y”

DocIssuer

C

Format: Alphanumeric, 2 Description: Country/State code. Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'

Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN' AND SecondaryCard param exist and is different than “Y”

DocType

Y

Format options: SSN PASS UDL MCN INMATE 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.

Email

N

Format General o An email address is made up of a local part, an @ symbol, then a domain part (XXXXX@XXXXX) o Full Email Address Maximum Size: 254 chars o Local part & domain consist of labels separated by dots — Each label max size is 64 — Two successive dots are forbidden — mail cannot start or end with a dot — Labels cannot not start with a hyphen, end with a hyphen, or contain two successive hyphens. Local part o Size: 1-64 chars o Allowed Chars: a-z, A-Z, 0-9, and special characters: - _ . ~ ! ' * Domain part o Size: 1-251 chars o Allowed Chars: a-z, A-Z, 0-9, and special characters: - _ .

EnrollCashback

N

Format:Y/N

EnrollMailNotification

N

Format:Y/N

Fax

N

Format: Numeric, 6-10 Description: the fax number.

FirstName

Y

Format: Alpha, 2-50 Can contains as well these special characters: /, -, space, comma, period, &

IsReceiveSms

N

Format options: Enabled (the cardholder has requested to receive an SMS for transactions and therefore he get SMS's) Disabled (the cardholder has requested to not receive an SMS for transactions and therefore he does not get SMS's) Blank (the cardholder has not requested to receive an SMS for transactions and therefore he does not get SMS's) Mail (the cardholder has requested to receive an mail for transactions and therefore he get mails) Description:Defines if the cardholder gets an SMS/Mail.

LastName

Y

Format: Alpha, 2-50 Can contains as well these special characters: /, -, space, comma, period, &

Latitude

N

Format: Alphanumeric, Comma, Dot, "-", 1-8 (can be 40.71435) Description: Latitude can range between 0 and 90 degrees, and can be north or south. (Zero degrees latitude is neither north nor south.) The North Pole is at 90° north latitude; the South Pole is at 90° south latitude. The Equator is at zero degrees latitude.

Longitude

N

Format: Alphanumeric, Comma, Dot, "-", 1-9 (can be -74.00597) Description: Longitude can range between 0 and 180 degrees, and can be east or west. (Zero and 180 degrees longitude are neither east nor west.) The Greenwich Meridian, which passes through the United Kingdom, is at zero degrees longitude (unlike zero degrees latitude, the zero point for longitude is just an arbitrary choice, made for historical reasons).

MiddleInitial

N

Format: Alpha,1 Description: Middle name char of the cardholder.

MobilePhone

C

Format: Numeric, 6-10 Description: Mobile Phone number

MobilePhone is required only if IsReceiveSms=Enabled

Phone

Y

Format: Numeric, 6-10 Description: Phone number

ProductTypeName

C

Format: Alphanumeric, 1-120 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.

It is not required and not relevant if Secondary Card param is Y. Otherwise, it is required

ReferralCode

N

Format: Alphanumeric, 1-120

SecondaryCard

N

Format: Y/N (default)

ShippingAddressLine1

C

Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >

relevant if UseShippingDetails=Y

ShippingAddressLine2

C

Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >

relevant if UseShippingDetails=Y

ShippingCity

C

Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period,

relevant if UseShippingDetails=Y

ShippingState

C

Format: Alphanumeric, 2

relevant if UseShippingDetails=Y

ShippingZIP

C

Format: Numeric, 5

relevant if UseShippingDetails=Y

SkipVerification

N

Format Options: Y/N (default: N) Description: Allow to skip verification attempt done by API. in such cases, the cardholder will be created in RNV (Registered Not Verified) mode

State

Y

Format: Alphanumeric, 2

Title

Y

Format: List “Ms.”, “Mr.”

Token

N

Format: Number, 6 Description: Six digits value (should be unique for a period of N minutes (where N is a system parameter)

UserDefined1

N

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

UserDefined2

N

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

UserDefined3

N

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

UserDefined4

N

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

UserDefined5

N

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

UserDefined6

N

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

UserDefined7

N

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

UserDefined8

N

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

UserDefined9

N

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

UserDefined10

N

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

UserDefined11

N

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

UserDefined12

N

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

UserDefined13

N

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

UserDefined14

N

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

UserDefined15

N

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

UseShippingDetails

N

Format: Y/N (default)

Zip

Y

Format: Numeric, 5

CardDDA

Format: Numeric, 3-16

RoutingNumber

Format: Numeric,16

Output Parameters:

Name
Definition
Failure Case
Success Case
Comments

CardDDA

Format: Numeric, 3-16

Not returned

Returned

CardHolderState (New Card)

Format options: V V-PNS RNV

Not returned

Returned

CardNumber

Format: Numeric, 16

Not returned

Returned

RPID

Format: Numeric, 1-19

Not returned

Returned

VerificationID

Format: Alphanumeric, 50

Not returned

Returned

VerificationStatus

Format options: If CH is verified, the options are: VerifiedSSN VerifiedByIssuer If CH is not verified, the options are: SSNVerificationRequired (if DocType is SSN & SkipVerification=Y) DocumentaryVerificationRequired (if DocType is SSN & SkipVerification=N) DocumentaryVerificationRequired (if DocType is not SSN)

Not returned

Returned

in current New Card version, only SSN is supported as DocType

XML Samples

<?xml version="1.0" ?>
<PraxellXMLRequest>
    <AuthenticationDetails>
        <UserName>Keren_Full_QA</UserName>
        <UserPassword></UserPassword>
      <ClientSourceIP></ClientSourceIP> 
 </AuthenticationDetails>
    <ServiceDetails>
        <UniqueRequestId></UniqueRequestId>
        <ServiceName>NewCard</ServiceName>
    </ServiceDetails>
    <Origin>
        <OriginType>ExtAPI</OriginType>
    </Origin>
    <ServiceParams>
        <FirstName>Keren</FirstName>
        <MiddleInitial>M</MiddleInitial>
        <LastName>Aharon</LastName>
        <AddressLine1>33 Hayetzira st.</AddressLine1>
        <AddressLine2>PO Box 1234</AddressLine2>
        <City>Tel Aviv</City>
        <State>OH</State>
        <Zip>45251</Zip>
        <Fax>036126066</Fax>
        <Phone>1114257999</Phone>
        <MobilePhone>9876543219</MobilePhone>
        <DateOfBirth>1978-04-08</DateOfBirth>
        <Email>qa@praxell.com</Email>
        <DocExpirationDate></DocExpirationDate>
        <DocId>231231231</DocId>
        <DocIssueDate></DocIssueDate>
        <DocIssuer></DocIssuer>
        <DocType>SSN</DocType>
        <ProductTypeName>Keren NFF Cards</ProductTypeName>
        <IsReceiveSms>Enabled</IsReceiveSms>
        <ShippingAddressLine1></ShippingAddressLine1>
        <ShippingAddressLine2></ShippingAddressLine2>
        <ShippingCity></ShippingCity>
        <ShippingState></ShippingState>
        <ShippingZIP></ShippingZIP>
        <SkipVerification>N</SkipVerification>
        <UserDefined1></UserDefined1>
        <UserDefined2></UserDefined2>
        <UserDefined3></UserDefined3>
        <UserDefined4></UserDefined4>
        <UserDefined5></UserDefined5>
        <UserDefined6></UserDefined6>
        <UserDefined7></UserDefined7>
        <UserDefined8></UserDefined8>
        <UserDefined9></UserDefined9>
        <UserDefined10></UserDefined10>
        <UserDefined11></UserDefined11>
        <UserDefined12></UserDefined12>
        <UserDefined13></UserDefined13>
        <UserDefined14></UserDefined14>
        <UserDefined15></UserDefined15>
        <UseShippingDetails></UseShippingDetails>
        <CampaignCode></CampaignCode>
        <EnrollCashback></EnrollCashback>
        <EnrollMailNotification></EnrollMailNotification>
        <Latitude></Latitude>
        <Longitude></Longitude>
        <ReferralCode></ReferralCode>
        <Title></Title>
        <Token></Token>
    </ServiceParams>
</PraxellXMLRequest>
<?xml version="1.0" ?> 
 <PraxellXMLResponse>
  <ResponseDetails>
   <ServiceName>NewCard</ServiceName> 
   <SessionId>46144416201108060</SessionId> 
   <StatusCode>0</StatusCode> 
   <StatusName>StatusOK</StatusName> 
   <StatusDescription>NA</StatusDescription> 
   <ServiceDate>2021-06-30 16:08:05</ServiceDate> 
   <ServiceId>46144416201108060</ServiceId> 
  </ResponseDetails>
  <ResponseParams>
   <CardNumber></CardNumber> 
   <CardDDA>0</CardDDA> 
   <CardHolderState>V-PNS</CardHolderState> 
   <VerificationID>9772761</VerificationID> 
   <VerificationStatus>VerifiedSSN</VerificationStatus> 
   <RPID>9800000051</RPID> 
   </ResponseParams>
  </PraxellXMLResponse>
<?xml version="1.0"?>
<PraxellXMLResponse>
     <ResponseDetails>
        <ServiceName>NewCard</ServiceName>
        <SessionId>38553811201107063</SessionId>
        <StatusCode>70064</StatusCode>
        <StatusName>Invalid Product Type</StatusName>
        <StatusDescription>NA</StatusDescription>
        <ServiceDate>2021-02-23 11:07:39</ServiceDate>
        <ServiceId>38553811201107063</ServiceId>
    </ResponseDetails>
</PraxellXMLResponse>

Last updated