FV API Documentation

Description

Using This API, Clients can Push Funds to Their Customer Accounts.

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

CardTokenID*

-[string(22)]--CardTokenID. This will be Shared while creating the Customer Account.

AccountID

-[string(32)]--Unique account/customer id for the merchant/partner.

CenterID

-[char(5)]--Clients CenterID

MerchantReferenceId*

-[string(50)]--Merchant-generated transaction reference or tracking number. FirstView recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction

TranAmmount*

-[string(16)]--Grand total for the transaction. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. System truncates the unit to the correct number of decimal places.

TranDescriptor

-[string(22)]--Transaction description appears on cardholder statement

Recipient_Firstname*

-[string(32)]--Recipient's First Name

Recipient_Lastname*

-[string(32)]--Recipient's Last Name

Recipient_AddressLine1

-[string(64)]--Recipient's current Address for Communication line 1

Recipient_AddressLine2

-[string(64)]--Recipient's current Address for Communication line 2

Recipient_City

-[string(32)]--City in which current the address located

Recipient_State

-[char(2)]--State (2-Letter Code) in which current address is located

Recipient_PostalCode

-[string(10)]--Postal Code for given address

Recipient_Country

-[char(2)]--Country in which current the address located

Recipient_Phonenumber

-[string(16)]--Recipient's Phone number for communication

Recipient_DOB

-[char(8)]--Recipient's DateOfBirth in MMDDYYYY format

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	CardTokenID	string (MaxLength = 22)	Unique Token for the Card Number
7	Cardnumberlast4	char[4]	Last Four Digits of the given Card Number
8	TranAmount	string (MaxLength = 16)	Transaction amount
9	AccountID	string (MaxLength = 32)	Unique account/customer id for the merchant/partner.
10	CenterID	string (MaxLength = 5)	Client's Center ID that Initiated the Transaction.
11	MerchantReferenceId	string (MaxLength = 50)	Merchant-generated transaction reference or tracking number

REST

Method: POST

Url: TBD

JSON Request:

{
  "CardTokenID": {},
  "AccountID": {},
  "CenterID": {},
  "MerchantReferenceId": {},
  "TranAmount": {},
  "TranDescriptor": {},
  "Recipient": {
    "Address": {
      "Addressline1": {},
      "Addressline2": {},
      "City": {},
      "State": {},
      "Country": {},
      "PostalCode": {}
    },
    "Name": {
      "FirstName": {},
      "LastName": {}
    },
    "DOB": {},
    "PhoneNumber": {}
  }
}

Response:

{
  "Response": {
    "APIResponseCode": {},
    "APIReasonDescription": {},
    "APIResponseDateTime": {},
    "APIUniqueReferenceID": {},
	"Type": {}
  },
  "TokenID": {},
  "Cardnumberlast4": {},
  "TranAmount": {},
  "AccountID": {},
  "CenterID": {},
  "MerchantReferenceId": {}
}

Push Payment API