We're excited to announce a new addition to our developer resources. Our CardConnect Developer Guides provide additional information for integrating CardConnect products and services.

You can browse the whole library at https://developer.cardconnect.com/guides/home, or jump right to the CoPilot API Developer Guides to make the most of your CoPilot API integration.

Overview

The CoPilot API provides resources for creating and modifying merchants. The API uses JSON web service semantics. Each web service implements the business processes as defined in this API documentation.

What's New?

Date Updated: 6/23/2020

This release contains the following updates:

New Clover Security Bundle Code

The Clover Security Bundle Codes now include a new TDPPCI code for the TransArmor Data Protection + PCI Compliance Tool bundle.

New Attachment Type Code

The Attachment Type Codes now include a new ACKACCEPTAGRMT code for the Acknowledgement of Acceptance of Agreement.

New Cancel Billing Plan Payment Endpoint

A new Cancel Billing Plan Payment endpoint is now available for cancelling a single scheduled payment within a billing plan.

Authentication

Authenticate your account via a JSON Web Token (JWT). You will send a request to obtain the access token and then use it for accessing resources in the Authorization header.

Note that the access token is valid for a limited timeframe. The expires_in value indicates the number of seconds the token remains valid. Once expired, a new token must be requested.

Important Security Considerations:

  • The provided client_secret is a secret and should never be expose on the client side via JavaScript. Take steps to ensure that the client secret is stored securely in your application.
  • Be sure to not expose the access_token or refresh_token in client side applications

Get Access Token Endpoint

Path

https://accountsuat.cardconnect.com/auth/realms/cardconnect/protocol/openid-connect/token

Method

POST

Request Body Content

FieldRequiredDefault ValueComments
usernameyes
passwordyes
grant_typeyespassword
client_idyesmerchapi
client_secretyesOnce you are registered for copilot API access you will be provided the client_secret value

The response will return JSON with an access_token, which is a signed OpenID Connect JSON Web Token (JWT).

Example Response Object

Once the token is obtained it can be used to Authenticate to any given resource of the API by adding it to the request via an Authorization header.

  • Authorization: Bearer accessTokenValue

Request Overview

Whenever possible, newer versions of the API will be backwards compatible with older versions. Since this will not always be possible, older version will be supported for a certain amount of time. Therefore, every request will need to include a request header named X-CopilotAPI-Version with a value of the version your application is currently requesting.

Example Header

Authorization: Bearer accessTokenValue
Content-type: application/json
X-CopilotAPI-Version: 1.0

Resources

Create Merchant Endpoint

Path

https://api-uat.cardconnect.com/merchant

Method

POST

Consumes

application/json

Produces

application/json

Request Body Content

FieldSizeTypeRequiredComments
templateId19LongyesThe merchant template needs to exist prior to any create endpoint calls.
merchantn/amerchantyesThe merchant definition.
ownerSiteUsern/aowner site usernoThis is the merchant's CardPointe user. If this is null, a CardPointe user will be created using the ownership fields in the merchant.

Response Body Content

FieldSizeTypeComments
merchantId19LongThe merchantId of the merchant
errorsn/aerrorThe error array if there was a problem creating the merchant.

Update Merchant Endpoint

This will update the merchant.

Partial Updates
Only objects passed in will be updated. For instance, if merchant.ownership is null or is not passed into the request, no changes will be made to the ownership. If an object is passed in, all fields fields in that object will be updated. For instance, if the merchant.ownership object is passed in but the merchant.ownership.driversLicenseNumber is not passed in, it will be set to null.

CardPointe user
Unlike merchant create, a CardPointe user will not be created from the merchant.ownership.owner fields. Once a merchant is created, updating the owner's CardPointe user can be done from the Owner Site User Endpoint. Alternatively, the ownerSiteUser object can be passed into the merchant update and either a new owner user will be created or the existing owner user will be updated (See the Example Request Object below).

Path

https://api-uat.cardconnect.com/merchant/{merchantId}

Method

PUT

Consumes

application/json

Produces

application/json

Request Body Content

FieldSizeTypeRequiredComments
merchantn/amerchantyesThe merchant definition.
ownerSiteUsern/aowner site usernoThis is the merchant's CardPointe user. If this is null, no changes will be made to the owner site user.

Response Body Content

FieldSizeTypeComments
errorsn/aerrorThe error array if there was a problem creating the merchant.

Merchant Find Endpoint

Path

https://api-uat.cardconnect.com/merchant/{merchantId}

Method

GET

Consumes

application/json

Produces

application/json

Response Body Content

Merchant Status Endpoint

Path

https://api-uat.cardconnect.com/merchant/{merchantId}/status

Method

GET

Consumes

application/json

Produces

application/json

Response Body Content

Boarding Process Status Codes

CodeDescription
INPROG

The digital application has not yet been submitted to the merchant for signing. Displayed in the CoPilot web interface as "Not Submitted."

Note: Merchant details can only be added or modified in this state.

OFSThe digital application is awaiting merchant signature. Displayed in the CoPilot web interface as "Pending Signature."
QUALIFYThe digital application is signed and undergoing an inital review before being sent for underwriting. Displayed in the CoPilot web interface as "Qualifying."
UNDERThe application is being reviewed by the Underwriting team. Displayed in the CoPilot web interface as "Underwriting."
DECLINEDThe application has been rejected by the Underwriting team.
BOARDINGThe merchant account is in the process of being boarded to the processing platform.
BOARDEDThe merchant account is successfully boarded to the processing platform.
LIVEThe merchant account is boarded to the processing platform, the CardPointe Gateway, and is receiving deposits.
CANCELLEDThe merchant account is cancelled.

Gateway Boarding Status Codes

CodeDescription
NOT_BOARDEDThe merchant ID is not yet been boarded to the CardPointe Gateway.
BOARDEDThe merchant account is boarded to the processing platform and the merchant ID is boarded to the CardPointe Gateway.

Owner CardPointe User Create/Update

This is the site user that the owner will use to log into CardPointe to sign the application. This endpoint can only be called if the user has not already registered their CardPointe user account. After that, the user can manage their own profile from CardPointe.

Path

https://api-uat.cardconnect.com/merchant/{merchantId}/ownerSiteUser

Method

PUT

Consumes

application/json

Produces

application/json

Request Body Content

FieldSizeTypeRequiredComments
ownerSiteUsern/aowner site useryes

Response Body Content

FieldSizeTypeComments
errorsn/aerrorThe error array if there was a problem creating owner's CardPointe User.

Owner CardPointe User find

This is the site user that the owner will use to log into CardPointe to sign the application. This endpoint can only be called if the user has not already registered their CardPointe user account. After that, the user can manage their own profile from CardPointe.

Path

https://api-uat.cardconnect.com/merchant/{merchantId}/ownerSiteUser

Method

GET

Consumes

application/json

Produces

application/json

Response Body Content

FieldSizeTypeComments
ownerSiteUsern/aowner site user
errorn/aerrorThe error array if there an error finding the owner's CardPointe user

Request Signature Endpoint

The Merchant needs to be in the In Progress state to request a signature.All fees and pricing need to be submitted and the merchant must have an owner user.

Path

https://api-uat.cardconnect.com/merchant/{merchantId}/signature

Method

PUT

Consumes

application/json

Produces

application/json

Request Body Content

No request body needed for this endpoint

Response Body Content

If the request signature was successful, the signature url is included in the request signature response.

Signature Status Endpoint

This endpoint will return the merchants signature status. This includes a page url for the owner to fill out and sign. If the merchant application has already been signed or the owner user is already a registered CardPointe user, the url will be simply be a link to the CardPointe login page.

The signatureStatusCd will be one of the following: NOT_SENT, PENDING, or SIGNED. NOT_SENT represents a merchant that is not ready for the owner to sign the application and an email has not been sent to the owner. PENDING represents a signature request has been sent to the owner. SIGNED means the owner has signed the application.

Path

https://api-uat.cardconnect.com/merchant/{merchantId}/signature

Method

GET

Consumes

application/json

Produces

application/json

Response Body Content

Retract Signature Endpoint

The Merchant needs to be in the Out For Signature state to retract the signature.This endpoint will put the merchant back in the In Progress state.

Path

https://api-uat.cardconnect.com/merchant/{merchantId}/signature

Method

DELETE

Consumes

application/json

Produces

application/json

Request Body Content

No request body needed for this endpoint

Merchant Attachment Create

Create a merchant attachment

Path

https://api-uat.cardconnect.com/merchant/{merchantId}/attachment

Method

PUT

Consumes

application/json

Produces

application/json

Request Body Content

FieldSizeTypeRequiredComments
attachmentn/aattachmentyes

Response Body Content

FieldSizeTypeComments
errorsn/aerrorThe error array if there was a problem creating the attachment.
attachmentIdn/aIntegerThe attachment id

Equipment Catalog List

List the equipment available for a sales code.

Path

https://api-uat.cardconnect.com/equipmentCatalog/list?salesCode={salesCode}&equipmentSupplierCd={equipmentSupplierCd}&equipmentTypeCd={equipmentTypeCd}&pageNumber={pageNumber}&pageSize={pageSize}

Method

GET

Consumes

application/json

Produces

application/json

Request Parameters

FieldSizeTypeRequiredComments
salesCode19StringyesThe salesCode
equipmentSupplierCd20enumerationnoThe equipment supplier
equipmentTypeCd20enumerationnoThe equipment type
pageNumbern/aIntegernoThe page number (starting with 1)
pageSizen/aIntegernoThe page size

Response Body Content

FieldSizeTypeComments
rowsn/aarray of equipmentList of equipment definitions.
totalServerItemsCountn/anumber
Total number of rows
totalDisplayItemsCountn/anumberThe total number of rows before and including this page
moreRowsAvailablen/abooleanTrue if the are more rows available on the next page
columnSumsn/an/aInternal use
errorsn/aerrorThe error array if there was a problem creating the order.

Create Order

Path

https://api-uat.cardconnect.com/order

Method

POST

Consumes

application/json

Produces

application/json

Request Body Content

FieldSizeTypeRequiredComments
ordern/aorderyesThe order definition.

Response Body Content

FieldSizeTypeComments
orderId19numberThe orderId of the order
errorsn/aerrorThe error array if there was a problem creating the order.

Update Order Endpoint

Path

https://api-uat.cardconnect.com/order/{orderId}

Method

PUT

Consumes

application/json

Produces

application/json

Request Body Content

Example Request Object

Note: the merchantId and equipmentId cannot be changed once an order is created.

FieldSizeTypeRequiredComments
ordern/aorderyesThe order definition.

Response Body Content

FieldSizeTypeComments
errorsn/aerrorThe error array if the was a problem updating the order.

Get Order Endpoint

Path

https://api-uat.cardconnect.com/order/{orderId}

Method

GET

Produces

application/json

Response Body Content

FieldSizeTypeComments
ordern/aorderThe order definition.

Find Orders Endpoint

Path

https://api-uat.cardconnect.com/orders?merchantId={merchantId}&pageNumber={pageNumber}&pageSize={pageSize}

Method

GET

Produces

application/json

Request Parameters

FieldSizeTypeRequiredComments
merchantId19LongyesThe merchantId of the merchant
pageNumbern/aIntegernoThe page number (starting with 1)
pageSizen/aIntegernoThe page size

Response Body Content

FieldSizeTypeComments
ordersn/aList of orderThe order definitions.

Cancel Order Endpoint

Only orders in the NEW status can be canceled.

Path

https://api-uat.cardconnect.com/order/{orderId}/cancel

Method

POST

Produces

application/json

Response Body Content

FieldSizeTypeComments
errorsn/aerrorThe error array if the was a problem canceling the order.

Create Billing Plan Endpoint

This endpoint will create a new billing plan

Path

https://api-uat.cardconnect.com/billingplan/create

Method

POST

Consumes

application/json

Produces

application/json

Request Body Content

FieldSizeTypeRequiredComments
billingPlann/aBilling PlanyesThe billing plan definition.

Response Body Content

FieldSizeTypeComments
billingPlann/aBilling PlanThe billing plan definition.
errorn/aerrorThe error array if the was a problem creating the billing plan.

Cancel Billing Plan Endpoint

This endpoint will cancel a billing plan

Path

https://api-uat.cardconnect.com/billingplan/cancel

Method

POST

Consumes

application/json

Produces

application/json

Request Body Content

FieldSizeTypeRequiredComments
merchId11stringyesThe mid the billing plan belongs to.
billingPlanId11stringyesThe billing plan id to cancel.

Response Body Content

FieldSizeTypeComments
billingPlann/aBilling PlanThe billing plan definition.
errorn/aerrorThe error array if the was a problem cancelling the billing plan.

This endpoint will return a 404 status code if the billing plan cannot be found.

List Billing Plans Endpoint

This endpoint will list billing plans for a merchant

Path

https://api-uat.cardconnect.com/billingplan/list/<merchId>

Method

GET

Produces

application/json

FieldSizeTypeRequiredComments
merchId11numberyesThe mid to search for billing plans.

Response Body Content

FieldSizeTypeComments
billingPlansn/aArray of Billing PlanAn array of billing plans without any payment schedule information. Use the get endpoint to retrieve scheduled payments for a specific billing plan
errorn/aerrorThe error array if the was a problem getting the billing plan.

This endpoint will return a 404 status code if no billing plans can be found.

Get Billing Plan Endpoint

This endpoint will get a billing plan

Path

https://api-uat.cardconnect.com/billingplan/<merchId>/<billingPlanId>

Method

GET

Produces

application/json

FieldSizeTypeRequiredComments
merchId11numberyesThe mid the billing plan belongs to.
billingPlanId11numberyesThe billing plan id to cancel.

Response Body Content

FieldSizeTypeComments
billingPlann/aBilling PlanThe billing plan definition.
errorn/aerrorThe error array if the was a problem getting the billing plan.

This endpoint will return a 404 status code if the billing plan cannot be found.

Update Billing Plan Account Endpoint

This endpoint will update the payment account for a billing plan

Path

https://api-uat.cardconnect.com/billingplan/updateAccount

Method

POST

Consumes

application/json

Produces

application/json

Request Body Content

FieldSizeTypeRequiredComments
merchId11stringyesThe mid the billing plan belongs to.
billingPlanId11

string

yesThe billing plan id to update.
profileId20stringyesThe profile to bill.
acctId3stringnoThe account id within the profile to use. If not provided, the default account will be used.

Response Body Content

FieldSizeTypeComments
billingPlann/aBilling PlanThe billing plan definition.
errorn/aerrorThe error array if the was a problem getting the billing plan.

This endpoint will return a 404 status code if the billing plan cannot be found.

Mark Billing Plan Payment as Paid

This endpoint will update the status of a schedule payment to 'paid'

Path

https://api-uat.cardconnect.com/billingplan/markAsPaid

Method

POST

Consumes

application/json

Produces

application/json

Request Body Content

FieldSizeTypeRequiredComments
merchId11stringyesThe mid the billing plan belongs to.
billingPlanId11stringyesThe billing plan id to update.
billingPlanScheduleId11stringyesThe the scheduled payment within the billing plan to update.
retref20stringnoThe retref (or refnum) of a transaction to associate with the payment. This can be left as null in if unavailable or in the case of a cash payment. If required, multiple payments may be associated to the same transaction by making multiple calls to this endpoint.

Response Body Content

FieldSizeTypeComments
billingPlann/aBilling PlanThe billing plan definition.
errorn/aerrorThe error array if the was a problem getting the billing plan.

This endpoint will return a 404 status code if the billing plan cannot be found.

Cancel Billing Plan Payment

Use the Cancel Payment endpoint to cancel a scheduled payment within a billing plan. You can use the Get Billing Plan endpoint to view all payment schedules within the plan, the associated billingPlanScheduleId, and confirm that the payment you intend to cancel has a paymentStatus of 'Scheduled.'

Path

https://api-uat.cardconnect.com/billingplan/cancelPayment

Method

POST

Consumes

application/json

Produces

application/json

Request Body Content

FieldSizeTypeRequiredComments
merchId11stringyes
billingPlanScheduleId11stringyes

Response Body Content

FieldTypeComment
billingPlanBilling Plan
The billing plan definition.
errorserrorThe error array if the was a problem with the reqeust.

Find Custom Fields Endpoint

This endpoint will list custom fields for a merchant

Path

https://api-uat.cardconnect.com/merchant/{merchantId}/customfields

Method

GET

Consumes

application/json

Produces

application/json

Response Body Content

Create Custom Fields Endpoint


Custom Fields
Custom fields are configured by a partner and they can be labeled, set as active, and set as required in Copilot. If a partner has active required custom fields, then they are required and should be included in the request when creating a merchant. If the partner does not have any active custom fields, then they should not be included in the request when creating a merchant.

Path

https://api-uat.cardconnect.com/merchant/{merchantId}/customfields

Method

PUT

Consumes

application/json

Produces

application/json

Request Body Content

FieldSizeTypeRequiredComments
customFields10array of custom fieldsyesRequired if the merchant's partner has one or more active required custom fields

Response Body Content

FieldSizeTypeComments
errorsn/aerrorThe error array if there was a problem creating the merchant.

Schemas

Use the below schema definitions for details on fields which you need to supply to any given endpoints.

Check the resources to determine which schema definitions are required for the request.

Address Definition

FieldSizeTypeRequiredComments
address1200stringyes
address2200stringno
city300stringyes
countryCd2enumerationno
stateCd2enumerationno
zip15stringyes

Attachment Definition

FieldSizeTypeRequiredComments
fileName60stringyes
mimeType30stringyes
description1000stringyes
attachmentTypeCdn/aenumerationyes
document100MbBase 64 encoded stringyes

Bank Definition

FieldSizeTypeRequiredComments
bankAcctNum25stringyes
bankRoutingNum9stringyes
bankAcctTypeCd10enumerationyes
bankName200stringyes

Bank Detail Definition

FieldSizeTypeRequiredComments
depositBankn/abankyes
withdrawalBankn/abankyes

Billing Plan Definition

FieldSizeTypeRequiredComments
billingPlanId11

string

noThe id of the billing plan, should be null when creating a new plan
merchId11stringyesThe mid the billing plan is being created for
profileId20stringyesThe profile being billed
acctId3stringnoThe account id within the profile to use. If not provided when creating a billing plan, the default account will be used. This field is always returned when retrieving a billing plan.
amountnumberyesThe amount to bill per time period
timeSpannumberyes1 for daily, 2 for weekly, 3 for monthly, or 4 for yearly
everynumberyesBill the customer every x time periods
untilCondition1stringyesC for cancelled, N for number of payments, D for date
untilNumPaymentsnumberSee CommentsRequired if untilCondition = N
untilDate8stringSee CommentsRequired if untilCondition = D. Date format: MMDDYYYY
currencySymbol1stringyesThe currency symbol for the transaction
startDate8stringyesDate format: MMDDYYYY
billingPlanName30stringyesDisplay name
optionsarrayyesThe email_receipt option should be provided with a value of 0 for no or 1 for yes. See example JSON.
planSatus1stringnoThe billing plan status. A for active or C for cancelled.
billingPlanSchedulesarray of billing plan schedulesnoAn array of the payments in the billing plan. This cannot be set, it is only returned when fetching a billing plan. This array will always contain all past payments. In addition, it will also contain future scheduled payments (up to 1000 when untilCondition = N or D, or one year of payments when untilCondition = C)

Billing Plan Schedule Definition

FieldSizeTypeRequiredComments
billingPlanScheduleIdnumberyesThe id of the billing plan schedule entry.
actualAmountnumbernoThe amount that was actually billed, if this payment was processed.
actualPaymentDatestring
noThe date this payment was made, if it was processed.
paymentStatusstringyesScheduled, Cancelled, Paid, or Failed.
retrefstringnotThe transaction id, if it was processed.
scheduledAmountnumberyesThe amount scheduled to be billed.
scheduledPaymentDatestringyesThe date the transaction is scheduled for

BlueChex Volume Definition

The blueChexVolume object is required for merchants with the BlueChex add on. All fields must be provided.

FieldSizeTypeDescription
avgPerTransactionSalesAmount18.2numberAverage sales amount per BlueChex transaction.
maxPerTransactionSalesAmount18.2numberMaximum sales amount per BlueChex transaction.
avgPerTransactionCreditAmount18.2numberAverage credit (refund) amount per BlueChex transaction.
maxPerTransactionCreditAmount18.2numberMaximum credit (refund) amount per BlueChex transaction.
avgPerMonthSalesAmount18.2numberAverage monthly sales amount for all BlueChex transactions.
maxPerMonthSalesAmount18.2numberMaximum monthly sales amount for all BlueChex transactions.
avgPerMonthCreditAmount18.2numberAverage monthly credit (refund) amount for all BlueChex transactions.
maxPerMonthCreditAmount18.2numberMaximum monthly credit (refund) amount for all BlueChex transactions.

Business Details Definition

FieldSizeTypeRequiredComments
customerBillPriorToShipFlgn/abooleanno
depositReqForFulfillFlgn/abooleanno
whenCustomerChargedCd10enumerationno
refundPolicyCd10enumerationno
serviceProvidedInCd10enumerationno

Clover Security and TransArmor Definition

FieldSizeTypeRequiredComments
cloverSecurityBundleCd

n/a

enumerationno
transarmorDataProtectionFlgn/abooleanno
transarmorTokenTypeCdn/aenumerationno
transarmorMultiPayToken4stringno

Custom Fields Definition

FieldSizeTypeRequiredComments
userFieldNumbern/anumberyesThe index of the custom field being set. Must be a number between 1-10
customFieldValue100stringyesRequired if the merchant's partner has made the custom field at this index required

Delivery Percentages Definition

FieldSizeTypeRequiredComments
dlvry0To7DaysPct3numberno0-100%
dlvry15To30DaysPct3numberno0-100%
dlvry8To14DaysPct3numberno0-100%
dlvryOver30DaysPct3numberno0-100%

Demographic Definition

FieldSizeTypeRequiredComments
businessIncorporatedStateCd2enumerationno
merchantTimeZone3stringnoone of (PT, MT, CT, ET, HST)
websiteAddress200stringyesRequired if merchant -> processing -> modeOfTransaction-> eCommercePct is greater than 0
businessPhone12stringno###-###-####
businessFax12stringno###-###-####
businessAddressn/aaddressyes
mailingAddressn/aaddressyes

Equipment Definition

FieldSizeTypeComments
equipmentId60numberThe equipment ID
equipmentName60stringThe equipment name
description60stringThe equipment description
make60stringThe equipment make
model60stringThe equipment model
imageUrl60stringThe equipment image url
sku60string

The equipment sku

platformCd60stringThe equipment platform
equipmentTypeCd60enumerationThe equipment type
equipmentSupplierCd60enumerationThe equipment supplier code
defaultPrice60stringThe default one time price
defaultPlanPrice60stringThe default monthly price if allowed
allowCustomBillingFlg60stringTrue if monthly billing is allowed
standardShippingPrice60stringThe standard shipping price (per unit)
expeditedShippingPrice60stringThe expedited shipping price (per unit)

Fees Definition

FieldSizeTypeRequiredComments
achBatchFee7.3numberyes
addressVerifFee7.3numberyes
annualMembershipFee8.2numberyes
appFee8.2numberyes
authFee7.3numberyes
chargebackFee8.2numberyes
cloverSecurityFee8.2numberno
dataBreachFee8.2numberyes
ddaRejectFee8.2numberyes
earlyCancelFee8.2numberyes
minProcessFee8.2numberyes
monthlyEquipmentRentalFee8.2numberno
pciAnnualFee8.2numberyes
pciAnnualFeeMonthToBilln/astringno

Month name with capital first letter

pciNonComplianceFee8.2numberyes
regProdMonthlyFee8.2numberyes
retrievalFee8.2numberyes
statementFee8.2numberyes
transactionFee7.3numberyes
voiceAuthFee7.3decimalyes
wirelessActivationFee8.2decimalyes
wirelessFee8.2numberyes
duesAndAssessmentsFlgn/abooleanno
passthruInterchgCostsFlgn/abooleanno

Flat Pricing Definition

FieldSizeTypeRequiredComments
amex.esaQualDiscountPct7.3numberyesOnly valid if amexProgramAssetCd is ESA
amex.optBlueQualDiscountPct7.3numberyesOnly valid if amexProgramAssetCd is OPTBLUE
discover.qualCreditDiscountPct7.3numberyes
mastercard.qualCreditDiscountPct7.3numberyes
visa.qualCreditDiscountPct7.3numberyes

Hierarchy Definition

FieldSizeTypeRequiredComments
corpLevel12stringno
chainLevel12stringno

IC-Plus Pricing Definition

FieldSizeTypeRequiredComments
interchangeTypeCode5enumerationno
amex.optBlueQualDiscountPct7.3numberyesOnly valid if amexProgramAssetCd is ESA
discover.qualCreditDiscountPct7.3numberyes
mastercard.qualCreditDiscountPct7.3numberyes
visa.qualCreditDiscountPct7.3numberyes

Merchant Definition

FieldSizeTypeRequiredComments
akaBusinessName200stringno
custPrimaryAcctFlgn/abooleanno
dbaName100stringyes
legalBusinessName500stringyes
taxFilingMethod3stringyesEIN or SSN, can only be SSN if merchant -> ownership -> ownershipType is INDIVSOLE
taxFilingName500stringyes
hierarchyn/ahierarchyno
demographicn/ademographicyes
businessIdTypeCdstringnoUse the following codes ARTICLE,GOVT
businessStartDate8datenoMM/DD/YYYY
bankDetailn/abank detailyes
cloverSecurityAndTransarmorn/aclover security and transarmor

no

ownershipn/aownershipyes
merchantContactInfon/acontact infono
salesCode25stringyes
processingn/aprocessingno
webLeadFlgn/abooleanno
pricingn/apricingno
feesn/afeesno
customFields10array of custom fields
yesRequired if the merchant's partner has one or more active required custom fields

Merchant Contact Info Definition

FieldSizeTypeRequiredComments
contactName300stringno
contactEmail300stringno
contactPhone12stringno###-###-####

Mode of Transaction Details Definition

FieldSizeTypeRequiredComments
eCommercePct3numberyes0-100%
keyedPct3numberyes0-100%
mailOrderPct3numberyes0-100%
swipedPct3numberyes0-100%

Order Definition

FieldSizeTypeRequiredComments
orderId19numbernoThe merchantId the order is for. (cannot set this value, only used for GET)
merchantId19numberyesThe merchantId the order is for.
equipmentId19numberyesThe equipmentId the order is for.
orderNotes1000stringnoOptional notes for the person fulfilling the order.
quantity4numberyesThe number of devices being ordered.
unitPrice10numberyes (when billToFrequencyCd is ONETIME)The price per unit.
monthlyPrice10numberyes (if billToFrequencyCd is MONTHLY)The price per month.
billToCd100enumerationyesWho to bill for this order
billingFrequencyCd100enumerationyesBilling frequency
profileIdn/astringyes (if billToCd is PARTNERCC)The profileId of the card to charge for this order.
acctId10numberyes (if billToCd is PARTNERCC)The account number to charge for this order.
shippingDetailsn/ashipping detailsyes
orderStatusCdn/aenumerationno
placedDatetimen/astringnoThe date the order was placed (Usually when right after the merchant signs the application)
shippedDatetimen/astringnoThe date the order was shipped
canceledDatetimen/astringnoThe date the order was canceled
fulfillingDatetimen/astringnoThe date the order was fulfilled

Order Shipping Details Definition

FieldSizeTypeRequiredComments
shippingAddressn/aaddressyes
shipToAttn100stringyesName of the person receiving the order.
shipToAttnEmail100stringyesEmail of the person receiving the order.
shippingMethodCd100enumerationyesThe shipping method to be used.
shippingBillToCd100enumerationyes (if shippingMethodCd is EXPEDITED)Who to bill for the shipping (only set if shippingMethodCd is EXPEDITED)
shippingCarrierCd100enumerationnoThe shipping carrier
trackingNumber100stringnoThe shipping carrier
shippingCostn/anumbernoThe shipping cost
merchantContactPhone12stringyes###-###-####
merchantContactPhoneExt5stringno#####
poNumber30stringnoPurchase order number

Owner Definition

FieldSizeTypeRequiredComments
ownerAddressn/aaddressyes
ownerEmail300stringyes
ownerName300stringyes
ownerDob8stringnoMM/DD/YYYY
ownerPhone12stringyes###-###-####
ownerMobilePhone12stringyes###-###-####
ownerSSN11stringyes###-##-####
ownerTitle200stringyesSee List Below

Valid Owner Titles

Ownership TypeValid Owner Titles
PRTNRSHP (Partnership)PARTNER
GOVT (Government)OWNER, PARTNER, PRESIDENT, VICE_PRESIDENT, MEMBER_LLC, SECRETARY, TREASURER, CEO, CFO, COO
PUBCORP (Public Corporation)PRESIDENT, VICE_PRESIDENT, SECRETARY, TREASURER, CEO, CFO, COO
LLC (LLC)PRESIDENT, VICE_PRESIDENT, SECRETARY, TREASURER, CEO, CFO, COO, MEMBER_LLC
PRIVCORP (Private Corporation)PRESIDENT, VICE_PRESIDENT, SECRETARY, TREASURER, CEO, CFO, COO
TAXEXMPT (Tax Exempt)OWNER, PARTNER, PRESIDENT, VICE_PRESIDENT, MEMBER_LLC, SECRETARY, TREASURER, CEO, CFO, COO
NONPRFT (Non-Profit Org)OWNER, PARTNER, PRESIDENT, VICE_PRESIDENT, MEMBER_LLC, SECRETARY, TREASURER, CEO, CFO, COO
INDIVSOLE (Individual / Sole Proprietor)OWNER

Owner Site User Definition

FieldSizeTypeRequiredComments
firstName300stringyes
lastName300stringyes
email300stringyes

Ownership Definition

FieldSizeTypeRequiredComments
ownern/aowneryes
ownershipTypeCd10enumerationno
publiclyTradedFlagn/abooleanno
stockSymbol10stringno
driversLicenseNumber100stringyes
driversLicenseStateCd2enumerationyes
ownerOwnershipPct3numberno0-100%

Platform Details Definition

FieldSizeTypeRequiredComments
backEndMid25stringno (yes for CardPointe only accounts)
frontEndMid25stringno (yes for CardPointe only accounts)
processorReportingMid25stringno (yes for CardPointe only accounts)
backEndPlatform20enumerationno (yes for CardPointe only accounts)
frontEndPlatformCd20enumerationno (yes for CardPointe only accounts)
amexProgramAssetCd7enumerationnoRequired if Amex entitlement is enabled
amexProgramMid25stringnoRequired if amexProgramAssetCd = ESA
discoverMid25stringnoRequired if discoverProgramCd = EASI
discoverProgramCd10enumerationnoRequired if Discover entitlement is enabled
acquiringFlgn/abooleanyestrue = Merchant Services, false = CardPointe only
taxId9

string

no
tidstringno
busnsIdstringno
busnsIdPlaceOfIssue2enumerationyesState code
currencyCode5enumerationno
mccId5stringyesNumber as a string
businessDescription4000stringyes
iataCode8stringno

Number as a string

quasiCashFlg

n/a

booleanno

Pricing Definition

FieldSizeTypeRequiredComments
flatPricingn/aflat pricingyes
FieldSizeTypeRequiredComments
icPlusPricingn/aicplus pricingyes

Processing Definition

FieldSizeTypeRequiredComments
platformDetailsn/aplatform detailsyes
businessDetailsn/abusiness detailsyes
volumeDetailsn/avolume detailsyes
deliveryPercentagesn/adelivery detailsno
modeOfTransactionn/amode of transaction detailsno
blueChexVolumen/abluechex volume
noRequired for applications that include the BlueChex add-on and a digital signature.

Volume Details Definition

FieldSizeTypeRequiredComments
averageMonthlyVolume18.2decimalyes
highTicketAmount18.2decimalyes
averageTicketAmount18.2decimalyes

Enumeration Definition

Amex Program Asset Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/amexProgramAssetCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Attachment Type Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/attachmentTypeCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Back End Platform Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/backEndPlatformCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Bank Account Types

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/bankAcctTypes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Bill To Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/billToCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Bill To Detail Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/billToDetailCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Billing Frequency Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/billingFrequencyCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Clover Security Bundle Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/cloverSecurityBundleCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Country Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/countryCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Discover Program Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/discoverProgramCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Equipment Supplier Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/equipmentSupplierCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Equipment Type Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/equipmentTypeCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Front End Platform Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/frontEndPlatformCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Interchange Type Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/interchangeTypeCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Order Status Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/orderStatusCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Ownership Types

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/ownershipTypes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Refund Policy Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/refundPolicyCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Service Provided In Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/serviceProvidedInCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Shipping Carrier Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/shippingCarrierCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Shipping Method Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/shippingMethodCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

State Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/stateCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

TransArmor Token Type Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/transarmorTokenTypeCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

When Customer Charged Codes

Method

GET
Hosthttps://api-uat.cardconnect.com
Path/lookup/whenCustomerChargedCodes
HeadersAuthorization: Bearer

X-CopilotAPI-Version: 1.0

Bodynone
Consumes
N/A
Producesapplication/json

Errors

When there is an error in the request, there will be a non-null errors array in the response body. If there are multiple field validation errors, there will be multiple error objects in the errors array. See the example below.

Error Definition

FieldTypeComments
codeStringThe error code
messageStringThe error message
errorFieldStringThe field that caused the error
statusStringThe HTTP Status Code