1. Home
  2. Registration V2
  3. Account Update API

Account Update API

Last updated: August 7th, 2024

Description

Using this account Update API, Clients can update 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
ClientID

Unique partner reference number issued by Cencora Financial Services

Example: A-0001

 Y

AlphaNumeric, 6

Allowed Special Character(s) is/are -
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
AccountID Customer UniqueID in their system(if the doctor/pharmacy/patient has the same id but a unique secondary id, populate the secondary id in secondary account id field) If this parameter is left blank, Cencora Financial Services will create a dynamic ID. N

AlphaNumeric, 20

Allowed Special character(s) is/are -
SecondaryAccountID If the account id is not unique populate the secondary account id to achieve the uniqueness. N

AlphaNumeric, 50

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
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. X

AlphaNumeric, 50

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

 .  Contactname Shipping Contact Name X

AlphaNumeric, 50

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

 .  Addressline1 Address of the patient, doctors office. X

AlphaNumeric, 64
 .  Addressline2 Additional address information. N

AlphaNumeric, 64
 .  City City X

AlphaNumeric, 24
 .  State State or province of the address. X

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 X

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

Numeric, 10
 .  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. Y* AlphaNumeric, 50
 .  .  RecipientNickName Recipient Nick Name. Y* AlphaNumeric, 17
 .  .  RoutingNumber Routing Number Y* Numeric, 17
 .  .  BankAccountNumber Bank Account Number. Y* Numeric, 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
 Y*

Numeric, 1
 .  .  AccountType

Recipient Account Type.

  • 0 - Checking
  • 1 - Savings
 Y*

Numeric, 1
 .  Check For internal use only object
 .  PushPay For internal use only object
 .  PullPay For internal use only 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 N

AlphaNumeric, 16
 . PCN N

AlphaNumeric, 16
 . Rx object
 . .  BIN Rx BIN N

AlphaNumeric, 16
 . .  PCN Rx PCNN

AlphaNumeric, 16
 . .  MemberID Rx MemberID N

AlphaNumeric, 16
 . .  GroupID Rx GroupID N

AlphaNumeric, 16
IdentityInfo IdentityInfo N AlphaNumeric, 16
Reissue Reissue Card with 1-Same Exp.Date or 2-New Exp.Date (Card will Not be Reissued in case of no value) N AlphaNumeric, 1
TokenStatus

"Token Status can be Changed from Active to Inactive or Closed, Incative to Active or Closed. A Closed token can not be Activated or Inactivated"

  • 0 - Active
  • 1 - InActive
  • 2 - Closed
 N AlphaNumeric, 1
Reserved object
 .  ReservedField1 Additional Information N AlphaNumeric, 16
 .  ReservedField2 Additional Information N AlphaNumeric, 16
 .  ReservedField3 Additional Information N AlphaNumeric, 16
 .  ReservedField4 Additional Information N AlphaNumeric, 16
 .  ReservedField5 Additional Information N AlphaNumeric, 16
PaymentStream object
 .  AAT Allow AAT
  • 0 - OFF
  • 1 - ON
 N Numeric, 1
 .  Notification AAT Notification
  • 0 - OFF
  • 1 - ON
 N Numeric, 1
FundingAccountNumber FundingAccountNumber. For internal use only N Numeric, 16
GroupSponsor GroupSponsor. For internal use only N AlphaNumeric, 16
GroupSponsorSource GroupSponsorSource. For internal use only N Nullable byte
UpdateSecondaryAccountID UpdateSecondaryAccountID. For internal use only N Boolean
Reconciliation Reconciliation. For internal use only N Nullable Boolean
ClaimGroupNumber ClaimGroupNumber is required if Reconcillation is ON. For internal use only Y* AlphaNumeric
InvoiceActionType InvoiceActionType is required if Reconcillation is ON. For internal use only Y* Numeric, 1

Return Values

MessageResponse

Property Description Type
Status object
 .  APIResponseCode API Response Code. (00-Success)

AlphaNumeric, 4
 .  APIReasonDescription API Reason Description

AlphaNumeric, 64
 .  APIResponseDateTime API Response Datetime for the Request in UTC format datetime
 .  APIUniqueReferenceID UDID. API Unique reference number

AlphaNumeric, 64
Service object, array
 .  ServiceType Payment service type. (Debit,Check,ACH,PullPay,PushPay)

AlphaNumeric, 2
 .  ResponseCode Response Code

AlphaNumeric, 4
 .  ReasonDescription Reason Description

AlphaNumeric, 64
Token object
 .  CardTokenID 16 - 22 digit Unique Token for the Card Number.

AlphaNumeric, 22
 .  Cardnumberlast4 Last Four Digits of the given Card Number.

AlphaNumeric, 4
 .  CardExpirationDate

Expiration date of the given Card Number.

Format: MMYY

Possible values for MM: 01 to 12

Possible values for YY: 00 to 99

AlphaNumeric, 4
 .  CardType Card network type. Visa, Master Card, etc

AlphaNumeric, 22
 .  DDATokenID 16 - 22 digit Unique Token for the DDA Number.

AlphaNumeric, 22
VerificationText Unique Verification for Virtual Card retrieval / registration.

AlphaNumeric, 8

REST

Method: POST

Urls:

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

JSON Request:
{
  "ClientID": {},
  "TokenID": {},
  "CardNumber": {},
  "Accountnumber": {},
  "AccountID": {},
  "SecondaryAccountID": {},
  "SmsOptIn":{},
  "DemographicInfo": {
	  "Name": {
		"Firstname":{},
        "Middlename":{},
		"Lastname": {}
	  },
	  "DateOfBirth": {},
	  "Address": {
		"Addressline1": {},
		"Addressline2": {},
		"City":{},
		"State": {},
		"PostalCode": {},
		"Country": {}
	  },
	  "Email": {},
	  "Phone": {
	    "Phonenumber1": {},
	    "Phonenumber2": {}
	  },
      "Gender":{},
      "SocialSecurityNumber":{}
  },
  "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":{}
	}
  },
  
  "IdentityInfo": {},
  "ReIssue": {},
  "TokenStatus": {},  
  
  "Reserved":{
    "ReservedField2": {},
    "ReservedField3": {},
    "ReservedField4": {},
    "ReservedField1": {},
    "ReservedField5": {}
  },
  "PaymentStream":{
	"AAT":{},
	"Notification":{}
  },
  "FundingAccountNumber":{},
  "GroupSponsor":{},
  "GroupSponsorSource":{},
  "UpdateSecondaryAccountID":{},
  "Reconciliation":{},
  "ClaimGroupNumber":{},
  "InvoiceActionType":{}
}
Response:
{
    "Status": 
        {
            "APIResponseCode": {},
            "APIReasonDescription": {},
            "APIResponseDateTime": {},
            "APIUniqueReferenceID": {}
        },
    "Service": [
		{
			"ServiceType": {},
            "ResponseCode": {},
            "ReasonDescription": {}
		},
				{
			"ServiceType": {},
            "ResponseCode": {},
            "ReasonDescription": {}
		}
		],

    "Token": 
        {
            "CardTokenID": {},
            "Cardnumberlast4": {},
            "CardExpirationDate": {},
            "CardNetworkType": {},
            "DDATokenID": {}
        },
    "VerificationText": {}
}

Contact US

E-Mail:

info@fvfn.com

Address:

1 West First Ave, Conshohocken, PA 19428