Category links

API Links

Update Cardholder Information

Action: POST

Endpoint: /api/CoreCredit/CardManagement/UpdateCardholderInformation

This API allows updates to a cardholder's PII (personal identification information), address information, and additional information (if applicable).

Request fields details
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language == en: means use English ---- es: means Spanish

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AccountID

integer

Conditional

Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Example:12345 Condition:At least one of CardNumber/AdminNumber/AccountNumber/AccountID is required.

AdminNumber

int64

Conditional

Admin number. Valid Values:0-9 Example:12345 Condition:At least one of CardNumber/AdminNumber/AccountNumber/AccountID is required.

HomePhoneNumber

string

Optional

Card holder's Home Phone number. Valid Values:0-9 Example:7895463241

Allowable Values:

15

AddressLine1

string

Optional

Card Holder's address line 1. Valid Values:A-Z, 0-9 Example:123 HWY

Allowable Values:

50

AddressLine2

string

Optional

Card holder's address line 2. Valid Values:A-Z, 0-9 Example:Park Avenue

Allowable Values:

50

City

string

Optional

City name of the Card holder's address. Example:Los Angeles

Allowable Values:

40

Country

string

Optional

This tag reflects the Country code.

Allowable Values:

3

State

string

Optional

State of the card holder address. Example:Virginia

Allowable Values:

40

PostalCode

string

Optional

Postal code of the card holder address. Valid Values:0-9 Example:46206

Allowable Values:

9

ClientID

integer

Optional

Client ID of the client. Valid Values: 1422245 Example: 5558547

FirstName

string

Optional

Card holder's First name. Valid Values:A-Z Example:User1

Allowable Values:

50

MiddleName

string

Optional

Card holder's Middle Name. Valid Values: A-Z Example: LEE

Allowable Values:

50

LastName

string

Optional

Card holder's last name. Valid Values:A-Z Example:Smith

Allowable Values:

50

Title

string

Optional

Title of the card holder. Format: A-Z Example:Mr

Allowable Values:

9

WorkPhoneNumber

string

Optional

Card holder's Work phone number. Valid Values:0-9 Example:5678909876

Allowable Values:

15

MobilePhoneNumber

string

Optional

Card holder Mobile Phone Number. Valid Values:0-9 Example:987567757

Allowable Values:

20

EmailID

string

Optional

Card holder's Email ID. Format:XXX@XXX.XXX Example:abc@gmail.com Condition: Email id is not mandatory but user can not set it blank if it is having some value in Core. But user can update with new.Email ID can not be duplicate between card holder’s.

Allowable Values:

50

MobileCarrier

string

Optional

Carrier of Mobile Phone number. Valid Values:a-z,0-9 Example: BSNL

Allowable Values:

50

DateOfBirth

datetime

Optional

Card Holder's Date of Birth. Format:MM/dd/YYYY Example:11/23/1980

SSN

string

Conditional

Card holder's Social Security Number. Format:AAAGGSSSS Example::078051120

Allowable Values:

9

GovernmentID

string

Conditional

Card holder's Government ID. Valid Values:A-Z Example:CDDT9741Q

Allowable Values:

30

IDNumber

string

Conditional

Card holder's Government ID Number. Format:AAAGGSSSS Example:078051120 Condition:This field is mandatory when government id type other than Other ID is used for cardholder identification.

Allowable Values:

40

IDCountry

string

Conditional

Country of Identification proof. Valid Values:a-z, 0-9 Example: Canada Condition:This field is mandatory when government id Type other than Other ID is used for cardholder identification.Two character country code should be passed in the request and not country name.

Allowable Values:

5

IDState

string

Conditional

Government identification issued state. Condition: GovernmentID issue state is mandatory, when Government id type is 'Drivers license' Or 'State ID' and ID issue country is US.

Allowable Values:

50

IDIssueDate

datetime

Conditional

Issue date of ID card. Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020 Condition: GovernmentID issue date is mandatory when governmentID type is 'Drivers license' and ID issue country is US and Id issue state is other than Massachusetts, Michigan, Missouri, Texas.

IDExpirationDate

datetime

Conditional

Government issued identification expiration date. Valid Values: MM/DD/YYYY Example: 02012020 Condition: This field is mandatory when government id type other than Other ID is used for cardholder identification.

BankruptcyNotificationDate

datetime

Optional

Date when bankruptcy is notified. Format: MM/dd/YYYY Example: 07/25/1991 Condition: Mandatory for bankruptcy account

Education

string

Optional

Educational details of the applicant Valid Values: a-z,0-9 Example: B.E

Allowable Values:

50

Deceased

integer

Optional

Flag for card holder is deceased or not Valid Values: 0,1 Example: 0 - No, 1 - Yes

MaritalStatus

integer

Optional

Card holder's Marital Status Valid Values: 0,1 Example: 0 - No, 1 - Yes

LanguageIndicator

string

Optional

Language indicator

Allowable Values:

35

Gender

string

Optional

Gender of card holder Valid Values: A-Z Example: Male

Allowable Values:

5

SurnameSuffix

string

Optional

Cardholder's surname-suffix Example:SR

Allowable Values:

5

MotherMaidenName

string

Optional

Card holder's mother Maiden Name Valid Values:a-z,0-9 Example:Johnson

Allowable Values:

50

OtherPhoneNumber

string

Optional

Card holder's other Phone Number Valid Values:0-9 Example:987567757

Allowable Values:

15

ResidenceType

string

Optional

Type of Residince that cardholder lives in. Valid Values:A-Z Example:Own

Allowable Values:

35

MonthsAtAddress

integer

Optional

Duration on residence in months Valid Values: 0-9 Example:9

OptOutForEmailMarketing

integer

Optional

Flag to Opt out for email marketing Valid Values: 0,1 Example: 0-no, 1-yes

AdditionalAddressFirstName

string

Optional

First Name provided in additional address section. Valid Values:A-Z, 0-9 Format: xxxx Example:abcd 01234

Allowable Values:

50

AdditionalAddressMiddleName

string

Optional

Middle Name provided in additional address section. Valid Values: 0-9 A-Z Format: xxxx Example:abcd 01234

Allowable Values:

50

AdditionalAddressLastName

string

Optional

Last Name provided in additional address section. Valid Values: 0-9 A-Z Format: xxxx Example:abcd 01234

Allowable Values:

50

AdditionalAddressLine1

string

Optional

Address line 1 of cardholder's additional address. Valid Values:A-Z, 0-9 Example:123 HWY

Allowable Values:

40

AdditionalAddressLine2

string

Optional

Address line 2 of cardholder's additional address. Valid Values:A-Z, 0-9 Example:123 HWY

Allowable Values:

40

AdditionalAddressCity

string

Optional

City of cardholder's additional address Valid Values:a-z Format:XXXX Example: Atlanta

Allowable Values:

40

AdditionalAddressState

string

Optional

State of cardholder's additional address Valid Values:a-z Format:XXXX Example: Georgia

Allowable Values:

5

AdditionalAddressCountry

string

Optional

Country of cardholder's additional address Valid Values:a-z Example: France

Allowable Values:

50

AdditionalAddressPhoneNumber

string

Optional

Phone number of cardholder's additional address Valid Values:0-9 Example:7895463214

Allowable Values:

12

AdditionalAddressEmailID

string

Optional

Additional Address Email ID Valid Values: a-z Format: xx @xx.com Example:ABC @gmail.com

Allowable Values:

50

POATitle

string

Optional

Title of the POA Valid Values: Mr Example:Mr

Allowable Values:

5

POAWorkPhone

string

Optional

Work Phone of POA Valid Values:0-9 Example:7895463214

Allowable Values:

12

POAWorkPhoneBadIndCo

integer

Optional

Flag for bad phone for POA Valid Values: 0,1 Example: 0-no, 1-yes

POAMI

string

Optional

Middle name. Valid Values: a-z

Allowable Values:

50

POAHomePhone

string

Optional

POA Home Phone number Valid Values:0-9 Example:7895463214

Allowable Values:

12

POAHomePhoneBadIndCo

integer

Optional

Flag for bad home phone for POA Valid Values: 0,1 Example: 0-no, 1-yes

POAFirstName

string

Optional

Power Of Attorney First name. Valid Values:A-Z Example:User1

Allowable Values:

50

POAMobilePhone

string

Optional

POA mobile Phone number Valid Values:0-9 Example:7895463214

Allowable Values:

12

POAMobilePhoneBadIndCo

integer

Optional

Flag for mobile number bad phone Valid Values: 0,1 Example: 0-no, 1-yes

POALastName

string

Optional

Power Of Attorney Last name. Valid Values:A-Z Example:User1

Allowable Values:

50

POAOtherPhonePhone

string

Optional

POA other Phone number Valid Values:0-9 Example:7895463214

Allowable Values:

12

POAOtherPhoneBadIndCo

integer

Optional

flag for POA other number bad phone Valid Values: 0,1 Example: 0-no, 1-yes

POALanguage

string

Optional

Language indicatior for POA Valid Values: A-Z Example: French

Allowable Values:

50

POAAlternatePhone

string

Optional

POA alternate Phone number Valid Values:0-9 Example:7895463214

Allowable Values:

12

POAAlternatePhoneBadIndCo

integer

Optional

Flag for POA Alternate number bad phone Valid Values: 0,1 Example: 0-no, 1-yes

POAEmailAddress

string

Optional

POA Email ID Valid Values: a-z Format: xx @xx.com Example:ABC @gmail.com

Allowable Values:

50

POAFromTime1

string

Optional

Preferred time 1 to call POA contact Valid Values:0-9 Format:HHMMMSS Example: 120505

Allowable Values:

10

POAToTime1

string

Optional

Preffered time to call POA contact Valid Values:1215090000 Format:MMDDHHMMSS Example:1215090000

Allowable Values:

10

POAFromTime2

string

Optional

Preffered time to call POA contact Valid Values:1215090000 Format:MMDDHHMMSS Example:1215090000

Allowable Values:

10

POAToTime2

string

Optional

Preffered time to call POA contact Valid Values:1215090000 Format:MMDDHHMMSS Example:1215090000

Allowable Values:

10

ConsumerInfoIndicator

string

Optional

Customer related indications Valid Values: A-Z, 0-9 Example:2A = Lease Assumption

Allowable Values:

150

HomePhoneBadIndicator

integer

Optional

Flag for Home number bad phone Valid Values: 0,1 Example: 0-no, 1-yes

MobilePhoneBadIndicator

integer

Optional

Flag for Mobile number bad phone Valid Values: 0,1 Example: 0-no, 1-yes

OthrPhoneBadIndicator

integer

Optional

Flag for Other number bad phone Valid Values: 0,1 Example: 0-no, 1-yes

WorkPhoneBadIndicator

integer

Optional

Flag for Work number bad phone Valid Values: 0,1 Example: 0-no, 1-yes

CeaseAndDesistIndicator

integer

Optional

Flag for card holder Cease And Desist Valid Values: 0,1 Example: 0-no, 1-yes

Bankruptcy

integer

Optional

Flag for Bankruptcy Valid Values:0,1 Example:0-no, 1-yes

ThirdPDM

integer

Optional

Third party debt management Valid Values: 0,1 Example: 0-no, 1-yes

DoNotCallHomePhoneNUM

integer

Optional

Flag for Do not call at home phone number Valid Values: 0,1 Example: 0-no, 1-yes

DoNotCallMobileNUM

integer

Optional

Flag for Do not call at Mobile phone number. Valid Values: 0,1 Example: 0-no, 1-yes

DoNotCallWorkPhoneNUM

integer

Optional

Flag for Do not call at work phone number Valid Values: 0,1 Example: 0-no, 1-yes

DoNotCallOtherPhoneNUM

integer

Optional

Flag for Do not call at other phone number Valid Values: 0,1 Example: 0-no, 1-yes

CardNumber

string

Conditional

This tag reflect the card number Valid Values:0-9 Example:1236547896541236 Condition:At least one of CardNumber/AdminNumber/AccountNumber/AccountID is required.

Allowable Values:

19

NameOnCard

string

Optional

Name to be print?ed on the card. Valid Values:a-z Example:John J

Allowable Values:

50

HomeFaxNumber

string

Optional

This tag reflects the Home Fax number Valid Values:0-9 Example:5678909876

Allowable Values:

19

AdditionalAddressPostalCode

string

Optional

Postal Code of cardholder's additional address. Valid Values:46077 Example:46077

Allowable Values:

10

DeceasedNotificationDate

datetime

Conditional

Date when deceased is notified Format:MM/DD/YYYY Example:02/20/2020 Condition: Mandatory for deceased account

FraudVictim

integer

Optional

Flag to identify any individual that is victim of Fraud Valid Values: 0,1 Format: x Example: 0-no, 1-yes

Source

string

Mandatory

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Mandatory

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AccountID

integer

Conditional

Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Example:12345 Condition:At least one of CardNumber/AdminNumber/AccountNumber/AccountID is required.

AdminNumber

int64

Conditional

Admin number. Valid Values:0-9 Example:12345 Condition:At least one of CardNumber/AdminNumber/AccountNumber/AccountID is required.

HomePhoneNumber

string

Optional

Card holder's Home Phone number. Valid Values:0-9 Example:7895463241

Allowable Values:

15

AddressLine1

string

Optional

Card Holder's address line 1. Valid Values:A-Z, 0-9 Example:123 HWY Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

AddressLine2

string

Optional

Card holder's address line 2. Valid Values:A-Z, 0-9 Example:Park Avenue Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

City

string

Optional

City name of the Card holder's address. Valid Values: 0-9 A-Z Format: xxxxx Example:Los Angeles Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

25

Country

string

Optional

This tag reflects the Country code. Valid Values: Refer Appendix Format: xx Example: US Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

5

State

string

Optional

State of the card holder address. Valid Values: Refer Appendix Format: xx Example: CA Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

30

PostalCode

string

Optional

Postal code of the card holder address. Valid Values:0-9 Example:46206 Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

9

ClientID

integer

Optional

Client ID of the client. Valid Values: 1422245 Example: 5558547

FirstName

string

Optional

Card holder's First name. Valid Values:A-Z Example:User1 Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

MiddleName

string

Optional

Card holder's Middle Name. Valid Values: A-Z Example: LEE Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

LastName

string

Optional

Card holder's last name. Valid Values:A-Z Example:Smith Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

Title

string

Optional

Title of the card holder. Format: A-Z Example:Mr Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

5

WorkPhoneNumber

string

Optional

Card holder's Work phone number. Valid Values:0-9 Example:5678909876

Allowable Values:

15

MobilePhoneNumber

string

Optional

Card holder Mobile Phone Number. Valid Values:0-9 Example:987567757

Allowable Values:

20

EmailID

string

Optional

Card holder's Email ID. Valid Values: 0-9 A-Z Format: xx @xxx.com Example: abc@gmail.com Condition: Email ID is not mandatory but user can not set it blank if it is having some value.But user can update with new Email ID.Email ID can not be duplicate between card holders. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

256

MobileCarrier

string

Optional

Carrier of Mobile Phone number. Valid Values:a-z,0-9 Example: BSNL

Allowable Values:

50

DateOfBirth

datetime

Optional

Card Holder's Date of Birth. Format:MM/dd/YYYY Example:11/23/1980

SSN

string

Conditional

Card holder's Social Security Number. Format:AAAGGSSSS Example::078051120

Allowable Values:

9

GovernmentID

string

Conditional

Type of Government issued identification Valid Values: Refer Appendix section 5.2 Example: 10 Condition: This field will become mandatory basis following two conditions: 1.For US State Cards This field is mandatory only when ID Type on product is set as Yes for Card Type=Primary. 2.For Non-US State cards This field is mandatory only when ID Type (Non-US) on product is set as Yes for Card Type=Primary.

Allowable Values:

30

IDNumber

string

Conditional

Cardholder's ID Number. Valid Values: 0-9 A-Z Format: xxxxxx Example: 489657458 Condition: Refer Appendix, 5.62 ID Details.

Allowable Values:

40

IDCountry

string

Conditional

Country of Identification proof. Valid Values: 0-9 A-Z Format: xx Example: US Condition: Refer Appendix, 5.62 ID Details.

Allowable Values:

5

IDState

string

Conditional

Government identification issued state. Valid Values: 0-9 A-Z Format: xx Example: CA Condition: Refer Appendix, 5.62 ID Details.

Allowable Values:

50

IDIssueDate

datetime

Conditional

Issue date of Government ID. Valid Values: 0-9 A-Z Format: MM/DD/YYYY Example: 02/01/2020 Condition: Refer Appendix, 5.62 ID Details.

IDExpirationDate

datetime

Conditional

Expiration date of Government ID. Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020 Condition: Refer Appendix, 5.62 ID Details.

BankruptcyNotificationDate

datetime

Optional

Date when bankruptcy is notified. Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020 Condition: Mandatory when Bankruptcy is applied.

Education

string

Optional

Educational details of the applicant Valid Values:0-8 Example: 1-Less than High School Graduate,2-High School Graduate,3-Some College Degree,4-College Graduate,5-Some Post Graduate,6-Masters Degree,7-Professional School Degree,8-Doctorate Degree

Allowable Values:

50

Deceased

integer

Optional

Flag to identify that Cardholder is Deceased or not. Valid Values: 0 / 1 Format: x Example: 0 - No, 1 - Yes

MaritalStatus

integer

Optional

Card holder's Marital Status Valid Values: 0,1 Example: 0 - No, 1 - Yes

LanguageIndicator

string

Optional

Language of the Cardholder. Valid Values: 0-9 A-Z Format: xxxxx Example: English

Allowable Values:

35

Gender

string

Optional

Gender of card holder Valid Values: A-Z Example: Male

Allowable Values:

5

SurnameSuffix

string

Optional

Cardholder's surname-suffix. Valid Values: 0-9 A-Z Format: xx Example: Sr. / Jr.

Allowable Values:

5

MotherMaidenName

string

Optional

Card holder's mother Maiden Name Valid Values:a-z,0-9 Example:Johnson

Allowable Values:

50

OtherPhoneNumber

string

Optional

Card holder's other Phone Number Valid Values:0-9 Example:987567757

Allowable Values:

15

ResidenceType

string

Optional

Type of Residince that cardholder lives in. Valid Values: Refer Appendix, Residence ownership Code Format: X Example: O

Allowable Values:

35

MonthsAtAddress

integer

Optional

Duration on residence in months Valid Values: 0-9 Example:9

OptOutForEmailMarketing

integer

Optional

Flag to Opt out for email marketing Valid Values: 0,1 Example: 0-no, 1-yes

AdditionalAddressFirstName

string

Optional

First Name provided in additional address section. Valid Values:A-Z, 0-9 Format: xxxx Example:abcd 01234 Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

AdditionalAddressMiddleName

string

Optional

Middle Name provided in additional address section. Valid Values: 0-9 A-Z Format: xxxx Example:abcd 01234 Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

AdditionalAddressLastName

string

Optional

Last Name provided in additional address section. Valid Values: 0-9 A-Z Format: xxxx Example:abcd 01234 Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

AdditionalAddressLine1

string

Optional

Address line 1 of cardholder's additional address. Valid Values:A-Z, 0-9 Example:123 HWY Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

AdditionalAddressLine2

string

Optional

Address line 2 of cardholder's additional address. Valid Values:A-Z, 0-9 Example:123 HWY Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

AdditionalAddressCity

string

Optional

City of cardholder's additional address Valid Values:a-z Format:XXXX Example: Atlanta Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

25

AdditionalAddressState

string

Optional

State of cardholder's additional address Valid Values:a-z Format:XXXX Example: Georgia Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

30

AdditionalAddressPostalCode

string

Optional

Postal Code of cardholder's additional address. Valid Values:46077 Example:46077 Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

9

AdditionalAddressCountry

string

Optional

Country of cardholder's additional address Valid Values:a-z Example: France Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

AdditionalAddressPhoneNumber

string

Optional

Phone number of cardholder's additional address Valid Values:0-9 Example:7895463214

Allowable Values:

12

AdditionalAddressEmailID

string

Optional

Additional Address Email ID Valid Values: a-z Format: xx @xx.com Example:ABC @gmail.com Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

256

POATitle

string

Optional

Title of the POA. Valid Values: Refer Appendix, Title Values Format: XX Example: Mr Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

5

POAWorkPhone

string

Optional

Work Phone of POA Valid Values:0-9 Example:7895463214

Allowable Values:

12

POAWorkPhoneBadIndCo

integer

Optional

Flag for bad phone for POA Valid Values: 0,1 Example: 0-no, 1-yes

POAMI

string

Optional

Middle name. Valid Values: 0-9 A-Z Format: xxxx Example: Tom

Allowable Values:

50

POAHomePhone

string

Optional

POA Home Phone number Valid Values:0-9 Example:7895463214

Allowable Values:

12

POAHomePhoneBadIndCo

integer

Optional

Flag for bad home phone for POA Valid Values: 0,1 Example: 0-no, 1-yes

POAFirstName

string

Optional

Power Of Attorney First name. Valid Values:A-Z Example:User1 Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

POAMobilePhone

string

Optional

POA mobile Phone number Valid Values:0-9 Example:7895463214

Allowable Values:

12

POAMobilePhoneBadIndCo

integer

Optional

Flag for mobile number bad phone Valid Values: 0,1 Example: 0-no, 1-yes

POALastName

string

Optional

Power Of Attorney Last name. Valid Values:A-Z Example:User1 Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

POAOtherPhonePhone

string

Optional

POA other Phone number Valid Values:0-9 Example:7895463214

Allowable Values:

12

POAOtherPhoneBadIndCo

integer

Optional

Flag to mark POA other phone as Bad indicator. Valid Values: 0 = No, 1 = Yes Format: x Example: 1

POALanguage

string

Optional

Language indicatior for POA Valid Values: A-Z Example: French

Allowable Values:

50

POAAlternatePhone

string

Optional

POA alternate Phone number Valid Values:0-9 Example:7895463214

Allowable Values:

12

POAAlternatePhoneBadIndCo

integer

Optional

Flag for POA Alternate number bad phone Valid Values: 0,1 Example: 0-no, 1-yes

POAEmailAddress

string

Optional

POA Email ID Valid Values: a-z Format: xx @xx.com Example:ABC @gmail.com

Allowable Values:

50

POAFromTime1

string

Optional

Preferred time 1 to call POA contact (From) Valid Values:0-9 Format:HHMMMSS Example: 120505 Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

10

POAToTime1

string

Optional

Preferred time 1 to call POA contact (To) Valid Values:0-9 Format:HHMMMSS Example: 120505

Allowable Values:

10

POAFromTime2

string

Optional

Preferred time 2 to call POA contact (From) Valid Values:0-9 Format:HHMMMSS Example: 120505

Allowable Values:

10

POAToTime2

string

Optional

Preferred time 2 to call POA contact (To) Valid Values:0-9 Format:HHMMMSS Example: 120505

Allowable Values:

10

ConsumerInfoIndicator

string

Optional

The Consumer Information Indicator (CII) contains a value that indicates a special condition that applies to the specific consumer. Valid Values: Refer Appendix, Consumer Information Indicator Format: x Example: A Condition: When Bankruptcy is marked then this field is required.

Allowable Values:

150

HomePhoneBadIndicator

integer

Optional

Flag for Home number bad phone Valid Values: 0,1 Example: 0-no, 1-yes

MobilePhoneBadIndicator

integer

Optional

Flag for Mobile number bad phone Valid Values: 0,1 Example: 0-no, 1-yes

OthrPhoneBadIndicator

integer

Optional

Flag for Other number bad phone Valid Values: 0,1 Example: 0-no, 1-yes

WorkPhoneBadIndicator

integer

Optional

Flag for Work number bad phone Valid Values: 0,1 Example: 0-no, 1-yes

CeaseAndDesistIndicator

integer

Optional

Flag for card holder Cease And Desist Valid Values: 0,1 Example: 0-no, 1-yes

Bankruptcy

integer

Optional

Flag for Bankruptcy Valid Values:0,1 Example:0-no, 1-yes

ThirdPDM

integer

Optional

Third party debt management Valid Values: 0,1 Example: 0-no, 1-yes

DoNotCallHomePhoneNUM

integer

Optional

Flag for Do not call at home phone number Valid Values: 0,1 Example: 0-no, 1-yes

DoNotCallMobileNUM

integer

Optional

Flag for Do not call at Mobile phone number. Valid Values: 0,1 Example: 0-no, 1-yes

DoNotCallWorkPhoneNUM

integer

Optional

Flag for Do not call at work phone number Valid Values: 0,1 Example: 0-no, 1-yes

DoNotCallOtherPhoneNUM

integer

Optional

Flag for Do not call at other phone number Valid Values: 0,1 Example: 0-no, 1-yes

CardNumber

string

Conditional

This tag reflect the card number Valid Values:0-9 Example:1236547896541236 Condition:At least one of CardNumber/AdminNumber/AccountNumber/AccountID is required.

Allowable Values:

19

NameOnCard

string

Optional

Name to be printed on the card. Valid Values: 0-9 A-Z Example: Tom Chandler Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

HomeFaxNumber

string

Optional

This tag reflects the Home Fax number Valid Values:0-9 Example:5678909876

Allowable Values:

19

DeceasedNotificationDate

datetime

Conditional

Date when deceased is notified. Format:MM/DD/YYYY Example:02/20/2020 Condition: Mandatory if Deceased flag is set as 1 = Yes.

FraudVictim

integer

Optional

Flag to identify any individual that is victim of Fraud Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CreditFilePhoneNumber

string

Optional

Card holder Credit file phone number. Valid Values:0-9 Example:987567757

AlternatePhone

string

Optional

Card holder alternate phone number Valid Values:0-9 Example:987567757

Allowable Values:

20

IdentifierToken

string

Conditional

A generated token that is not expired can be used as an input field to access API. If we are passing this field in input, user should not pass any other account identifier. Condition:At least one account identifier is required.

Allowable Values:

800

AllowCashTransactions

integer

Optional

Indicates if cash transactions are allowed on this card or not Valid Values – 0 – No, 1 - Yes

CoownerStatus

string

Optional

Indicate the status of Coowner sharing liability. Valid Values : 0 –Inactive, 1 - Active Example: 1

Allowable Values:

100

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": "840",
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AccountID": 21991,
  "AdminNumber": 24429,
  "HomePhoneNumber": null,
  "AddressLine1": "test",
  "AddressLine2": null,
  "City": "AK",
  "Country": "US",
  "State": "AK",
  "PostalCode": "85645",
  "ClientID": null,
  "FirstName": "Test",
  "MiddleName": "H",
  "LastName": "Test",
  "Title": "03",
  "WorkPhoneNumber": null,
  "MobilePhoneNumber": null,
  "CreditFilePhoneNumber": null,
  "AlternatePhone": null,
  "EmailID": null,
  "MobileCarrier": null,
  "DateOfBirth": null,
  "SSN": null,
  "GovernmentID": null,
  "IDNumber": null,
  "IDCountry": null,
  "IDState": null,
  "IDIssueDate": null,
  "IDExpirationDate": null,
  "BankruptcyNotificationDate": null,
  "Education": null,
  "Deceased": null,
  "MaritalStatus": null,
  "LanguageIndicator": null,
  "Gender": null,
  "SurnameSuffix": "II",
  "MotherMaidenName": null,
  "OtherPhoneNumber": null,
  "ResidenceType": null,
  "MonthsAtAddress": null,
  "OptOutForEmailMarketing": null,
  "AdditionalAddressFirstName": null,
  "AdditionalAddressMiddleName": null,
  "AdditionalAddressLastName": null,
  "AdditionalAddressLine1": null,
  "AdditionalAddressLine2": null,
  "AdditionalAddressCity": null,
  "AdditionalAddressState": null,
  "AdditionalAddressPostalCode": null,
  "AdditionalAddressCountry": null,
  "AdditionalAddressPhoneNumber": null,
  "AdditionalAddressEmailID": null,
  "POATitle": null,
  "POAWorkPhone": null,
  "POAWorkPhoneBadIndCo": null,
  "POAMI": null,
  "POAHomePhone": null,
  "POAHomePhoneBadIndCo": null,
  "POAFirstName": null,
  "POAMobilePhone": null,
  "POAMobilePhoneBadIndCo": null,
  "POALastName": null,
  "POAOtherPhonePhone": null,
  "POAOtherPhoneBadIndCo": null,
  "POALanguage": null,
  "POAAlternatePhone": null,
  "POAAlternatePhoneBadIndCo": null,
  "POAEmailAddress": null,
  "POAFromTime1": null,
  "POAToTime1": null,
  "POAFromTime2": null,
  "POAToTime2": null,
  "ConsumerInfoIndicator": null,
  "HomePhoneBadIndicator": null,
  "MobilePhoneBadIndicator": null,
  "OthrPhoneBadIndicator": null,
  "WorkPhoneBadIndicator": null,
  "CeaseAndDesistIndicator": null,
  "Bankruptcy": null,
  "ThirdPDM": null,
  "DoNotCallHomePhoneNUM": null,
  "DoNotCallMobileNUM": null,
  "DoNotCallWorkPhoneNUM": null,
  "DoNotCallOtherPhoneNUM": null,
  "CardNumber": null,
  "NameOnCard": null,
  "HomeFaxNumber": null,
  "DeceasedNotificationDate": null,
  "FraudVictim": null,
  "IdentifierToken": null,
  "AllowCashTransactions": null,
  "CoownerStatus": null
}
Response fields details
Fields Description

AccountNumber

string

This tag reflects the account number. Valid Values:0-9 Example:8000000000000037

Allowable Values:

19

AccountNumber

string

This tag reflects the account number. Valid Values:0-9 Example:8000000000000037

Allowable Values:

19

Sample response body

{
  "Message": "Card Updated Successfully",
  "Status": true,
  "ErrorCode": "Msgcu01",
  "ResponseData": {
    "AccountNumber": "0000000010048695"
  }
}