FV API Documentation

Description

This API helps to Get Details of Recipient(s).

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
RecipientName	Name of Recipient Mandatory When DecisionFlag is 2	Y*	string Length <= 50
BankAccountNumber	Recipient Bank Account Number Example: 1234123412341234	Y*	string Length <= 17 digits
RoutingNumber	Routing Number of financial institution Example: 123456789	Y*	string Length = 9 digits
TransactionID	UniqueID of any Previous Transaction belongs to Recipient Example: 1234567890	Y*	string Length <= 20 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*)-RecipientName (or) BankAccountNumber (or) RoutingNumber (or) TransactionID 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
RecipientInformation		object
. ClientName	Client Name.	string Length <= 60
. CardNumber	16-digit Card Number	string Length = 16 - digits
. ProxyNumber	UniqueID of Recipient. When value of DecisionFlag=1.	string Length <= 19 - digits
. FundTransferDate	Date on which Fund was Transferred.	DateTime
. BankAccountStatus	Recipient's Bank Account Status. 0 - Inactive; 1 - Active	string Length = 1 - digit
. BankAccountNumber	Recipient's Bank Account Number.	string Length <= 17
. RecipientName	First Name of Recipient.	string Length <= 50

REST

Method: POST

Urls:

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

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,
"TransactionID": null,
"RoutingNumber": null,
"BankAccountNumber": null,
"RecipientName": null
}

Response:

{
  "ErrorMessage": null,
  "ErrorNumber": null,
  "ErrorFound": null,
  "RecipientInformation": [
            {
                "ClientName": null,
                "CardNumber": null,
                "ProxyNumber": null,
                "FundTransferDate": null,
                "BankAccountStatus": null,
                "BankAccountNumber": null,
                "RecipientName": null
            }
        ]
}

RecipientBankInformation API