Card Registration API
Description
Using This API, Clients can Create Their Customer Accounts in FirstView Database
Parameters
null Values will Not be Accepted For * Marked Parameters in the Request Message
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
ProgramID*
-[string(32)]--Program ID. This will be Shared by FirstView as a part of Initial Business Setup.
AccountType*
-[char(2)]--Type of the account. 0 - Loan Proceeds, 1 - Healthcare
AccountID*
-[string(32)]--Unique account/customer id for the merchant/partner. If account id for the partner is already exist in the system it will append the card number as a secondary card
Cardnumber*
-[string(22)]--16-Digit Customer Card Number (PAN)
CardExpirationDate*
-[char(4)]--Card expiray date, MMYY
Firstname*
-[string(32)]--Customer's First Name
Lastname*
-[string(32)]--Customer's Last Name
Addressline1*
-[string(64)]--Customer's current Address for Communication line 1
Addressline2
-[string(64)]--Customer's current Address for Communication line 2
City*
-[string(32)]--City in which current the address located
State*
-[char(2)]--State (2-Letter Code) in which current address is located
PostalCode*
-[string(10)]--Postal Code for given address
Country*
-[char(2)]--Country in which current the address located
Email*
-[string(64)]--Customer's Email for communication
Phonenumber1*
-[string(16)]--Customer's 1st Phonenumber for communication
Phonenumber2
-[string(16)]--Customer's alternative Phonenumber for communication
DateOfBirth
-[char(8)]--Customer's DateOfBirth in MMDDYYYY format
CenterID
-[char(5)]--Clients CenterID
LoanType
-[char(3)]--Type of the Loan
FundsOriginationChannel
-[char(1)]--Payment Network for the Funds Transfer
ABA
-[string(16)]--Routing number
DDA
-[string(16)]--Demand Deposit Account Number
BIN
-[string(16)]--Bank Identification Number
MemberID
-[string(16)]--Customer's Health Care Member ID
ProcessID
-[string(16)]--Customer's Health Care Process ID
GroupID
-[string(16)]--Customer's Health Care Group ID
SubscriberID
-[string(16)]--Customer's Health Care Subscriber ID
PolicyID
-[string(16)]--Customer's Health Care Policy ID
ReservedField1
-[string(16)]--Reserved field for future
ReservedField2
-[string(16)]--Reserved field for future
ReservedField3
-[string(16)]--Reserved field for future
ReservedField4
-[string(16)]--Reserved field for future
ReservedField5
-[string(16)]--Reserved field for future
Return Values
MessageResponse
| # | Name | Type | Description |
|---|---|---|---|
| 1 | APIResponseCode | string (MaxLength = 4) | Response Code for the Request |
| 2 | APIReasonDescription | string (MaxLength = 64) | Description of the Response Message |
| 3 | APIResponseDateTime | Datetime | Time at the API Response Generated |
| 4 | APIUniqueReferenceID | string (MaxLength = 64) | Unique Tag number for the Response |
| 5 | Type | string | Type of Response |
| 6 | CardRegistrationDateTime | Datetime | Time at the Card Registered in System |
| 7 | OCTFastFundsIndicator | char | Speed of Funds delivery B,C,D: within 30min; N: within 2days |
| 8 | CardTokenID | string (MaxLength = 22) | Unique Token for the Card Number |
| 9 | Cardnumberlast4 | char[4] | Last Four Digits of the given Card Number |
| 10 | CardExpirationDate | char[4] | Expiration date of the given Card Number(MMYY) |
| 11 | CardType | string (MaxLength = 22) | Type of the Payment Network |
| 12 | DDATokenID | string (MaxLength = 22) | Unique Token for the DDA Number |
| 13 | Type | string | Type of Response |
| 14 | VerificationText | string | VerificationText |
REST
Method: POST
Url: TBD
JSON Request:
{
"ProgramID": {},
"AccountType": {},
"AccountID": {},
"Card":
{
"Cardnumber": {},
"CardExpirationDate": {},
"ABA": {},
"DDA": {},
"BIN": {}
},
"Name": {
"Firstname": {},
"Lastname": {}
},
"Address": {
"Addressline1": {},
"Addressline2": {},
"City": {},
"State": {},
"PostalCode": {},
"Country": {}
},
"Email": {},
"Phone": {
"Phonenumber1": {},
"Phonenumber2": {}
},
"DateOfBirth": {},
"CenterID": {},
"LoanType": {},
"FundsOriginationChannel": {},
"HealthCare": {
"MemberID": {},
"ProcessID": {},
"GroupID": {},
"SubscriberID": {},
"PolicyID": {}
},
"Reserved":{
"ReservedField1": {},
"ReservedField2": {},
"ReservedField3": {},
"ReservedField4": {},
"ReservedField5": {}
}
}
Response:
{
"Response": {
"APIResponseCode": {},
"APIReasonDescription": {},
"APIResponseDateTime": {},
"APIUniqueReferenceID": {},
"Type": {}
},
"CardRegistrationDateTime": {},
"OCTFastFundsIndicator": {},
"Token": [
{
"CardTokenID": {},
"Cardnumberlast4": {},
"CardExpirationDate": {},
"CardType": {},
"DDATokenID": {},
"Type": {}
}
],
"VerificationText": {}
}