FV API Documentation

Description

This API helps to Validate 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
CLIENT_ID	Reserved Field For Future Use	N	string
CLIENT_PASSWORD	Reserved Field For Future Use	N	string
LOCATION_ID	Reserved Field For Future Use	N	string
LOCATION_CITY	Reserved Field For Future Use	N	string
LOCATION_STATE	Reserved Field For Future Use	N	string
LOCATION_COUNTRY	Reserved Field For Future Use	N	string
EMPLOYEE_PIN	Reserved Field For Future Use	N	string
CARD_NUMBER	16-digit Card Number Example: 1234123412341234	Y*	string Length = 16 digits
ACCOUNT_NO	19-digit Account Number Example: 1234123412341234123	Y*	string Length = 19 digits
DDA_NO	19-digit Account Number Example: 1234123412341234123	Y*	string Length = 19 digits
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*)CARD_NUMBER OR ACCOUNT_NO OR DDA_NOmust be present in Request

Return Values

MessageResponse

Property	Description	Type
ERRMSG	Error message	string Length <= 30
ERR_NUMBER	Error number for the returns message	Numeric Length <= 19
ERROR_FOUND	If any error found, then “Yes” else “No”	string Length <= 3
CARD_NUMBER	Card Number Associated to Account	string Length = 16
ACCOUNT_NO	Unique Embossing Number Associated to Card Example: 123456	string Length >= 6 digits
DDA_NO	DDA Number Associated to Account Example: 123456123456	string Length <= 19 digits
CARD_STATUS	Status of Card Possible Values are ACTIVE / INACTIVE Example: ACTIVE	string Length <= 8
MANUAL_CARD_STATUS	Manual Card Status of Card Example: 123456123456	string Length <= 10
CURRENT_CARD_BALANCE	Current Balance of Card Example: 123.56	money
FIRSTNAME	First Name of the account holder Example: JOhn	string Length <= 50
MIDDLENAME	First Name of the account holder Example: David	string Length <= 50
LASTNAME	Last Name of the account holder Example: JOhn	string Length <= 50
ADDRESS1	Address of Account holder without any Special Characters (NO PO BOX ALLOWED) Example: 2000 RiverEdge	string Length <= 40
ADDRESS2	Additional Address of Account holder without any Special Characters (NO PO BOX ALLOWED) Example: S580	string Length <= 40
CITY	City the address belongs to Example: Atlanta	string Length <= 40
STATE	State the address belongs to Example: GA	string Length = 2
POSTALCODE	Postal Code the address belongs to Example: 12345 or 12345-1234	string Length = 10
COUNTRY_CODE	Country where the ID is issued Example: USA	string Length = 5
CARDHOLDER_IDENTIFIED	Indicates Whether Demographic Info Present for Card or Not (YES / NO) Example: YES - Incase of Details Not Present Example: NO - Incase of Details Present	string Length <= 3
ACTIVATION_REQUIRED	Indicates Whether Activation Required for Card or Not (YES / NO) Example: YES	string Length <= 3
BSAccountNumber	Account Number Associated to Card	string Length <= 19 digits
ExpirationDate	Expiration of Card Example: MMYYYY	Y	string Length = 6 digits

REST

Method: POST

Urls:

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

JSON Request:

{
  "CLIENT_ID": null,
  "CLIENT_PASSWORD": null,
  "LOCATION_ID": null,
  "LOCATION_CITY": null,
  "LOCATION_STATE": null,
  "LOCATION_COUNTRY": null,
  "EMPLOYEE_PIN": null,
  "CARD_NUMBER": null,
  "ACCOUNT_NO": null,
  "DDA_NO": null,
  "ANI": null,
  "DNIS": null
}

Response:

{
  "ERROR_FOUND": null,
  "ERR_NUMBER": null,
  "ERRMSG": null,
  "CARD_NUMBER": null,
  "ACCOUNT_NO": null,
  "DDA_NO": null,
  "CARD_STATUS": null,
  "MANUAL_CARD_STATUS": null,
  "CURRENT_CARD_BALANCE": null,
  "FIRSTNAME": null,
  "MIDDLENAME": null,
  "LASTNAME": null,
  "ADDRESS1": null,
  "ADDRESS2": null,
  "CITY": null,
  "STATE": null,
  "POSTALCODE": null,
  "COUNTRY_CODE": null,
  "CARDHOLDER_IDENTIFIED": null,
  "ACTIVATION_REQUIRED": null,
  "BSAccountNumber": null,
  "ExpirationDate": null
}

ValidateCard API