Transactions API
Description
This API helps to Retrive Transactions on the 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 |
|---|---|---|---|
| ACCOUNT_NO |
Card Holder Account Number Example: 1234123412341234 |
Y* |
string Length = 16 digits |
| CARD_NUMBER |
16-digit Card Number Example: 1234123412341234 |
Y* |
string Length = 16 digits |
| NUMBEROFDAYS |
Number of Look Back Days (If NUMBEROFDAYS is provided, the NOOFTRANSACTIONS, LASTTRANSACTION, FROMDATE nor TODATE can be specified.) Example: 10 |
Y* |
int |
| NOOFTRANSACTIONS |
Number of Transactions to be Retrived (Is not valid when NUMBER_OF_DAYS is provided) Example: 10 |
Y* |
int |
| LASTTRANSACTION |
ID of Last Transaction (Is not valid when NUMBER_OF_DAYS is provided) Example: 12345678 |
Y* |
string Length <= 16-digits |
| FromDate |
Date From When Transactions need to be Retrived YYYYDDMM format Example: 19700101 |
Y* |
Date |
| ToDate |
Date until When Transactions need to be Retrived YYYYDDMM foramt Example: 19700101 |
Y* |
Date |
| 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 must be present in Request
Return Values
MessageResponse
| Property | Description | Type |
|---|---|---|
|
ERRMSG |
Error message |
string Length <= 20 |
|
ERR_NUMBER |
Error number for the returns message |
Numeric Length = 3 |
|
ERROR_FOUND |
If any error found, then “Yes” else “No” |
string Length <= 3 |
| LastTransaction |
ID of Last Transaction Example: 12345678 |
string Length <= 16 digits |
| BeginningBalance |
Card Holder Account Bigining Balance as of First Transaction in the List Example: 123.12 |
money |
| EndingBalance |
Card Holder Account Ending Balance as of Last Transaction in the List Example: 123.12 |
money |
| TotalCredit |
Total Amount of Credits in the Retriived Transaction List Example: 123.12 |
money |
| TotalDebit |
Total Amount of Debits in the Retriived Transaction List Example: 123.12 |
money |
| TotalFees |
Total Amount of Fees in the Retriived Transaction List Example: 123.12 |
money |
| TransactionDT |
Reponse DateTime in UTC format Example: 4/15/2020 3:31:27 PM |
DateTime |
| CurrentCardBalance |
Card Holder Account Current Balance Example: 123.12 |
money |
| ExpirationDate |
Card Expiration Date in MM/DD/YYYY format Example: 01/01/1970 |
Date |
|
TransactionList |
object |
|
| . TransactionDate |
Date of Transaction in MM/DD/YYYY format Example: 01/01/1970 |
Date |
| . Time |
Time of Transaction in HHMMSS format Example: 235959 |
string Length = 6 |
| . Amount |
Transaction Amount Example: 123.12 |
money |
| . Fee |
Fee associated to Transaction Example: 123.12 |
money |
| . Status |
Status of Transaction Example: Settled |
String Length <= 16 |
| . TransactionType |
Credit / Debit Transaction Example: Credit |
string Length <= 16 |
| . TransactionMcc |
MCC Terminal ID Example: A1365 |
string Length = 5 |
| . Description1 |
Description of Transaction Example: Test Transaction |
string Length <= 50 |
| . Description2 |
Additional Description of Transaction Example: Test Transaction |
string Length <= 50 |
| . Description3 |
Additional Description of Transaction Example: Test Transaction |
string Length <= 50 |
| . Description4 |
Additional Description of Transaction Example: Test Transaction |
string Length <= 50 |
| . TransactionNumber |
Unique Number Associated to Transaction Example: 123456789 |
string Length <= 16 - digits |
| . TransactionLifeCycleUniqueID |
Additional Unique Number Associated to Transaction Example: 123456789 |
string Length <= 16 - digits |
| . MerchantID |
Merchant ID Example: 123545 |
string Length <= 16 - digits |
| . MerchantName |
Name of Merchant Example: abc store |
string Length <= 50 |
| . MerchantCity |
City of Merchant Example: Atlanta |
string Length <= 32 |
| . MerchantState |
State of Merchant Example: GA |
string Length = 2 |
REST
Method: POST
Urls:
| Production: | https://api.fvfn.net/fvfnunvwebapi/core/Transactions |
| SandBox: | https://api.firstviewcorp.com/fvfnunvwebapi/core/Transactions |
JSON Request:
{
"CARD_NUMBER": null,
"ACCOUNT_NO": null,
"NUMBEROFDAYS": null,
"NOOFTRANSACTIONS": null,
"LASTTRANSACTION": null,
"FROMDATE": null,
"TODATE": null,
"ANI": null,
"DNIS": null
}
Response:
{
"ErrorMsg": null,
"ErrorNumber": null,
"ErrorFound": null,
"TransactionList": [
{
"TransactionDate": null,
"Time": null,
"Fee": null,
"Amount": null,
"Status": null,
"TransactionType": null,
"TransactionMcc": null,
"Description1": null,
"Description2": null,
"Description3": null,
"Description4": null,
"TransactionNumber": null,
"TransactionLifeCycleUniqueID": null,
"MerchantID": null,
"MerchantName": null,
"MerchantCity": null,
"MerchantState": null
}
],
"LastTransaction": null,
"BeginningBalance": null,
"EndingBalance": null,
"TotalCredit": null,
"TotalDebit": null,
"TotalFees": null,
"CurrentCardBalance": null,
"ExpirationDate": null
}