FV API Documentation

Description

Using This Login API, Clients can verify the cardholder credentails and return the CardHolder Information, Status, Current Balance etc. parameters.

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
CARD_USERID	Unique Username Created during Inital Signup Example: Alpha123	Y*	string Length <= 20
USER_PASSWORD	Password Associated to the Account Example: Beta1@two	Y*	string Length <= 20
ACCOUNT_NO	Unique Admin Number Associated to the Card Example: 1234567890	Y*	string Length = 10 digits
CARD_NUMBER	16-digit Card Number Example: 1234567890	Y*	string Length = 16 digits
PIN	4-digit Pin Associated to Card Example: 1234	Y*	string Length = 4 digits
CARDTYPE	Type of Card Example: MasterCard , VISA, Discover, etc.	N	string Length = 3
LANG	Communication Language Example: EN,ES etc.	N	string Length = 3
ANI	ANI Number, Used for reporting and error tracking	N	string Length <= 30
DNIS	DNIS Number, Used for reporting and error tracking	N	string Length <= 30

Note:

(Y*)Any ONE of the following Combinations must be present

(CARD_NUMBER,PIN)
(CARD_USERID,PIN)
(ACCOUNT_NO,PIN)
(CARD_NUMBER,USER_PASSWORD)
(ACCOUNT_NO,USER_PASSWORD)
(CARD_USERID,USER_PASSWORD)
(CARD_NUMBER,PIN,CARD_USERID,USER_PASSWORD,ACCOUNT_NO)

Return Values

MessageResponse

Property	Description	Type
ERRMSG	Error message	string Length <= 20
ERR_NUMBER	Error number for the returns message	Numeric Length = 3
ERROR_FOUND	If any error found, then “Yes” else “No”	string Length <= 3
FIRSTNAME	First Name	string Length <= 40
MIDDLENAME	Middle Name	string Length <= 40
LASTNAME	Last Name	string Length <= 40
ADDRESS1	Address Line1	string Length <= 40
ADDRESS2	Address Line2	string Length <= 40
ADDRESS3	Address Line3	string Length <= 40
CITY	City	string Length <= 40
STATE	State	string Length <= 40
COUNTRY	Country	string Length <= 40
POSTALCODE	Postal Code	string Length <= 10
PHONE	Phone	string Length <= 19
EMAIL	Email	string Length <= 100
SECURITYQUESTION	Security Question	string Length <= 100
SECURITYANSWER	Security Answer	string Length <= 100
ALERT_DAILY_BAL_TIME	Daily Balance Time Alert	DateTime Length <= 8
ALERT_DAILY_BALANCE	Daily Balance Alert	Currency Length <= 30
ALERT_DIRECT_DEPOSIT	Direct Deposit Alert	Currency Length <= 30
ALERT_FUNDS_TRANSFER	Funds Transfer Alert	string
ALERT_INSF	Insufficient Fund Alert	string
ALERT_LOW_BALANCE	Low Balance Alert	Currency Length <= 30
ALERT_LOW_BALANCE_AM	Low Balance AM alert	Numeric
ALERT_MONTHLY_BAL	Monthly Balance Alert	Currency Length <= 30
ALERT_ONLINE_PASSWRD	Online Password Alert	string
ALERT_ONLINE_SIGNON	Online Sign-on Alert	string
ALERT_ONLINE_USER	Online User Alert	string
ALERT_TRANS_OVER	Transaction Over Alert	string
ALERT_TRANS_OVER_AMT	Transaction Over Amount Alert	string
ALERT_WEEKLY_BAL_DAY	Weekly Day Balance Alert	Numeric
ALERT_WEEKLY_BALANCE	Weekly Balance Alert	Currency Length <= 30
HISTORY_SORT	HISTORY_SORT	string
SKIN	Skin	string
DATE_SEARCH	YYYYDD	DateTime Length <= 8
SMS_PROVIDER	SMS Provider	string
SMS_PHONE	SMS Phone Number	string
SMS_EMAIL	SMS Email ID	string
LAST_LOGIN_DATE	Last Login Date (YYYYMMDD)	DateTime Length = 8
LAST_LOGIN_TIME	Last Login Time	DateTime Length = 8
CARD_BALANCE	Card Balance	Currency Length <= 30
ALLOW_C2C	Allow C2C	string Length = 2
ALLOW_ATM	Allow ATM	string Length = 2
ALLOW_DDP	Allow DDP	string Length = 2
ALLOW_CHK	Allow CHK	string Length = 2
ALLOW_CMP	Allow CMP	string Length = 2
REGISTERED	Registered	string
ADMIN_NUMBER	Admin Number	string
CARDTYPE	Card Type	string Length = 2
REQUIRE_PIN_CHG	Require PIN Change?	string
REQUIRE_SSN	Require SSN?	string Length = 9
REQUIRE_DOB	Require Date of Birth?	string
REQUIRE_PASS_CHG	Require Password Change?	string

REST

Method: POST

Urls:

Production:	https://api.fvfn.net/fvfnunvwebapi/core/Login
SandBox:	https://api.firstviewcorp.com/fvfnunvwebapi/core/Login

JSON Request:

{
  "CARD_USERID": null,
  "USER_PASSWORD": null,
  "ACCOUNT_NO": null,
  "CARD_NUMBER": null,
  "PIN": null,
  "CARDTYPE": null,
  "LANG": null,
  "ANI": null,
  "DNIS": null 
}

Response:

{
  "ERRMSG": null,
  "ERR_NUMBER": null,
  "ERROR_FOUND": null,
  "FIRSTNAME": null,
  "MIDDLENAME": null,
  "LASTNAME": null,
  "ADDRESS1": null,
  "ADDRESS2": null,
  "ADDRESS3": null,
  "CITY": null,
  "STATE": null,
  "COUNTRY": null,
  "POSTALCODE": null,
  "PHONE": null,
  "EMAIL": null,
  "SECURITYQUESTION": null,
  "SECURITYANSWER": null,
  "ALERT_DAILY_BAL_TIME": null,
  "ALERT_DAILY_BALANCE": null,
  "ALERT_DIRECT_DEPOSIT": null,
  "ALERT_FUNDS_TRANSFER": null,
  "ALERT_INSF": null,
  "ALERT_LOW_BALANCE": null,
  "ALERT_LOW_BALANCE_AM": null,
  "ALERT_MONTHLY_BAL": null,
  "ALERT_ONLINE_PASSWRD": null,
  "ALERT_ONLINE_SIGNON": null,
  "ALERT_ONLINE_USER": null,
  "ALERT_TRANS_OVER": null,
  "ALERT_TRANS_OVER_AMT": null,
  "ALERT_WEEKLY_BAL_DAY": null,
  "ALERT_WEEKLY_BALANCE": null,
  "HISTORY_SORT": null,
  "SKIN": null,
  "DATE_SEARCH": null,
  "SMS_PROVIDER": null,
  "SMS_PHONE": null,
  "SMS_EMAIL": null,
  "LAST_LOGIN_DATE": null,
  "LAST_LOGIN_TIME": null,
  "CARD_BALANCE": null,
  "ALLOW_C2C": null,
  "ALLOW_ATM": null,
  "ALLOW_DDP": null,
  "ALLOW_CHK": null,
  "ALLOW_CMP": null,
  "REGISTERED": null,
  "ADMIN_NUMBER": null,
  "TRANSACTION_FEE_LIST" []: {
	"FEE_TYPE": null,
	"FEE_DESC": null,
	"FEE_AMT": null
  },
  "CARDTYPE": null,
  "REQUIRE_PIN_CHG": null,
  "REQUIRE_SSN": null,
  "REQUIRE_DOB": null,
  "REQUIRE_PASS_CHG": null 
}

Login API