1. Home
  2. Registration API

Registration API

Last updated: August 7th, 2024

Description

Using This Single Point Registration API, Clients can Register Their Customer Accounts in Cencora Financial Services Database with all Eligible Modules in One Request.

Request Parameters

Y = Required, X = Required When Block Present and X = 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
ProgramID

Unique Identity for Cencora Financial Services programs. This will be Shared by Cencora Financial Services as a part of Initial Business Setup

Example: A-0001

 Y

string

Length = 6
AccountType

Type of Customer Account. Options are:

  • 0 - Loan Proceeds
  • 1 - Health Care
  • 2 - Virtual Cards
 Y string
AccountID Unique account/customer id for the merchant/partner. If account id for the partner is already exist in the system it will append the card number as a secondary card Y string
SmsOptIn

Flag that specifies whether to opt-in / out SMS messages to given phone number.

Possible values:

  • True
  • False (default).
 Y bool
DemographicInfo object
 .  Name object
 . .  Firstname Customer's First Name, this name must be the same as the name on the card. Y

string

Length <= 50
 . .  Lastname Customer's Last Name, this name must be the same as the name on the card. Y

string

Length <= 50
 .  DateOfBirth Customer's DateOfBirth in MMDDYYYY format Y

string

Length = 8
 .  Address object
 . .  Addressline1 First line of the billing street address as it appears on the card issuer's records. Y

string

Length <= 50
 . .  Addressline2 Additional address information. N

string

Length <= 50
 . .  City City of the billing address. Y

string

Length <= 25
 . .  State State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. Y

string

Length <= 2
 . .  PostalCode Postal code for the billing address. The postal code must consist of 5 to 9 digits. Y

string

Length <= 9
 . .  Country Country of the billing address. Use the two-character ISO Standard Country Codes Y

string

Length <= 2
 .  Email Customer's email address, including the full domain name. Y

string

Length <= 100
 .  Phone object
 . .  Phonenumber1

 Customer's phone number. Y

string

Length <= 15
 . .  Phonenumber2 Customer's Alternate phone number. N

string

Length <= 15
Oct object
 .  Push object
 . .  Card object, array
 .  .  .  Cardnumber Customer's credit card number. X string
 .  .  .  CardExpirationDate

Two-digit month and Two-digit year in which the credit card expires. Format: MMYY.

Possible values for MM: 01 through 12.

Possible values for YY: 00 through 99.

 X

string

Length = 4
 .  .  .  ABA Nine-digit Customer's bank routing number. N

string

Length = 9
 .  .  .  DDA Customer's bank account number. N

string

Length <= 16
 .  .  .  BIN Customer's bank bin number. N

string

Length = 6
 .  Pull object
 . .  Card object, array
 .  .  .  Cardnumber Customer's credit card number. X string
 .  .  .  CardExpirationDate

Two-digit month and Two-digit year in which the credit card expires. Format: MMYY.

Possible values for MM: 01 through 12.

Possible values for YY: 00 through 99.

 X

string

Length = 4
 .  .  .  ABA Nine-digit Customer's bank routing number. N

string

Length = 9
 .  .  .  DDA Customer's bank account number. N

string

Length <= 16
 .  .  .  BIN Customer's bank bin number. N

string

Length = 6
HealthCare object
 .  MemberID Customer's Health Care Member ID N

string

Length <= 16
 .  ProcessID Customer's Health Care Process ID N

string

Length <= 16
 .  GroupID Customer's Health Care Group ID N

string

Length <= 16
 .  SubscriberID Customer's Health Care Subscriber ID N

string

Length <= 16
 .  PolicyID Customer's Health Care Policy ID N

string

Length <= 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

string

Length = 1
 .  CoPayInfo object
 . .  CoPayInfo1 Customer's CoPay Information N

string

Length <= 50
 . .  CoPayInfo2 Customer's Additional CoPay Information N

string

Length <= 50
 . .  CoPayInfo3 Customer's Additional CoPay Information N

string

Length <= 50
Release object
 .  PrepaidCard

Flag that specifies whether to Generate Plastic Card or not for customer.

Possible values:

  • True
  • False (default).
 Y bool
 .  VirtualCard

Flag that specifies whether to Generate Virtual Card or not for customer.

Possible values:

  • True
  • False (default).
 Y bool

ClientSpecificInfo

object
 .  CenterID Client's business center identity from where the request is initiated N

string

Length <= 5
 .  StoreID Client's business store identity from where the request is initiated N

string

Length <= 5
 .  LoanType Client's business program type under which the request is initiated N

string

Length <= 3
 .  FundsOriginationChannel Payment Network to be used for funds transfer N

string

Length = 1

Reserved

 object
 .  ReservedField1 Additional Information N string
 .  ReservedField2 Additional Information N string
 .  ReservedField3 Additional Information N string
 .  ReservedField4 Additional Information N string
 .  ReservedField5 Additional Information N string

Return Values

MessageResponse

Property Description Type
Status object
 .  Type Short Note of API result

string

Length <= 32
 .  Code Status Code of API result

string

Length <= 4
 .  Description Full Description of API result

string

Length <= 64
 .  DateTime UTC date time for API result datetime
Response object, array
 .  Type Block name of the Request for which the response belongs to.

string

Length <= 32

 .  APIResponseCode Individual Block Response Code for the Request

string

Length <= 4
 .  APIReasonDescription Individual Block Response Description for the Request

string

Length <= 64
 .  APIResponseDateTime Individual Block Response Datetime for the Request in UTC format datetime
 .  APIUniqueReferenceID Individual Block Unique Tag number for the Request

string

Length <= 64
CardRegistrationDateTime Registration Datetime datetime
OCTFastFundsIndicator

Speed of Funds delivery for OCT enabled requests

Possible Values are:

  • B, C, D: within 30min
  • N: within 2days

string

Length = 1
Token object , array
 .  Type Block name of the Request for which the response belongs to.

string

Length <= 32
 .  CardTokenID 16 - 22 digit Unique Token for the Card Number.

string

Length <= 22
 .  Cardnumberlast4 Last Four Digits of the given Card Number.

string

Length = 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

string

Length = 4
 .  CardType Payment Network of the given Card Number.

string

Length <= 22
 .  DDATokenID 16 - 22 digit Unique Token for the DDA Number.

string

Length <= 22
VerificationText Unique Verification for Virtual Card retrieval / registration.

string

Length = 8

REST

Method: POST

Urls:

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

JSON Request:
{
  "ProgramID": {},
  "AccountType": {},
  "AccountID": {},
  "SmsOptIn":{},
  "DemographicInfo": {
	  "Name": {
		"Firstname":{},
		"Lastname": {}
	  },
	  "DateOfBirth": {},
	  "Address": {
		"Addressline1": {},
		"Addressline2": {},
		"City":{},
		"State": {},
		"PostalCode": {},
		"Country": {}
	  },
	  "Email": {},
	  "Phone": {
	    "Phonenumber1": {},
	    "Phonenumber2": {}
	  }
  },
  "Oct": {
	  "Push": {
		  "Card": [{
				"Cardnumber":{},
				"CardExpirationDate":{},
				"ABA":{},
				"DDA":{},
				"BIN":{}
			}]
	  },
	  "Pull": {
	  "Card": [{
				"Cardnumber":{},
				"CardExpirationDate":{},
				"ABA":{},
				"DDA":{},
				"BIN":{}
			}]
	  }
  },
  "HealthCare": {
    "MemberID": {},
    "ProcessID": {},
    "GroupID": {},
    "SubscriberID": {},
    "PolicyID": {},
    "PlanType":{},

	"CoPayInfo":{
		"CoPayInfo1":{},
		"CoPayInfo2":{},
		"CoPayInfo3":{}
	}
  },

  "Release": {
	"PrepaidCard": {},
	"VirtualCard": {}
  },

  "ClientSpecificInfo": {
	  "CenterID": {},
	  "StoreID": {},
	  "LoanType": {},
	  "FundsOriginationChannel": {}
  },

  "Reserved":{
    "ReservedField2": {},
    "ReservedField3": {},
    "ReservedField4": {},
    "ReservedField1": {},
    "ReservedField5": {}
  }
}
Response:
{
    "Status": {
        "Type": {},
        "Code": {},
        "Description": {},
        "DateTime": {}
    },
    "Response": [
        {
			"Type": {},
            "APIResponseCode": {},
            "APIReasonDescription": {},
            "APIResponseDateTime": {},
            "APIUniqueReferenceID": {}
        },
        {
			"Type": {},
            "APIResponseCode": {},
            "APIReasonDescription": {},
            "APIResponseDateTime": {},
            "APIUniqueReferenceID": {}
        }
    ],
    "CardRegistrationDateTime": {},
    "OCTFastFundsIndicator": {},
    "Token": [
        {
			"Type": {},
            "CardTokenID": {},
            "Cardnumberlast4": {},
            "CardExpirationDate": {},
            "CardType": {},
            "DDATokenID": {}
        },
        {
			"Type": {},
            "CardTokenID": {},
            "Cardnumberlast4": {},
            "CardExpirationDate": {},
            "CardType": {}
            "DDATokenID": {}
        }
    ],
    "VerificationText": {}
}

Contact US

E-Mail:

info@fvfn.com

Address:

1 West First Ave, Conshohocken, PA 19428