CardUpdate API
Description
This API helps to Update Card Holder Information.
Request Parameters
Y = Required, Y* = Conditional, X = Required When Block Present and N = Optional
APIAccessToken*
-[string(256)]--Issued by FirstView web services authorization call. Auth Token is valid for 24 hours and is required to obtain a new token prior to the expiration. Has to be send in the "Authorization" Header when making the requests
| Property | Description | Required | Type |
|---|---|---|---|
| ClientId |
Unique Partner Reference Number issued by FirstView Example: 54321 |
N |
string Length <= 25 |
| CardNumber |
16-digit Card Number Example: 1234123412341234 |
Y* |
string Length = 16 digits |
| FirstName |
First Name of the account holder Example: JOhn |
N |
string Length <= 50 |
| MiddleName |
First Name of the account holder Example: David |
N |
string Length <= 50 |
| LastName |
Last Name of the account holder Example: JOhn |
N |
string Length <= 50 |
| DateOfBirth |
Account Holder Date of Birth in MMDDYYYY Format Example: 01011970 |
Y |
string Length = 8 |
| GovernmentId |
Type of Government ID Proof Following are various Options:
|
Y* |
string Length = 2 |
| IdNumber |
Govt. ID number Example: DL1234566 |
Y |
string Length <= 25 |
| IdIssueDate |
Issue Date for Govt. ID in MMDDYYYY (except for ID No 08,09,11) Example: 01011970 |
Y* |
string Length = 8 |
| IdExpirationDate |
Expiration Date for Govt. ID in MMDDYYYY (except for ID No 09,11) Example: 01011970 |
Y* |
string Length = 8 |
| IdIssueCountry |
Country of Govt. ID issued(except for ID No 11) Example: USA |
Y* |
string Length <= 5 |
| IdIssueState |
State where the ID is issued, Valid only for options (02,07 for US and CANADA) Example: GA |
Y* |
string Length = 2 |
| Address1 |
Address of Account holder without any Special Characters (*NO PO BOX ALLOWED*) Example: 2000 RiverEdge |
Y |
string Length <= 40 |
| Address2 |
Additional Address of Account holder without any Special Characters (*NO PO BOX ALLOWED*) Example: S580 |
N |
string Length <= 40 |
| ConuntryOfIssue |
Country where the ID is issued Example: USA |
Y |
string Length = 5 |
| State |
State the address belongs to Example: GA |
Y |
string Length = 2 |
| City |
City the address belongs to Example: Atlanta |
Y |
string Length <= 40 |
| PostalCode |
Postal Code the address belongs to Example: 12345 or 12345-1234 |
Y |
string Length = 10 |
| Country |
Country the address belongs to (Only US address are allowed) Example: USA |
Y |
string Length = 20 |
| EmailId |
Email of Account Holder for communications Example: abc@abc.com |
Y* |
string Length <= 100 |
| HomePhoneNumber |
Account Holder Home Phone Number Example: 1234567890 |
N |
string Length = 10 |
| ManualCardStatus |
Card Status Updates Should be Left Blank for Inactive Example: 1 |
N |
int 4-digit |
| Userfield1 |
UserDefined Field Name, Should be Left Blank Example: Special Request Account |
N |
string Length <= 40 |
| Userfield2 |
UserDefined Field Name, Should be Left Blank Example: Special Request Account |
N |
string Length <= 40 |
| Userfield3 |
UserDefined Field Name, Should be Left Blank Example: Special Request Account |
N |
string Length <= 40 |
| Userfield4 |
UserDefined Field Name, Should be Left Blank Example: Special Request Account |
N |
string Length <= 40 |
| Userfield5 |
UserDefined Field Name, Should be Left Blank Example: Special Request Account |
N |
string Length <= 40 |
| HPhoneCountryCode |
Home Phone Number Country Code Example: 01 |
N |
string Length = 2 |
| HPhoneExtension |
Home Phone Number Extension Example: 1234 |
N |
string Length = 4 |
| ssn |
Social Security Number Example: 123456789 |
Y |
string Length = 9 - digits |
| ShipToCmpnyName |
Company Name For Shipping Example: FirstView |
N |
string Length <= 20 |
| ShipToContactName |
Contact Person Name Example: John Smith |
Y* |
string Length <= 50 |
| ShipToAddressOne |
Shipping Address Line-1 without any Special Characters (*NO PO BOX ALLOWED*) Example: 2000 RiverEdge |
Y* |
string Length <= 40 |
| ShipToAddressTwo |
Shipping Address Line-2 without any Special Characters (*NO PO BOX ALLOWED*) Example: S580 |
Y* |
string Length <= 40 |
| ShipToState |
Shipping Address State Example: GA |
Y* |
string Length = 2 |
| ShipToCity |
Shipping Address City Example: Atlanta |
Y* |
string Length <= 20 |
| ShipToZipCode |
Shipping Address Zip Code Example: 12345 or 12345-1234 |
Y* |
string Length = 10 |
| Reissue |
Reissue Card with 1-Same Exp.Date or 2-New Exp.Date (Card will Not be Reissued in case of no value) Example: 1 |
N |
string Length = 2 |
| SkipACHLoadEffectiveDate |
Skip Ach Effective Date 0-No / 1-Yes Example: 0 |
Y |
string Length = 2 |
Note:
Additional Notes on Input Field
- If Government ID is “02 - Driving License #”, then the ID Number, ID Issue Date, ID Expiration Date, ID Issue Country, and ID Issue State (State is required only if Driver’s License issued in US/ Canada) will be mandatory.
- If Government ID is “03 - Matricular”, then the ID Number, ID Issue Country, ID Issue Date and ID Expiration Date will be mandatory.
- If Government ID is “04 - Passport”, then the ID Number, ID Issue Country, ID Issue Date, ID Expiration Date will be mandatory.
- If Government ID is “05 - Visa”, then the ID Number, Issue Country ID, Issue Date, ID Expiration Date will be mandatory.
- If Government ID is “06 - Green Card”, then the ID Number, ID Issue Country, ID Issue Date, ID Expiration Date will be mandatory.
- If Government ID is “07 - State ID”, then the ID Number, ID Issue Country and ID Issue State (State is required only if Drivers License issued in US/ Canada) will be mandatory, ID Issue Date, ID Expiration Date.
- If Government ID is “08 - Military ID”, then the ID Number, ID Issue Country, ID Expiration Date will be mandatory.
- If Government ID is “09 - Voters Registration Card”, then the ID Number and ID Issue Country will be mandatory.
- If Government ID is “10 - Government ID”, then the ID Number, ID Issue Country, ID Issue Date, ID Expiration Date will be mandatory.
- If Government ID is “11 - Tax Identification Number”, then the ID Number is mandatory
- Country of Issue will accept both US and USA for United States.
Return Values
MessageResponse
| Property | Description | Type |
|---|---|---|
|
ResErrorMsg |
Error message |
string |
|
ResErrorCode |
Error number for the returns message |
Numeric |
|
ResCode |
If any error found, then “0” else “1” |
string |
|
Account Number |
System Generated New Account Number |
string |
REST
Method: POST
Urls:
| Production: | https://api.fvfn.net/fvfnunvwebapi/core/CardUpdate |
| SandBox: | https://api.firstviewcorp.com/fvfnunvwebapi/core/CardUpdate |
JSON Request:
{
"CLIENTID": null,
"CARDNUMBER": null,
"FIRSTNAME": null,
"MIDDLENAME": null,
"LASTNAME": null,
"DATEOFBIRTH": null,
"GOVERNMENTID": null,
"IDNUMBER": null,
"IDISSUEDATE": null,
"IDEXPIRATIONDATE": null,
"IDISSUECOUNTRY": null,
"IDISSUESTATE": null,
"ADDRESS1": null,
"ADDRESSLINE2": null,
"CITY": null,
"STATE": null,
"COUNTRY": null,
"POSTALCODE": null,
"HOMEPHONENUMBER": null,
"EMAILID": null,
"ManualCardStatus": null,
"USERFIELD1": null,
"USERFIELD2": null,
"USERFIELD3": null,
"USERFIELD4": null,
"USERFIELD5": null,
"HPhoneCountryCode": null,
"HPhoneExtension": null,
"SSNNUMBER": null,
"ShipToCmpnyName": null,
"ShipToContactName": null,
"ShipToAddressOne": null,
"ShipToAddressTwo": null,
"ShipToCity": null,
"ShipToState": null,
"ShipToZipCode": null,
"Reissue": null,
"SkipACHLoadEffectiveDate": null
}
Response:
{
"ResErrorMsg": null,
"ResErrorCode": null,
"ResCode": null,
"ACCOUNTNUMBER": null
}