Update Cardholder Data
Update Cardholder
The Update Cardholder Data API produces updates of cardholder details capable of handling update partially and removing data by using __EMPTY__ key word.
Input Parameters:
ID
Y
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
IDType
N
Format options: CardNumber RPID
Default=CardNumber
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: <, >
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](http://en.wikipedia.org/wiki/ISO_[...]
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 EIN Description: Closed list of values.Type of government identification document used: SSN- Social Security Number, PA[...]
EarlyAccess
N
Format: Y/N
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-20 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) Disabled (the cardholder has requested not to receive an SMS) Blank (the car[...]
LastName
Y
Format: Alpha, 2-20 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
IntPhoneNumber
N
International phone number Numeric with optional ("+") prefix Format: ^(?!+?0+$)+?\d{6,}$ Example: +972546644445
Can send __EMPTY__ to reset value
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
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
SubscribeToEmail
N
Format: Y/N Options: Y - Yes, will send OTP in email N - No, will not send OTP in email Optional, Can be undefined Default: N
UserDefined1
N
Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*|&;@!~=_' Size: 255
Can send __EMPTY__ to reset value
UserDefined2-15
N
Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*
&;@!~=_' Size: 255
AuthorizedUser
N
Can send __EMPTY__ to reset value
CardholderBankName
N
Format: Alphanumeric, 100 ^[A-Za-z0-9\s/.,-]{0,100}$'
Can send __EMPTY__ to reset value
CardholderAccountNumber
N
Format: Alphanumeric, 0-34 ^[a-zA-Z0-9]{0,34}$
Can send __EMPTY__to reset value
CardholderAccountName
N
Format: Alphanumeric, 100 ^[A-Za-z0-9\s/.,-]{0,100}$
Can send __EMPTY__ to reset value
CardholderBankRouting
N
Format: Numeric, 9
Can send __EMPTY__ to reset value
ExtPaymentProviderFields
N
Format: Alphanumeric, Date ^[0-9A-Za-z /:.,+\-]{0,30}$
Can send __EMPTY__ to reset value
IntAddressLine1
C
Format: Alphanumeric, 1-30 Can contains as well all special characters beside: <, >
Must be supplied if IntAddress is Y (Yes)
Can send __EMPTY__ to reset value
IntCity
C
Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period, &
Must be supplied if IntAddress is Y (Yes)
Can send __EMPTY__ to reset value
IntCountry
C
Format: ISO Country code. Two characters.
Must be supplied if IntAddress is Y (Yes)
Can send __EMPTY__ to reset value
IntZipPostalCode
C
Format: Alphanumeric, 1-20
Must be supplied if IntAddress is Y (Yes)
Can send __EMPTY__ to reset value
IntDocId
C
Format: Alphanumeric, 1-50
Must be supplied if IntAddress is Y (Yes)
Can send __EMPTY__ to reset value
IntAddress
N
Format: Y/N (Default N)
Language
N
Can send __EMPTY__ to reset value
MiddleName
N
Can send __EMPTY__ to reset value
SurName
N
Can send __EMPTY__ to reset value
AdditionalIDExpirationDate
N
Can send __EMPTY__ to reset value
Output Parameters:
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
Last updated