1. Home
  2. Registration V2
  3. Load API

Load API

Last updated: August 7th, 2024

Description

Using this API, Clients can load 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 Services 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, required if AAT ON

 Y*

Numeric, 16
TokenIDRef

Token of account where claim/payment was justifying the load. Required to memo post into Phsician's/ or any referred account

Y*

Numeric, 16
PaymentType

Payment Type. Options are:

  • 0 - Debit Card
  • 1 - ACH
  • 2 - Check
  • 4 - PushPay
  • 5 - PullPay
 Y Numeric, 1
Transaction object
 . Type

2100 - Unloading Funds from a debit Card

2101 - Loading Funds into a debit Card

2102 - Reversing Funds from the debit Card

2103 - Loading funds into a check

2104 - Reversing/cancel funds from the check

2105 - ACH Funds Load

2106 - ACH Funds Unload

Unique transaction codes for all load/unload types shared by Cencora Financial Services. Load - loading the funds into a debit card, ach or check Unload - unload, refund or partial refund of the funds from a debit card, ach or check Reversal - Reversing a prior successful load. System requires the transaction id of original transaction in this case.

Y

AlphaNumeric, 5
 . Ref

Reference tansaction ID

Mandatory when the TranType is "Reversal"

 Y*

AlphaNumeric, 16
 . Amount Transaction Amount Y

Money
 . DateTime Transaction Time Y

DateTime
 . Description Transaction Description Y

AlphaNumeric, 50
DebitCard object
 . CardAcceptorIdCode CardAcceptorIdCode N

AlphaNumeric, 24
 . CardAcceptorTerminalID CardAcceptorTerminalID N

AlphaNumeric, 24
 . DateTimeLocalTransaction DateTimeLocalTransaction N

DateTime
 . SystemTraceAuditNumber SystemTraceAuditNumber N

AlphaNumeric, 24
 . MerchantType MerchantType N

AlphaNumeric, 24
 . RetrievalReferenceNumber RetrievalReferenceNumber N

AlphaNumeric, 24
 . ApprovalCode ApprovalCode N

AlphaNumeric, 6
Check object
 . CheckMemo Check Memo N

AlphaNumeric, 17
 . CheckRef1 CheckRef1 N

AlphaNumeric, 17
 . CheckRef2 CheckRef2 N

AlphaNumeric, 17
 . CheckRef3 CheckRef3 N

AlphaNumeric, 17
 . CheckRef4 CheckRef4 N

AlphaNumeric, 17
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
 .  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
 . SiteInfo object
 . . NPI Site NPI N

Numeric, 10
 . GeneralInfo object
 . . NDC National Drug Code N

AlphaNumeric, 50
 . ClaimsInfo object
 . . BIN Rx BIN number N

AlphaNumeric, 32
 . . PCN Processor control number N

AlphaNumeric, 32
 . . ClaimNumber Claim Number - Unique Number for the claim N

AlphaNumeric, 50
 . . GroupNumber Alternate group number N

AlphaNumeric, 25
 . . RxNumber RxNumber N

AlphaNumeric, 50
 . . RxDate RxDate N

DateTime
 . . MetricQuantity MetricQuantity N

Decimal
 . . DaysSupply Days Supply N

Numeric
 . . PrimaryCopayAmount Patient out of pocket amount N

Decimal
 . . PrimaryAmountPaid Primary payer amount paid N

Decimal
 . . PatientNumber Member number N

AlphaNumeric, 50
 . . PatientDOB Patient date-of-birth. N

DateTime
 . . PatientStatementID Patient Statement ID N

AlphaNumeric, 32
 . . DateOfService Date Of Service N

DateTime
 . . OtherCoverageCode Other Coverage Code (00,01,02,03,04,08) N

AlphaNumeric, 2
TNPFlag TNPFlag N AlphaNumeric, 1
AAT

AAT - Automatic Account transfer ( Money Transfer From Source to Destination Account via patient Account)

Possible Values are:

  • 0 - OFF
  • 1 - ON
 N Numeric, 1
ExtendedSource For internal use only object
 . Allowed Flag for Extended Source is Allowed or not. For internal use only N boolean
 . SourceAccountNumber SourceAccountNumber is required if ExtendedSource is ALLOWED. For internal use only Y* Numeric, 16
 . SourceTokenID For internal use only N Numeric, 16
 . SourceDescription Source Description. For internal use only N AlphaNumeric, 50
SourceRefName Source Reference Name. For internal use only N AlphaNumeric, 30
SourceRefId For internal use only. For internal use only N AlphaNumeric, 40

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 digit Unique Token of an account.

N

Numeric, 16
CardNumber

Debit Card Number

 N

Numeric, 16
AccountNumber

Cencora Financial Services's internal accountnumber

 N

Numeric, 16
TokenIDRef

Token of account where claim/payment was justifying the load.

N

Numeric, 16
PaymentType

Payment Type.

  • 0 - Debit Card
  • 1 - ACH
  • 2 - Check
  • 4 - PushPay
  • 5 - PullPay
 N Numeric, 1
Transaction object
 . ID

System generated Transaction ID up on succesful transaction posting

 Y*

AlphaNumeric, 16
 . Type

Transaction Code

N

AlphaNumeric, 5
 . Amount Transaction Amount N

Money
 . DateTime Transaction Time N

DateTime
 . Description Transaction Description N

AlphaNumeric, 50
DebitCard object
 . CardAcceptorIdCode CardAcceptorIdCode N

AlphaNumeric, 24
 . CardAcceptorTerminalID CardAcceptorTerminalID N

AlphaNumeric, 24
 . DateTimeLocalTransaction DateTimeLocalTransaction N

DateTime
 . SystemTraceAuditNumber SystemTraceAuditNumber N

AlphaNumeric, 24
 . MerchantType MerchantType N

AlphaNumeric, 24
 . RetrievalReferenceNumber RetrievalReferenceNumber N

AlphaNumeric, 24
 . ApprovalCode ApprovalCode N

AlphaNumeric, 6
Check object
 . CheckMemo Check Memo N

AlphaNumeric, 24
 . CheckNumber Check number if applicable N

AlphaNumeric, 16
ACH object
 . ReceipientID ReceipientID N

AlphaNumeric, 10
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
 . SiteInfo object
 . . NPI Site NPI N

Numeric, 10
 . ProviderInfo object
 . . ProviderNPI Provider NPI N

Numeric, 10
 . . FirstName Provider First Name N

AlphaNumeric, 50

Allowed special character(s) is/are \,'._@- space

 . . LastName Provider Last Name N

AlphaNumeric, 50

Allowed special character(s) is/are \,'._@- space

 . GeneralInfo object
 . . NDC National Drug Code N

Numeric, 11
 . ClaimsInfo object
 . . BIN Rx BIN number N

AlphaNumeric, 32
 . . PCN Processor control number N

AlphaNumeric, 32
 . . ClaimNumber Claim Number - Unique Number for the claim N

AlphaNumeric, 50
 . . GroupNumber Alternate group number N

AlphaNumeric, 25
 . . RxNumber RxNumber N

AlphaNumeric, 50
 . . RxDate RxDate N

DateTime
 . . MetricQuantity MetricQuantity N

Decimal
 . . DaysSupply Days Supply N

Numeric
 . . PrimaryCopayAmount Patient out of pocket amount N

Decimal
 . . PrimaryAmountPaid Primary payer amount paid N

Decimal
 . . PatientNumber Member number N

AlphaNumeric, 50
 . . PatientDOB Patient date-of-birth. N

DateTime
 . . PatientStatementID Patient Statement ID N

AlphaNumeric, 32
 . . DateOfService Date Of Service N

DateTime
 . . OtherCoverageCode Other Coverage Code (00,01,02,03,04,08) N

AlphaNumeric, 2
CurrentBalance Balance of the account N

Money
PostingFlag Transaction Posting Status N

AlphaNumeric, 1
PostingNote Transaction Posting Note N

AlphaNumeric, 64

REST

Method: POST

Urls:

Production: https://api.fvfn.net/fvfnunvwebapi/Transaction/load
SandBox: https://api.firstviewcorp.com/fvfnunvwebapi/Transaction/load

JSON Request:

  {
	"TokenID": {},
	"CardNumber": {},
	"Accountnumber": {},
	"TokenIDRef": {},
	"PaymentType": {},
	"Transaction": {
		"Type": {},
		"Ref": {},
		"Amount": {},
		"DateTime": {},
		"Description": {}
		},
	"DebitCard": {
		"CardAcceptorIdCode":{},
		"CardAcceptorTerminalID":{},
		"DateTimeLocalTransaction":{},
		"SystemTraceAuditNumber":{},
		"MerchantType":{},
		"RetrievalReferenceNumber":{},
		"ApprovalCode":{}
		},
	"Check": {
		"CheckMemo":{},
		"CheckRef1":{},
		"CheckRef2":{},
		"CheckRef3":{},
		"CheckRef4":{},
		},
	"ACH": {
		"RecipientName": {},      
		"RecipientNickName":{},       
		"BankAccountNumber":{},       
		"RoutingNumber":{},       
		"AccountType":{},     
		"TransferType":{} 
		},
	"PushPay": {},
	"PullPay": {},
	"HealthCare": {
		"SiteInfo": {
			"NPI": {}
		},
		"ProviderInfo": {
			"NPI": {},
			"FirstName": {},
			"LastName": {}
		},
		"GeneralInfo": {
			"NDC": {}
		},
		"ClaimsInfo": {
			"BIN": {},
			"PCN": {},
			"ClaimNumber": {},
			"GroupNumber": {},
			"RxNumber": {},
			"RxDate": {},
			"MetricQuantity": {},
			"DaysSupply": {},
			"PrimaryCopayAmount": {},
			"PrimaryAmountPaid": {},
			"PatientNumber": {},
			"PatientDOB": {},
			"PatientStatementID": {},
			"DateOfService": {},
			"OtherCoverageCode": {}
		},
		"MemberID": {},
		"ProcessID": {},
		"GroupID": {},
		"SubscriberID": {},
		"PolicyID": {},
		"PlanType": {},
		"PhysicianID": {},
		"PharmacyID": {}
	},
	"TNPFlag": null,
    "AAT":{},
    "ExtendedSource":{
        "Allowed":{},
        "SourceAccountNumber":{},
        "SourceTokenID":{},
        "SourceDescription":{}
    },
    "SourceRefName":{},
    "SourceRefId":{}
}
Response:
{
    "Status": 
        {
            "APIResponseCode": {},
            "APIReasonDescription": {},
            "APIResponseDateTime": {},
            "APIUniqueReferenceID": {}
        },
	"TokenID": {},
	"CardNumber": {},
	"Accountnumber": {},
	"TokenIDRef": {},
	"PaymentType": {},
    "Transaction": {
		"ID": {},
		"Type": {},
		"Amount": {},
		"DateTime": {},
		"Description": {}
		},
	"DebitCard": {
		"CardAcceptorIdCode":{},
		"CardAcceptorTerminalID":{},
		"DateTimeLocalTransaction":{},
		"SystemTraceAuditNumber":{},
		"MerchantType":{},
		"RetrievalReferenceNumber":{},
		"ApprovalCode":{}
		},
	"Check": {
		"CheckMemo":{},
		"CheckNumber":{}
		},
	"ACH": {
		"RecipientID": {}
		},
	"PushPay": {},
	"PullPay": {},
	"HealthCare": {
		"SiteInfo": {
			"NPI": {}
		},
		"ProviderInfo": {
			"NPI": {},
			"FirstName": {},
			"LastName": {}
		},
		"GeneralInfo": {
			"NDC": {}
		},
		"ClaimsInfo": {
			"BIN": {},
			"PCN": {},
			"ClaimNumber": {},
			"GroupNumber": {},
			"RxNumber": {},
			"RxDate": {},
			"MetricQuantity": {},
			"DaysSupply": {},
			"PrimaryCopayAmount": {},
			"PrimaryAmountPaid": {},
			"PatientNumber": {},
			"PatientDOB": {},
			"PatientStatementID": {},
			"DateOfService": {},
			"OtherCoverageCode": {}
		},
		"MemberID": {},
		"ProcessID": {},
		"GroupID": {},
		"SubscriberID": {},
		"PolicyID": {},
		"PlanType": {},
		"PhysicianID": {},
		"PharmacyID": {}
	},
	"CurrentBalance":{},
	"PostingNote":{},
	"PostingFlag":{}
}

Contact US

E-Mail:

info@fvfn.com

Address:

1 West First Ave, Conshohocken, PA 19428