FV API Documentation

Description

This API helps to Search Recipient Infromation for a Card.

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
IPAddress	Source IP Address in xxx.xxx.xxx.xxx format Example: 123.123.123.123	N	string Length <= 15
UniqueIDFlag	Reserved for future use	N	string Length = 1 digit
UniqueID	Reserved for future use	N	string Length <= 19
Source	Source from where API Call is initiated. FirstView have multiple value of source for internal system Example: WEB	Y	string Length <= 10
APIVersion	Version of the API to be invoked. Please refer API Version mentioned in document header. It’s default value is 1.0 Example: 1.0	N	string Length <= 10
ApplicationVersion	Reserved for future use	N	string Length <= 100
CallerID	Reserved for future use	N	string Length <= 20
SessionID	Reserved for future use	N	string Length <= 8
RequestDate	Date of Request in YYYY-MM-DD hh:mm:ss format Example: 1970-01-01 10:10:59	N	string Length <= 19
CardNumber	16-digit Card Number Example: 1234123412341234	Y*	string Length = 16 digits
AccountNumber	19-digit Account Number Example: 1234123412341234123	Y*	string Length = 19 digits
TokenID	Firstview Issued Unique Reference Number for Card Example: 1234123412341234	Y*	string Length = 16 digits
DecisionFlag	Decision Flag, determines the Request functionality Possible Values: 1 - To get lists of Recipients of card to bank 2 - To get specific Recipient of card to bank on the basis of Recipient ID Example: 1	Y	string Length = 2 - digit
RecipientID	UniqueID of Recipient Bank Mandatory When DecisionFlag is 2	Y*	string Length <= 10 - digits
Language	Communication Language Example: EN,ES etc.	N	string Length = 2
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*)either CardNumber or AccountNumber or TokenID must be present in request

Return Values

MessageResponse

Property	Description	Type
ErrorMessage	Error message	string
ErrorNumber	Error number for the returns message	Numeric Length <= 10
ErrorFound	If any error found, then “Yes” else “No”	string Length <= 3
TransactionID	Credit Transaction ID	string Length <= 19 digit
BankAccountNumber	Recipient Bank Account Number	string Length <= 17
AccountType	Account Type 0 =Checking; 1 =Savings	string Length <= 9
RoutingNumber	Routing Number of Recipient Bank	string Length <= 9
FinancialInstitutionName	Name of Recipients Financial Institution	string Length <= 200
RecipientInformation		object
. Skey	Auto generated unique field.	string Length <= 10 - digits
. ProxyNumber	UniqueID of Recipient. When value of DecisionFlag=1.	string Length <= 19 - digits
. RecipientID	UniqueID of Recipient.	string Length <= 10 - digits
. RecipientName	First Name of Recipient.	string Length <= 50
. BankAccountNumber	Recipient's Bank Account Number.	string Length <= 17
. AccountType	Recipient's Bank Account Type. 0 - Checking; 1 - Saving	string Length <= 9 - digits
. RoutingNumber	Recipient's Bank Routing Number	string Length <= 9 - digits
. AddedOnDate	Date on which recipient was added	DateTime
. ActiveFlag	Recipient's Bank Active Flag. 0 - Inactive; 1 - Active	string Length <= 9 - digits
. RecipientDeleted	Date on which recipient was Deleted	DateTime
. RecipientNickNameName	Nick Name of Recipient.	string Length <= 50
. FinancialInstitutionName	Recipient's Financial Institution Name.	string Length <= 200
. TransferType	Transfer Type; 0 - Card To Bank; 1 - Bank To Card	string Length = 1
. BankAccountStatus	Recipient's Bank Account Status Possible Values: 0 - Awaiting Validation 1 - Validated 2 - failed 3 - Rejected Credit 4 - Rejected Debit 5 - Verified Rejected Debit 6 - Failed Rejected Debit 7 - Bank Change Notification 8 - No Validation Required	string Length = 1
. ValidationTriesCount	It gives how many times validation is tried.	string Length <= 5 - digits
. MicroDepostiReversed	Micro Deposit Reversed. 0 - False ; 1 - True	bool
. Deleted	Bank Recipient deleted. 0 - Active ; 1 - Deleted	string Length <= 2 - digits

REST

Method: POST

Urls:

Production:	https://api.fvfn.net/fvfnunvwebapi/ACH/CardToBankRecipientSearch
SandBox:	https://api.firstviewcorp.com/fvfnunvwebapi/ACH/CardToBankRecipientSearch

JSON Request:

{
  	"IPAddress": null,
	"UniqueIDFlag": null,
	"UniqueID": null,
	"Source": null,
	"APIVersion": null,
	"ApplicationVersion": null,
	"CallerID": null,
	"SessionID": null,
	"ANI": null,
	"DNS": null,
	"Language": null,
	"RequestDate": null,
	"CardNumber": null,
	"AccountNumber": null,
	"TokenID": null,
	"RecipientID": null,
	"DecisionFlag": null
}

Response:

{
  "ErrorMessage": null,
  "ErrorNumber": null,
  "ErrorFound": null,
  "TransactionID": null,
  "BankAccountNumber": null,
  "AccountType": null,
  "RoutingNumber": null,
  "DecisionFlag": null,
  "FinancialInstName": null,
  "RecipientName": null,
  "RecipientInformation": [
            {
                "Skey": null,
                "ProxyNumber": null,
                "RecipientID": null,
                "RecipientName": null,
                "BankAccountNumber": null,
                "AccountType": null,
                "RoutingNumber": null,
                "AddedOnDate": null,
                "AddedBankStatus": null,
                "RecipientDeleted": null,
                "RecipientNickName": null,
                "FinancialInstName": null,
                "TransferType": null,
                "BankAccountStatus": null,
                "ValidationTriesCount": null,
                "MicroDepostiReversed": null,
                "Deleted": null
            }
        ]
}

CardtoBankRecipientSearch API