Update Cardholder

Update Cardholder

The Update Cardholder API produces updates of cardholder details.

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: <, >

CardAnniversaryDate

N

Format: YYYY-MM-DD

Future

CardNumber

Y

Format: Numeric, 16

City

Y

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

Country

Y

Format: ISO Country code. Two characters. Description: Based on ISO 3166-1 alpha-2 list. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

DateOfBirth

N

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'

DocId

N

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'

DocIssuer

C

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

DocType

N

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.

EarlyAccess

N

Format: Y/N

Email

N

Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern: x@x.x

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, &

MiddleInitial

N

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

MobilePhone

Y

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

Phone

N

Format: Numeric, 6-10 Description: Phone number

ShippingAddressLine1

N

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

ShippingAddressLine2

N

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

ShippingCity

N

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

ShippingState

N

Format: Alphanumeric, 2

ShippingZIP

N

Format: Numeric, 5

State

Y

Format: Alphanumeric, 2

ShouldUpdateUserDefined

Y

Format: Char (Y or N) Description: If you want to update field : Y If you don't want to update field : N

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

VerificationRequest

Y

Format options: UpdateAndVerify (allowed only when doc id type= SSN) UpdateOnly NoUpdateOnVerificationError (allowed only when doc id type = SSN)

Zip

Y

Format: Numeric, 5

Output Parameters:

Name
Definition
Failure Case
Success Case
Comments

VerificationID

Format: Alphanumeric, 50

Not returned

Returned

VerificationStatus

Format options: VerifiedSSN VerifiedThirdParty VerifiedDocumentary VerifiedByIssuer SSNVerificationRequired DocumentaryVerificationRequired OOWVerificationRequired Blank

Not returned

Returned

VerificationAttempts

Format: Numeric, 2

Not returned

Returned

QuestionSequence

Format: Numeric, 1

Not returned

Returned

Future Use

QuestionPrompt

Format: Alphanumeric, 255

Not returned

Returned

Future Use

QuestionType

Format: Alphanumeric, 255

Not returned

Returned

Future Use

AnswerOption

Format: Alphanumeric, 255

Not returned

Returned

Future Use

OOWEligible

Format: Y/N

Not returned

Returned

Future Use

FreeTextErrors

Format: Alphanumeric, 255

Not returned

Returned

CardHolderState

Format options: V V-PNS RNV NRNV

Not returned

Returned

XML Samples

Input XML

<?xml version="1.0" ?>
<PraxellXMLRequest>
    <AuthenticationDetails>
        <UserName>Eyal_PM_QA</UserName>
        <UserPassword>1q2w3e4r</UserPassword>
      <ClientSourceIP></ClientSourceIP> 
 </AuthenticationDetails>;
    <ServiceDetails>
        <ServiceName>UpdateCardholder</ServiceName>
        <UniqueRequestId>167565446597669</UniqueRequestId>
    </ServiceDetails>
    <Origin>
        <OriginType>ExtAPI</OriginType>
    </Origin>
    <ServiceParams>
        <CardNumber></CardNumber>
        <FirstName>dana</FirstName>
        <MiddleInitial>S</MiddleInitial>
        <LastName>dana</LastName>
        <AddressLine1>Questions</AddressLine1>
        <AddressLine2>lala</AddressLine2>
        <City>ACO</City>
        <State>AL</State>
        <Zip>12348</Zip>
        <Country>US</Country>
        <Phone>1234568</Phone>
        <Fax>1234568</Fax>
        <Email>sharon@gmail.com</Email>
        <IsReceiveSms>Enabled</IsReceiveSms>
        <MobilePhone>9729999994</MobilePhone>
        <DocType>SSN</DocType>
        <DocIssuer></DocIssuer>
        <DocId>123456789</DocId>
        <DateOfBirth>1944-01-20</DateOfBirth>  
        <ShippingAddressLine1></ShippingAddressLine1>
        <ShippingAddressLine2></ShippingAddressLine2>
        <ShippingCity></ShippingCity>
        <ShippingState></ShippingState>
        <ShippingZIP></ShippingZIP>
        <ShouldUpdateUserDefined>Y</ShouldUpdateUserDefined>
        <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>
        <VerificationRequest>UpdateAndVerify</VerificationRequest>
    </ServiceParams>
</PraxellXMLRequest>
<?xml version="1.0" ?>
<PraxellXMLResponse>
    <ResponseDetails>
        <ServiceName>UpdateCardholder</ServiceName>
        <SessionId></SessionId>
        <StatusCode>0</StatusCode>
        <StatusName>StatusOK</StatusName>
        <StatusDescription>NA</StatusDescription>
        <ServiceDate>2007-05-27 06:17:54</ServiceDate>
        <ServiceId>64303207200728062</ServiceId>
    </ResponseDetails>
    <ResponseParams>
        <VerificationID></VerificationID>
        <VerificationStatus></VerificationStatus>
        <VerificationAttempts></VerificationAttempts>
        <OOW>
          <OOWSet>
            <QuestionSequence></QuestionSequence>
            <QuestionPrompt></QuestionPrompt>
            <QuestionType></QuestionType>
            <AnswerOptionSet>
                <AnswerOption></AnswerOption>
            </AnswerOptionSet>
           <OOWSet>
         </OOW>
        <OOWEligible></OOWEligible>
        <FreeTextErrors></FreeTextErrors>
        <CardHolderState></CardHolderState>
    </ResponseParams>
</PraxellXMLResponse>
<?xml version="1.0"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>UpdateCardholder</ServiceName>
    <SessionId>07071612200737105</SessionId>
    <StatusCode>70008</StatusCode>
    <StatusName>InvalidIssuer</StatusName>
    <StatusDescription>InvalidIssuer</StatusDescription>
    <ServiceDate>2021-10-01 12:37:50</ServiceDate>
    <ServiceId>07071612200737105</ServiceId>
  </ResponseDetails>
  <ResponseParams>
  </ResponseParams>
</PraxellXMLResponse>

Last updated