Cencora Financial Services API Documentation

Description

Using this Token Lookup API, Clients can get the details of their customer accounts.

Request Parameters

Y = Required, Y* = Conditional, Z = Field is present when the APIResponseType is "Partial" , 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
APIResponseType	If APIResponseType type is partial then system will only limit the response to give back whether token is valid or not. Else, system responds with all other details related to token. Default value is 0 (partial) 1 - Partial 0 - Full (default)	N	AlphaNumeric, 1

Return Values

MessageResponse

Property	Description	Required	Type
Status			object
. APIResponseCode	API Response Code. (00-Success)	Y, Z	AlphaNumeric, 4
. APIReasonDescription	API Reason Description	Y, Z	AlphaNumeric, 64
. APIResponseDateTime	API Response Datetime for the Request in UTC format	Y, Z	datetime
. APIUniqueReferenceID	UDID. API Unique reference number	Y, Z	AlphaNumeric, 64
Service			object, array
. ServiceType	Payment service type. (Debit,Check,ACH,PullPay,PushPay)	N, Z	AlphaNumeric, 2
. ResponseCode	Response Code	N, Z	AlphaNumeric, 4
. ReasonDescription	Reason Description	N, Z	AlphaNumeric, 64
Token			object
. CardTokenID	16 digit Unique Token for the Card Number.	N, Z	AlphaNumeric, 22
. Cardnumberlast4	Cencora Financial Services's internal accountnumber	N, Z	AlphaNumeric, 16
. AccountNumber	Card network type. Visa, Master Card, etc	N, Z	AlphaNumeric, 22
. TokenStatus	Token Status	N, Z	AlphaNumeric, 32
CurrentBalance	Balance on DebitCard if applicable	N, Z	Money
AvailableBalance	Available Balance on DebitCard if applicable	N, Z	Money
AccountID	Customer UniqueID in their system	N	AlphaNumeric, 20 Allowed Special character(s) is/are -
SecondaryAccountID	SecondaryAccountID	N	AlphaNumeric, 20 Allowed Special character(s) is/are -
SmsOptIn	Flag that specifies whether to opt-in / out SMS messages to given phone number. Possible values: 1 (Yes) 0 (No)	N	AlphaNumeric, 1
RegistrationType	Registration Type of Customer Account. Options are: 0 - Patient 1 - Physician 2 - Pharmacy 3 - Entity	N	AlphaNumeric, 2
DemographicInfo			object
. Name			object
. . Firstname	First Name of the person receiving card, or the practice.	N	AlphaNumeric, 50 Allowed Special character(s) is/are \,'._@- space
. . Middlename	Middle Name, If applicable	N	AlphaNumeric, 50 Allowed Special character(s) is/are \,'._@- space
. . Lastname	Last Name of the person receiving card, or doctors name under the practice.	N	AlphaNumeric, 50 Allowed Special character(s) is/are \,'._@- space
. DateOfBirth	Customer's DateOfBirth in MMDDYYYY format	N	AlphaNumeric, 8
. Address			object
. . Addressline1	Address of the patient, doctors office.	N	AlphaNumeric, 64
. . Addressline2	Additional address information.	N	AlphaNumeric, 64
. . City	City	N	AlphaNumeric, 24
. . State	State or province of the address.	N	Alphanumeric, 2
. . PostalCode	Postal code for the address. The postal code must consist of 5 to 9 digits. Ex. 30328 or 30328-4221	N	Numeric, 10 Allowed Special character(s) is/are -
. . Country	Country of the address. Use the two-character ISO Standard Country Codes	N	AlphaNumeric, 2
. Email	Email of the registered, including the full domain name.	N	AlphaNumeric, 100
. Phone			object
. . Phonenumber1	Phone number of the registered.	N	Numeric, 10
. . Phonenumber2	Alternate phone number.	N	Numeric, 10
. Gender	Gender M = Male F = Female	N	AlphaNumeric
. SocialSecurityNumber	SocialSecurityNumber	N	Numeric, 9
ShippingAddress			object
. Entityname	Shipping Entity Name.	N	AlphaNumeric, 50 Allowed Special character(s) is/are \/,'._@#- space
. Contactname	Shipping Contact Name	N	AlphaNumeric, 50 Allowed Special character(s) is/are \/,'._@#- space
. Addressline1	Address of the patient, doctors office.	N	AlphaNumeric, 64
. Addressline2	Additional address information.	N	AlphaNumeric, 64
. City	City	N	AlphaNumeric, 24
. State	State or province of the address.	N	Alphanumeric, 2
. Country	Country of the address. Use the two-character ISO Standard Country Codes	N	Alphanumeric, 2
. Zip	ZIP code of the shipping address. The ZIP code must consist of 5 to 9 digits. Ex. 30328 or 30328-4221	N	Numeric, 10 Allowed Special character(s) is/are -
PaymentOptions			object
. Payee			object
. . Email	Email for virtual card, pull pay, ACH (email for certification for non plastic cards)	N	AlphaNumeric, 100
. . PhoneNumber	Phone number for virtual card, pull pay, ACH etc. Who we would call for payments	N	AlphaNumeric, 15
. Careof	Care Of	N	AlphaNumeric, 50 Allowed special character(s) is/are \,'._@- space
. PaymentChoice	Possible Payment Choices are 0 - All (All payment types the program support) 1 - Debit VirtualCard 2 - Debit PlasticCard 3 - Debit Virtual and PlasticCard 4 - Check 5 - ACH	N	AlphaNumeric, 2
. ACH			object
. . RecipientName	Recipient Name.	N	AlphaNumeric, 50
. . RecipientNickName	Recipient Nick Name.	N	AlphaNumeric, 17
. . RoutingNumber	Routing Number	N	AlphaNumeric, 17
. . BankAccountNumber	Bank Account Number.	N	AlphaNumeric, 17
. . TransferType	Funds Transfer Type - Card to Bank is pushing funds to your external bank account, bank to card means you are pulling funds to you account on file. Does not apply since we will be capturing and defaulting at the portal level for your solution. 0 - Card To Card 1 - Bank To Card	N	AlphaNumeric, 1
. . AccountType	Recipient Account Type. 0 - Checking 1 - Savings	N	AlphaNumeric, 1
. Check			object
. PushPay			object
. PullPay			object
HealthCare			object
. MemberID	Customer's Health Care Member ID	N	AlphaNumeric, 16
. ProcessID	Customer's Health Care Process ID	N	AlphaNumeric, 16
. GroupID	Customer's Health Care Group ID	N	AlphaNumeric, 16
. SubscriberID	Customer's Health Care Subscriber ID	N	AlphaNumeric, 16
. PolicyID	Customer's Health Care Policy ID	N	AlphaNumeric, 16
. PlanType	Customer's Health Care Plan Type Possible Values are: 0 - Preferred Provider Organization (PPO) 1 - Point of Service (POS) 2 - Fee-for-Service (FFS) 3 - Health Maintenance Organization (HMO) 4 - Consumer-Driven Health Plans (CDHP) 5 - High Deductible Health Plan (HDHP) 6 - Health Reimbursement Arrangement (HRA) 7 - Health Savings Account (HSA)	N	AlphaNumeric, 2
. PhysicianID	Physician ID	N	AlphaNumeric, 16
. PharmacyID	Pharmacy ID	N	AlphaNumeric, 16
. CoPayInfo			object
. . CoPayInfo1	Customer's CoPay Information	N	AlphaNumeric, 32
. . CoPayInfo2	Customer's Additional CoPay Information	N	AlphaNumeric, 32
. . CoPayInfo3	Customer's Additional CoPay Information	N	AlphaNumeric, 32
. BIN			AlphaNumeric, 16
. PCN			AlphaNumeric, 16
. Rx			object
. . BIN	Rx BIN		AlphaNumeric, 16
. . PCN	Rx PCN		AlphaNumeric, 16
. . MemberID	Rx MemberID		AlphaNumeric, 16
. . GroupID	Rx GroupID		AlphaNumeric, 16
Reserved			object
. ReservedField1	Additional Information	N	AlphaNumeric, 32
. ReservedField2	Additional Information	N	AlphaNumeric, 32
. ReservedField3	Additional Information	N	AlphaNumeric, 32
. ReservedField4	Additional Information	N	AlphaNumeric, 32
. ReservedField5	Additional Information	N	AlphaNumeric, 32
Subscriber			object
. Dependent	0 - NO 1 - YES	N	Boolean
. SubscriberToken	SubscriberToken	Y*	AlphaNumeric, 16
Reconciliation	Reconciliation	N	Boolean
ClaimGroupNumber	ClaimGroupNumber	N	AlphaNumeric
InvoiceActionType	InvoiceActionType	N	Numeric, 1

REST

Method: POST

Urls:

Production:	https://api.fvfn.net/fvfnunvwebapi/registration/TokenLookup
SandBox:	https://api.firstviewcorp.com/fvfnunvwebapi/registration/TokenLookup

JSON Request:

{
  
  "TokenID": {},
  "CardNumber": {},
  "Accountnumber": {},
  "APIResponseType": {}
}

Response:

{
     "Status": 
        {
            "APIResponseCode": {},
            "APIReasonDescription": {},
            "APIResponseDateTime": {},
            "APIUniqueReferenceID": {}
        },
     "Service": [
		{
			"ServiceType": {},
            "ResponseCode": {},
            "ReasonDescription": {}
		},
				{
			"ServiceType": {},
            "ResponseCode": {},
            "ReasonDescription": {}
		}
		],

     "Token": 
        {
            "CardTokenID": {},
            "Cardnumberlast4": {},
            "Accountnumber": {},
            "TokenStatus": {}
        },
	  "CurrentBalance": {},
	  "AvailableBalance": {},	
      "AccountID": {},
	  "SecondaryAccountID": {},
	  "SmsOptIn":{},
	  "RegistrationType":{},
	  "DemographicInfo": {
		  "Name": {
			"Firstname":{},
            "Middlename":{},
			"Lastname": {}
		  },
		  "DateOfBirth": {},
		  "Address": {
			"Addressline1": {},
			"Addressline2": {},
			"City":{},
			"State": {},
			"PostalCode": {},
			"Country": {}
		  },
		  "Email": {},
		  "Phone": {
			"Phonenumber1": {},
			"Phonenumber2": {}
		  }
	  },
	  "ShippingAddress": {
			"EntityName": {}
			"ContactName": {}
			"Addressline1": {},
			"Addressline2": {},
			"City":{},
			"State": {},
            "Country":{},
			"Zip": {},
		  },
	  "PaymentOptions": {
			"Payee": {
				"Email": {},
				"Phonenumber": {},
			},
			"CareOf":{},
			"PaymentChoice":  {},
			"ACH":{
				"RecipientName": {},      
				"RecipientNickName":{},       
				"BankAccountNumber":{},       
				"RoutingNumber":{},       
				"AccountType":{},     
				"TransferType":{}     
			},
			"Check": {},
			"PushPay": {},
			"PullPay": {}
		},
	  "HealthCare": {
		"MemberID": {},
		"ProcessID": {},
		"GroupID": {},
		"SubscriberID": {},
		"PolicyID": {},
		"PlanType":{},
		"PhysicianID":{},
		"PharmacyID":{},
		"CoPayInfo":{
			"CoPayInfo1":{},
			"CoPayInfo2":{},
			"CoPayInfo3":{}
		},
        "BIN":{},
        "PCN":{},
        "Rx":{
            "BIN":{},
            "PCN":{},
            "MemberID":{},
            "GroupID":{}
        }
	  },
	  "Reserved":{
		"ReservedField2": {},
		"ReservedField3": {},
		"ReservedField4": {},
		"ReservedField1": {},
		"ReservedField5": {}
	  },
      "Subscriber":{
        "Dependent":{},
        "SubscriberToken":{}
      },
      "Reconciliation":{},
      "ClaimGroupNumber":{},
      "InvoiceActionType":{}
}

Token Lookup API