Cencora Financial ServicesAPI Documentation

Description

Using this Transaction History API, Clients can retrieve the transaction history of their customer accounts.

Request Parameters

Y = Required, Y* = Conditional, X = Required when block is present and N = Optional

APIAccessToken*

-[string(256)]--Issued by Cencora Financial 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
TokenID	16 digit Unique Token of an account. Either Token or Card or Accountnumber is mandatory	Y*	Numeric, 16
CardNumber	Debit Card Number	Y*	Numeric, 16
AccountNumber	Cencora Financial Services's internal accountnumber	Y*	Numeric, 16
TxnHistoryType	Transaction Type. Options are: 0 - Debit Card 1 - ACH 2 - Check 4 - PushPay 5 - PullPay	Y	AlphaNumeric, 2
NUMBEROFDAYS	Number of Look Back Days (If NUMBEROFDAYS is provided, the NOOFTRANSACTIONS, LASTTRANSACTION, FROMDATE nor TODATE can be specified.)	Y*	AlphaNumeric, 3
NOOFTRANSACTIONS	Number of Transactions to be Retrived (Is not valid when NUMBER_OF_DAYS is provided)	Y*	AlphaNumeric, 3
LASTTRANSACTION	ID of Last Transaction (Is not valid when NUMBER_OF_DAYS is provided)	Y*	AlphaNumeric, 16
FromDate	UTC date time	Y*	DateTime
ToDate	UTC date time	Y*	DateTime

Return Values

MessageResponse

Property	Description	Required	Type
Status			object
. APIResponseCode	API Response Code. (00-Success)	Y	AlphaNumeric, 4
. APIReasonDescription	API Reason Description	Y	AlphaNumeric, 64
. APIResponseDateTime	API Response Datetime for the Request in UTC format	Y	datetime
. APIUniqueReferenceID	UDID. API Unique reference number	Y	AlphaNumeric, 64
TokenID	16 - 22 digit Unique Token for the Card Number.	N	AlphaNumeric, 22
LastTransaction	ID of Last Transaction, Example: 12345678	N	AlphaNumeric
BeginningBalance	Card Holder Account Bigining Balance as of First Transaction in the List, Example: 123.12	N	AlphaNumeric
EndingBalance	Card Holder Account Ending Balance as of Last Transaction in the List, Example: 123.12	N	AlphaNumeric
TotalCredit	Total Amount of Credits in the Retrieved Transaction List, Example: 123.12	N	AlphaNumeric
TotalDebit	Total Amount of Debits in the Retrieved Transaction List, Example: 123.12	N	AlphaNumeric
TotalFees	Total Amount of Fees in the Retrieved Transaction List, Example: 123.12	N	AlphaNumeric
CurrentCardBalance	Card Holder Account Current Balance, Example: 123.12	N	AlphaNumeric
ExpirationDate	Card Expiration Date in MM/DD/YYYY format, Example: 01/01/1970	N	AlphaNumeric
TransactionList			object, array
. Date	Date of Transaction in MM/DD/YYYY format Example: 01/01/1970	N	AlphaNumeric
. Time	Time of Transaction in HHMMSS format, Example: 235959	N	AlphaNumeric
. Amount	Transaction Amount, Example: 123.12	N	AlphaNumeric
. Fee	Fee associated to Transaction, Example: 123.12	N	AlphaNumeric
. Status	Status of Transaction, Example: Settled	N	AlphaNumeric
. Type	Credit / Debit Transaction, Example: Credit	N	AlphaNumeric
. MCC	MCC Terminal ID, Example: A1365	N	AlphaNumeric
. Description1	Description of Transaction, Example: Test Transaction	N	AlphaNumeric
. Description2	Additional Description of Transaction, Example: Test Transaction	N	AlphaNumeric
. Description3	Additional Description of Transaction, Example: Test Transaction	N	AlphaNumeric
. Description4	Additional Description of Transaction, Example: Test Transaction	N	AlphaNumeric
. TxnNumber	Unique Number Associated to Transaction, Example: 123456789	N	AlphaNumeric
. LifeCycleUniqueID	Additional Unique Number Associated to Transaction, Example: 123456789	N	AlphaNumeric
. MerchantID	Merchant ID, Example: 123545	N	AlphaNumeric
. MerchantName	Name of Merchant, Example: abc store	N	AlphaNumeric
. MerchantCity	City of Merchant, Example: Atlanta	N	AlphaNumeric
. MerchantState	State of Merchant, Example: GA	N	AlphaNumeric

REST

Method: POST

Urls:

Production:	https://api.fvfn.net/fvfnunvwebapi/Transaction/transactionhistory
SandBox:	https://qapi.fvfn.net/fvfnunvwebapi/Transaction/transactionhistory

JSON Request:

{

  "TokenID": {},
  "CardNumber": {},
  "Accountnumber": {},
  "TxnHistoryType": {},
  "NumberOfDays": {},
  "NumberOfTransactions": {},
  "LastTransaction": {},
  "FromDate": {},
  "ToDate": {}
}

Response:

{
     "Status":
        {
            "APIResponseCode": {},
            "APIReasonDescription": {},
            "APIResponseDateTime": {},
            "APIUniqueReferenceID": {}
        },
      "TokenID": {},
      "LastTransaction": {},
	  "BeginningBalance": {},
      "EndingBalance": {},
	  "TotalCredit": {},
	  "TotalDebit":{},
	  "TotalFees":{},
	  "CurrentCardBalance":{},
	  "ExpirationDate":{},
	  "TransactionList": [{
			"Date": {}
			"Time": {}
			"Amount": {},
			"Fee": {},
			"Status":{},
			"Type": {},
			"Mcc": {},
			"Description1": {}
			"Description2": {}
			"Description3": {},
			"Description4": {},
			"TxnNumber":{},
			"LifeCycleUniqueID": {},
			"MerchantID": {},
			"MerchantName": {}
			"MerchantCity": {}
			"MerchantState": {}
		  },
		  {
			"Date": {}
			"Time": {}
			"Amount": {},
			"Fee": {},
			"Status":{},
			"Type": {},
			"Mcc": {},
			"Description1": {}
			"Description2": {}
			"Description3": {},
			"Description4": {},
			"TxnNumber":{},
			"LifeCycleUniqueID": {},
			"MerchantID": {},
			"MerchantName": {}
			"MerchantCity": {}
			"MerchantState": {}
		  }]

}

Transaction History API