Clearing API
Description
This API helps to Load Funds to Card / UnLoad Funds from 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 |
|---|---|---|---|
| MessageTypeIdentifier |
Indicates Load / Unload Example: 01 |
Y |
string Length = 4 digits |
| CustNbr |
Card Holder Account Number Example: 1234123412341234123 |
Y* |
string Length = 19 digits |
| PrimaryAccountNumber |
16-digit Card Number Example: 1234123412341234 |
Y* |
string Length = 16 digits |
| TranType |
FirstView Provided, Monetary Transaction Code Example: 00123 |
Y |
string Length = 5 digits |
| TransactionAmount |
Transaction Amount (Should be Same as Original Incase of Reversal) Example: 123.12 |
Y |
money |
| TransmissionDateTime |
Timestamp When FirstView Receives, Original Transaction Timestamp Incase of Reversal in MM/DD/YYYY HH:MM:SS foramt Example: 01/01/1970 10:10:59 |
Y |
DateTime |
| LineItemSeqNumber |
Line Item’s Sequence Number Example: 1 |
N |
int |
| InventoryCode |
Inventory Code Example: 1 |
N |
int |
| Quantity |
Number of Items Example: 5 |
N |
int |
| UnitPrice |
Unit Price Example: 1.25 |
N |
money |
| CreditPlanMaster |
Credit Plan Master Number, Regular Revolving Example: 2 |
N |
int (upto 4-digits) |
| TransactionDescription |
Description of Transaction Example: Test Transaction |
Y |
string Length <= 100 |
| TransactionCurrencyCode |
Currency of Transaction Example: 840 |
Y |
string Length = 3 - digits |
| SpecialMerchantIdentifier |
Sales Person ID Example: A1345 |
N |
string Length <= 3 |
| CardAcceptorIdCode |
Merchant ID Example: A1345 |
Y |
string Length <= 6 |
| CardAcceptorTerminalID |
Merchant POS Terminal ID Example: A1345 |
Y |
string Length <= 15 |
| CardAcceptorBusinessCode |
Store ID Example: 1345 |
Y |
string Length <= 15 |
| DateTimeLocalTransaction |
Local Timestamp of Transaction in MM/DD/YYYY HH:MM:SS foramt Example: 01/01/1970 10:10:59 |
Y |
DateTime |
| SystemTraceAuditNumber |
Unique ID of the original authorization message Example: 121245 |
N |
int (upto 6-digits) |
| MerchantType |
Merchant category code Example: 1234 |
N |
int (upto 4-digits) |
| RetrievalReferenceNumber |
Order # or Invoice # Example: 123456789123 |
N |
string Length <= 15 |
| ApprovalCode |
Authorization approval code Example: 123456 |
N |
int (upto 6 digits) |
| TNPFlag |
Leave as Blank |
N |
string |
| ADMIN_NO |
Leave as Blank |
N |
string |
| LoadType |
Leave as Blank |
N |
string |
Note:
(Y*)PrimaryAccountNumber OR CustNbr must be present in Request
Return Values
MessageResponse
| Property | Description | Type |
|---|---|---|
| MessageTypeIdentifier |
Indicates Load / Unload Example: 01 |
string Length = 4 digits |
| CustNbr |
Card Holder Account Number Example: 1234123412341234 |
string Length = 16 digits |
| PrimaryAccountNumber |
16-digit Card Number Example: 1234********1234 |
string Length = 16 digits |
| TranType |
FirstView Provided, Monetary Transaction Code Example: 00123 |
string Length = 5 digits |
| TransactionAmount |
Transaction Amount (Should be Same as Original Incase of Reversal) Example: 123.12 |
money |
| TransmissionDateTime |
Timestamp When FirstView Receives, Original Transaction Timestamp Incase of Reversal in MM/DD/YYYY HH:MM:SS foramt Example: 01/01/1970 10:10:59 |
DateTime |
| LineItemSeqNumber |
Line Item’s Sequence Number Example: 1 |
int |
| InventoryCode |
Inventory Code Example: 1 |
int |
| Quantity |
Number of Items Example: 5 |
int |
| UnitPrice |
Unit Price Example: 1.25 |
money |
| CreditPlanMaster |
Credit Plan Master Number, Regular Revolving Example: 2 |
int (upto 6-digits) |
| TransactionDescription |
Description of Transaction Example: Test Transaction |
string Length <= 100 |
| TransactionCurrencyCode |
Currency of Transaction Example: 840 |
string Length = 3 digits |
| SpecialMerchantIdentifier |
Sales Person ID Example: A1345 |
string Length <= 5 |
| CardAcceptorIdCode |
Merchant ID Example: A1345 |
string Length <= 15 |
| CardAcceptorTerminalID |
Merchant POS Terminal ID Example: A1345 |
string Length <= 8 |
| CardAcceptorBusinessCode |
Store ID Example: 1345 |
string Length = 4 - digits |
| DateTimeLocalTransaction |
Local Timestamp of Transaction in YYYYDDMM HHMMSS foramt Example: 19700101 101059 |
DateTime |
| SystemTraceAuditNumber |
Unique ID of the original authorization message Example: 121245 |
int (upto 6-digits) |
| MerchantType |
Merchant category code Example: 1234 |
int (upto 4-digits) |
| RetrievalReferenceNumber |
Order # or Invoice # Example: 123456789123 |
string Length <= 12 - digits |
| ApprovalCode |
Authorization approval code Example: 123456 |
int (upto 6 digits) |
| TransactionFeeBnp |
Transaction Fee |
money |
| LateFeeBnp |
Transaction Late Fee |
money |
| MembershipFeeBnp |
Membership Fee |
money |
| OverLimitFeeBnp |
OverLimit Fee |
money |
| InsufficientFundFeeBnp |
Insufficient Funds Fee |
money |
| CollectionFeeBnp |
Collection Fee |
money |
| RecoveryFeeBnp |
Recovery Fee |
money |
| InsuranceBnp |
Insurance Amount |
money |
| InterestBnp |
Interest on Transaction |
money |
| CurrentBalance |
Current Balance on Card |
money |
| Principal |
Principal Amount |
money |
| DaysDelinquent |
Days Delinquent |
int |
| AmountDue |
Total Amount Due |
money |
| PastDue |
Past Amount Due |
money |
| PaymentDueDate |
Due Date For Payment |
Date |
| PostingFlag |
Transaction Posting Status |
int |
| PostingNote |
Transaction Posting Note |
string Length <= 100 |
| ADMIN_NO |
Unique Reference Number Associated For the Account in FirstView |
string Length <= 10 |
| TRANSACTION_ID |
Unique Reference ID for Transaction |
string Length <= 20 |
REST
Method: POST
Urls:
| Production: | https://api.fvfn.net/fvfnunvwebapi/core/Clearing |
| SandBox: | https://api.firstviewcorp.com/fvfnunvwebapi/core/Clearing |
JSON Request:
{
"MessageTypeIdentifier": null,
"CustNbr": null,
"PrimaryAccountNumber": null,
"TranType": null,
"TransactionAmount": null,
"TransmissionDateTime": null,
"LineItemSeqNumber": null,
"InventoryCode": null,
"Quantity": null,
"UnitPrice": null,
"CreditPlanMaster": null,
"TransactionDescription": null,
"TransactionCurrencyCode": null,
"SpecialMerchantIdentifier": null,
"CardAcceptorIdCode": null,
"CardAcceptorTerminalID": null,
"CardAcceptorBusinessCode": null,
"DateTimeLocalTransaction": null,
"SystemTraceAuditNumber": null,
"MerchantType": null,
"RetrievalReferenceNumber": null,
"ApprovalCode": null,
"TNPFlag": null,
"ADMIN_NO": null,
"LoadType": null
}
Response:
{
"MessageTypeIdentifier": null,
"CustNbr": null,
"PrimaryAccountNumber": null,
"TranType": null,
"TransactionAmount": null,
"TransmissionDateTime": null,
"LineItemSeqNumber": null,
"InventoryCode": null,
"Quantity": null,
"UnitPrice": null,
"CreditPlanMaster": null,
"TransactionDescription": null,
"TransactionCurrencyCode": null,
"SpecialMerchantIdentifier": null,
"CardAcceptorIdCode": null,
"CardAcceptorTerminalID": null,
"CardAcceptorBusinessCode": null,
"DateTimeLocalTransaction": null,
"SystemTraceAuditNumber": null,
"MerchantType": null,
"RetrievalReferenceNumber": null,
"ApprovalCode": null,
"TransactionFeeBnp": null,
"LateFeeBnp": null,
"MembershipFeeBnp": null,
"OverLimitFeeBnp": null,
"InsufficientFundFeeBnp": null,
"CollectionFeeBnp": null,
"RecoveryFeeBnp": null,
"InsuranceBnp": null,
"InterestBnp": null,
"CurrentBalance": null,
"Principal": null,
"DaysDelinquent": null,
"AmountDue": null,
"PastDue": null,
"PaymentDueDate": null,
"PostingFlag": null,
"PostingNote": null,
"ADMIN_NO": null,
"TRANSACTION_ID": null
}