CardtoBankAccount API
Description
This API helps to Add, Search, Transfer Funds from Card to External Bank Account (Recipient).
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 |
| RecipientID |
UniqueID of Recipient Bank Mandatory When DecisionFlag in [2, 5, 6, 7, 8] |
Y* |
string Length <= 10 - digits |
| RecipientName |
First Name of Recipient. Mandatory When DecisionFlag is 3 or 4 |
Y* |
string Length <= 50 |
| RecipientNickName |
First Name of Recipient. Mandatory When DecisionFlag in [3, 4, 7] |
Y* |
string Length <= 50 |
| BankAccountNumber |
Recipient's Bank Account Number. Mandatory When DecisionFlag in [3, 4, 7] |
Y* |
string Length <= 17 |
| ConfirmBankAccountNumber |
Recipient's Bank Account Number. Mandatory When DecisionFlag in [3, 4, 7] |
Y* |
string Length <= 17 |
| RoutingNumber |
Routing Number is a nine digit number used to identify financial institution. Mandatory When DecisionFlag is 3 or 4 |
Y* |
string Length <= 9 |
| TransactionAmount |
Amount to be Transfered, Mandatory When DecisionFlag is 2 or 4 Example: 1234.21 |
Y* |
currency |
| TransferType |
Type of Recipient, Mandatory When DecisionFlag is 3 Possible Values:
Example: 0 |
Y* |
string Length = 1 - digit |
| AccountType |
Recipient Account Type, Mandatory When DecisionFlag is 3 or 4 Possible Values:
Example: 0 |
Y* |
string Length = 1 - digit |
| BankAccountStatus |
Bank Status Possible Values:
Example: 1 |
Y* |
string Length = 1 - digit |
| AddedBankStatus |
Bank Account Status, Mandatory when DecisionFlag is 8 Possible Values:
Example: 1 |
Y* |
string Length = 1 - digit |
| DecisionFlag |
Decision Flag, determines the Request functionality Possible Values:
Example: 1 |
Y |
string Length = 2 - digit |
| 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 |
|
RecipientInfo |
object |
|
| . RecipientID |
UniqueID of Recipient. |
string Length <= 10 - digits |
| . RecipientName |
First Name of Recipient. |
string Length <= 50 |
| . RecipientNickName |
Nick Name of Recipient. |
string Length <= 50 |
| . TransferType |
Transfer Type |
string Length = 1 |
| . BankAccountStatus |
Recipient's Bank Account Status 1 - Active ; 0 - InActive |
string Length = 1 |
REST
Method: POST
Urls:
| Production: | https://api.fvfn.net/fvfnunvwebapi/ACH/CardToBankAccount |
| SandBox: | https://api.firstviewcorp.com/fvfnunvwebapi/ACH/CardToBankAccount |
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,
"RecipientName": null,
"RecipientNickName": null,
"BankAccountNumber": null,
"ConfirmBankAccountNumber": null,
"RoutingNumber": null,
"TransactionAmount": null,
"TransferType": null,
"BankAccountStatus": null,
"AccountType": null,
"AddedBankStatus": null,
"DecisionFlag": null
}
Response:
{
"ErrorMessage": null,
"ErrorNumber": null,
"ErrorFound": null,
"TransactionID": null,
"BankAccountNumber": null,
"AccountType": null,
"RoutingNumber": null,
"DecisionFlag": null,
"FinancialInstName": null,
"RecipientName": null,
"RecipientInfo": [
{
"RecipientID": null,
"RecipientNickName": null,
"RecipientName": null,
"AddedBankStatus": null,
"TransferType": null
}
]
}