Overview
The CoPilot API uses JSON web service semantics and provides resources for boarding new merchant accounts and managing existing accounts.
The API complements the CoPilot web application, offering a programmatic interface to some features available in the application; however, you must use the web application to complete some tasks (for example, creating application templates).
Visit Statuspage and click subscribe to updates to receive important release and status notifications.
Date Updated: 11/8/2023 An update to the CoPilot API has been released to the Production environment on 11/8/2023. This release includes the following updates in addition to internal fixes and enhancements:
Enhanced Field Validation
Additional validations have been incorporated for the legalBusinessName
, akaBusinessName
, taxFilingName
, and dbaName
fields to check for string sizes that exceed the expected maximum length. The following example illustrates two possible errors:
{
"errors": [
{
"code": "1105",
"message": "Legal Business Name has invalid length.",
"errorfield": "merchant.legalBusinessName",
"status": "BAD_REQUEST"
},
{
"code": "1178",
"message": "AKA Business Name has invalid length.",
"errorfield": "merchant.akaBusinessName",
"status": "BAD_REQUEST"
}
]
}
Shipping Bill To Field
Previously, the Shipping Bill To field was not pulled from the template. However, it is now automatically provided from the active template. There is no need to utilize the shippingBillToCd
field in the API, and if it is used, it will be disregarded.
Non-Swiped Auth Fee
cloverNonSwipedAuthFee
has been added to the fee class. This fee is only applicable for North Retail ISO merchants.
Getting Started
Authentication
The CoPilot API uses the Bearer Authentication HTTP authentication scheme in order to authenticate requests to the API.
To obtain a bearer token to authenticate your API requests, you must create a CoPilot user in the CoPilot web application then provide that user's username and password in a request to the CoPilot API's Token endpoint. A successful request returns a JSON Web Token (JWT) which you use as the Bearer token in subsequent calls to the CoPilot API.
We strongly recommend that you create a dedicated CoPilot user to authenticate your CoPilot API requests, and that you do not use this account to access the CoPilot web application.
The CoPilot web application uses two-factor authentication (2FA); attempting to log into the web application with your CoPilot API user will initiate the 2FA requirement for this user, preventing it from authenticating API requests until the 2FA requirement is satisfied in the web application.
Versioning
Whenever possible, newer versions of the API
will be backwards compatible with older versions. To ensure your
integration is not disrupted in the event that backwards compatibility
cannot be maintained, we strongly recommend specifying the version in the header of each API request as part of your integration. This is accomplished by supplying the X-CopilotAPI-Version
HTTP header with the value of the version your application uses.
Example Header
Authorization: Bearer accessTokenValue
Content-type: application/json
X-CopilotAPI-Version: 1.0 This header should be omitted from requests to the Token endpoint, as authentication via the Token endpoint occurs independently of the CoPilot API. The current version of the CoPilot API is 1.0. Additional Resources
In addition to this API documentation, the following resources are available to help you get started:
Developer Guides
The CoPilot API Developer Guides provide additional information for using the API to complete specific workflows, for example, Using the CoPilot API to Submit a Merchant Application .
Postman Collection
To help you get started with your integration, we have created a Postman Collection that includes templates for all of the requests documented on this page.
Click the Run in Postman button to download the CoPilot API collection.
See Running the API in Postman in the CoPilot Developer Guides for more information on using the Postman Collection.
Token
To authenticate any request to the CoPilot API, you must first request an access token using the Token endpoint. The Token endpoint requires CoPilot user account credentials, and returns the access token you will use to make API requests during a session.
The access token is valid for a limited timeframe, indicated by the expires_in
value (in seconds). Once a token has expired, you must request a new token.
Important Security Considerations:
The provided client_secret
is a secret and should never be
exposed on the client side via JavaScript. Ensure that the
client secret is stored securely in your application. Do not expose the access_token
or refresh_token
in client-side applications. Create a dedicated CoPilot user account for authenticating your CoPilot API requests, and do not use this account to access the CoPilot web application. Using this account to access the CoPilot web application will initiate the two-factor authentication (2FA) requirement for this account, preventing the authentication of your API requests until the 2FA requirement is satisfied. Method POST Host https://accountsuat.cardconnect.com Path /auth/realms/cardconnect/protocol/openid-connect/token Headers Content-Type: application/x-www-form-urlencoded Consumes application/x-www-form-urlencoded Produces application/json
Token Request
Field Required Default Value Comments username yes N/A The username for the CoPilot user account used to authenticate your API requests. password yes N/A The password for the CoPilot user account used to authenticate your API requests. grant_type yes password client_id yes merchapi client_secret yes N/A CoPilot API registration is required in order to receive your client_secret.
Token Response
The JSON-encoded request will return a signed OpenID Connect JSON Web Token (JWT) as the access_token value, as well as other properties pertaining to authentication.
Example Token Response
{
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIzNDZZVkUwaGJXQlVvT1NoMm5wOHF4d2NuZ2tKUjY1Uzh3SVM2UmI5X3N3In0.eyJqdGkiOiJmYmZjMjY5My04YTliLTQyOTAtOGRiMS0zM2YxODc3M2IwMTkiLCJleHAiOjE0OTkxMTYyODUsIm5iZiI6MCwiaWF0IjoxNDk5MTE1OTg1LCJpc3MiOiJodHRwOi8vYWNjb3VudHMtbG9jYWwuY2FyZGNvbm5lY3QuY29tL2F1dGgvcmVhbG1zL2NhcmRjb25uZWN0IiwiYXVkIjoiY29waWxvdCIsInN1YiI6IjZlZjdkOTkyLWZhZTMtNDVhYy1iMDA5LTIzOGIzMzIwOTA1MSIsInR5cCI6IkJlYXJlciIsImF6cCI6ImNvcGlsb3QiLCJhdXRoX3RpbWUiOjAsInNlc3Npb25fc3RhdGUiOiJjYzExYWYyMi0xMjMxLTQ4M2ItYjA0ZC01ZmYyMTIwMTM0OGYiLCJhY3IiOiIxIiwiY2xpZW50X3Nlc3Npb24iOiJmNGQ1ZWQyOC05MzM0LTQwOGYtODlmZC0zNzY0MmU3OGViNWUiLCJhbGxvd2VkLW9yaWdpbnMiOltdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsidW1hX2F1dGhvcml6YXRpb24iXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50Iiwidmlldy1wcm9maWxlIl19fSwibmFtZSI6IiIsInByZWZlcnJlZF91c2VybmFtZSI6ImFwaW9uZXNhbGVzY29kZSIsImNjVU5hbWUiOiJhcGlvbmVzYWxlc2NvZGUifQ.a6W3BihEKH4vcbFDInWIF0KmiAU3g3jtdQmBLEwEdOhOlRtsAyYVngeUxJ7pjUqqM9rv9Y8pCTAyZCZegu1Qi6ZSd3vQ1A7TKaR61LvxFXgFwuNodl-PKtJOCnSk9C1tnOEW_hlz-amBq19ydx2PoPZPqjeyopbnXFMOXvXP3_Km5gDM8JqVXlN0Awg38WpMB1SWgw5f8ZItjAVj3_9EpMi1pImO7wyjKw7KXk_O_drUPJIO6XB1vwd_tYWdNf_pAuoUPQLl9R0xGHDkIOAioXYjWnVpZ8bNExwPdSGJkkzTuTOEoWGuMsXKKFkLZxzzzzzz",
"expires_in": 300,
"refresh_expires_in": 600,
"refresh_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIzNDZZVkUwaGJXQlVvT1NoMm5wOHF4d2NuZ2tKUjY1Uzh3SVM2UmI5X3N3In0.eyJqdGkiOiI3MTUyMTkwYy1mMzdjLTQ5MGQtOGYxZC1kMDlhMzJlYTlhYzAiLCJleHAiOjE0OTkxMTc3ODUsIm5iZiI6MCwiaWF0IjoxNDk5MTE1OTg1LCJpc3MiOiJodHRwOi8vYWNjb3VudHMtbG9jYWwuY2FyZGNvbm5lY3QuY29tL2F1dGgvcmVhbG1zL2NhcmRjb25uZWN0IiwiYXVkIjoiY29waWxvdCIsInN1YiI6IjZlZjdkOTkyLWZhZTMtNDVhYy1iMDA5LTIzOGIzMzIwOTA1MSIsInR5cCI6IlJlZnJlc2giLCJhenAiOiJjb3BpbG90IiwiYXV0aF90aW1lIjowLCJzZXNzaW9uX3N0YXRlIjoiY2MxMWFmMjItMTIzMS00ODNiLWIwNGQtNWZmMjEyMDEzNDhmIiwiY2xpZW50X3Nlc3Npb24iOiJmNGQ1ZWQyOC05MzM0LTQwOGYtODlmZC0zNzY0MmU3OGViNWUiLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsidW1hX2F1dGhvcml6YXRpb24iXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50Iiwidmlldy1wcm9maWxlIl19fX0.Ifoi_ZGGA2dVg1PAxDzXqjyXZtH6B0ISiDNfm7jPUJUvaFhRDkxGPWoXOoIOabbNyL-rfqS2aChDrP8OhqtxmWFBqr0e7bWTitHsruXtcXoI7gw-0rnF31LAXhhyGosnZcOqD57-UZ4tuQ3wi9luvoXw-skc59iW6EgV9_jkd3n11sIO2-lOrCoSD4OhTqrSFbf4b-duOf9UsYm1sBq3vDLQMxd4Brp7SarStCYHIe0VOBGgKBrliwwzZi0g2ucKX2jA1eMpmWng5ddQ5uZGg5jnak2-bzrx8QFMyWj5zYkWGMb5SDa5N8Kizzzzz",
"token_type": "bearer",
"not-before-policy": 1498510947,
"session_state": "cc11af22-1231-483b-b04d-5ff21201348f",
"scope": "isv"
}
Field Type Comments access_token
string The access token value to be used with the Bearer Authentication scheme for subsequent calls to the API. expires_in number The number of seconds until the access token is no longer valid. refresh_expires_in number The number of seconds until the refresh token is no longer valid. refresh_token string The refresh token used to request a new access token. token_type string The type of token provided. A successful request returns a bearer token. not-before-policy number When applicable, restricts authentication prior to the timestamp value.
session_state string The session state string. scope string The scope of use for the token, based on the user that initiated the request.
Supply the access_token
value in the Authorization header of your subsequent API calls, using the Bearer Authentication scheme as shown below.
Authorization: Bearer <access_token>
Merchant
The Merchant endpoint is used primarily to create a new merchant account in CoPilot, using a pre-existing application template that has been created in the CoPilot web interface.
You can also use additional Merchant endpoints to retrieve merchant data, update merchant data, or retrieve the status of a merchant account as outlined below.
Once the merchant account has been created, additional boarding operations can be performed, such as:
Create a Merchant Account Example Create Merchant Request (All)
{
"templateId": 9999,
"merchant": {
"salesCode": "API1",
"akaBusinessName": "The Card Shoppe",
"dbaName": "The Card Shoppe",
"legalBusinessName": "The Card Shoppe LLC",
"taxFilingName": "The Card Shoppe LLC",
"taxFilingMethod": "EIN",
"businessStartDate": "09/17/1949",
"businessIdTypeCd": "ARTICLE",
"custPrimaryAcctFlg": false,
"webLeadFlg": true,
"hierarchy": {
"corpLevel": "000000000001",
"chainLevel": "000000000002",
"sponsorBankCd": "WELLS"
},
"demographic": {
"businessIncorporatedStateCd": "CO",
"merchantTimeZone": "MT",
"websiteAddress": "www.example.com",
"businessPhone": "555-123-4567",
"businessFax": "555-987-6543",
"businessAddress": {
"address1": "123 Fake Street",
"address2": "Suite 300",
"city": "Keystone",
"stateCd": "CO",
"zip": "80435",
"countryCd": "US"
},
"mailingAddress": {
"address1": "123 Fake Street",
"address2": "Suite 300",
"city": "Keystone",
"stateCd": "CO",
"zip": "80435",
"countryCd": "US"
}
},
"ownership": {
"owner": {
"ownerAddress": {
"address1": "1 Imaginary Lane",
"address2": "Apt 221B",
"city": "Dillon",
"stateCd": "CO",
"zip": "80435",
"countryCd": "US"
},
"ownerEmail": "name@email.com",
"ownerName": "Forename Surname",
"ownerDob": "09/04/1929",
"ownerPhone": "555-123-4567",
"ownerMobilePhone": "555-987-6543",
"ownerSSN": "111-22-3333",
"ownerTitle": "CEO"
},
"ownershipTypeCd": "PUBCORP",
"publiclyTradedFlag": "true",
"stockSymbol": "SPY",
"driversLicenseNumber": "123456789",
"driversLicenseStateCd": "CO",
"ownerOwnershipPct": 80,
"additionalOwners": [
{
"ownerFirstName": "Forename",
"ownerLastName": "Surname",
"ownershipPct": 15
},
{
"ownerFirstName": "Forename",
"ownerLastName": "Surname",
"ownershipPct": 5
}
]
},
"bankDetail": {
"depositBank": {
"bankAcctNum": "123456789",
"bankRoutingNum": "987654321",
"bankAcctTypeCd": "BIZ",
"bankName": "Deposit Bank"
},
"withdrawalBank": {
"bankAcctNum": "123456789",
"bankRoutingNum": "987654321",
"bankAcctTypeCd": "BIZ",
"bankName": "Withdrawal Bank"
}
},
"merchantContactInfo": {
"contactName": "Forename Surname",
"contactEmail": "name@email.com",
"contactPhone": "555-123-4567"
},
"processing": {
"platformDetails": {
"backEndMid": null,
"frontEndMid": null,
"processorReportingMid": null,
"backEndPlatformCd": null,
"frontEndPlatformCd": null,
"amexProgramAssetCd": "OPTBLUE",
"amexProgramMid": "2341251235434",
"discoverMid": "601153746288719",
"discoverProgramCd": "MAP",
"incrementalAuthorizationFlg": false,
"debtRepaymentProgramFlg": false,
"acquiringFlg": true,
"taxId": "485968574",
"tid": "96859685",
"busnsId": "234444234234",
"busnsIdPlaceOfIssue": "CO",
"mccId": "3076",
"currencyCode": "USD",
"businessDescription": "Business Description",
"iataCode": "12345678",
"quasiCashFlg": false
},
"businessDetails": {
"customerBillPriorToShipFlg": false,
"depositReqForFulfillFlg": true,
"whenCustomerChargedCd": "INADVANCE",
"refundPolicyCd": "EXCHONLY",
"serviceProvidedInCd": "30LESS"
},
"volumeDetails": {
"averageMonthlyVolume": 9999.00,
"highTicketAmount": 99.99,
"averageTicketAmount": 9.99
},
"deliveryPercentages": {
"dlvry0To7DaysPct": 97,
"dlvry15To30DaysPct": 1,
"dlvry8To14DaysPct": 1,
"dlvryOver30DaysPct": 1
},
"modeOfTransaction": {
"eCommercePct": 0,
"keyedPct": 20,
"mailOrderPct": 30,
"swipedPct": 50
},
"blueChexVolume" : {
"averagePerTransactionSalesAmount" : "250.00",
"maxPerTransactionSalesAmount" : "9999.00",
"averagePerTransactionCreditAmount" : "200.00",
"maxPerTransactionCreditAmount" : "9999.00",
"averagePerMonthSalesAmount" : "25000.00",
"maxPerMonthSalesAmount" : "50000.00",
"averagePerMonthCreditAmount" : "5000.00",
"maxPerMonthCreditAmount" : "10000.00"
},
"blueChexSecOptions": {
"telSecOptionFlg": false,
"ccdSecOptionFlg": false,
"webSecOptionFlg": false,
"ppdSecOptionFlg": true
}
},
"pricing": {
"flatPricing": {
"amex": {
"esaQualDiscountPct": 22.00,
"optBlueQualDiscountPct": 11.00
},
"discover": {
"qualCreditDiscountPct": 0.100
},
"mastercard": {
"qualCreditDiscountPct": 0.200
},
"visa": {
"qualCreditDiscountPct": 0.300
}
},
"icPlusPricing": {
"interchangeTypeCode": "GROSS",
"amex": {
"optBlueQualDiscountPct": 8.00
},
"discover": {
"qualCreditDiscountPct": 1.00
},
"mastercard": {
"qualCreditDiscountPct": 5.00
},
"visa": {
"qualCreditDiscountPct": 4.00
}
},
"fees": {
"achBatchFee": 1.11,
"addressVerifFee": 2.22,
"annualMembershipFee": 3.33,
"appFee": 4.44,
"authFee": 5.55,
"chargebackFee": 6.66,
"ddaRejectFee": 9.99,
"earlyCancelFee": 199.99,
"minProcessFee": 20.00,
"monthlyEquipmentRentalFee": 10.00,
"pciProgramCd": "ANNUAL",
"pciAnnualFee": 119.00,
"pciNonComplianceFee": 29.95,
"regProdMonthlyFee": 200.00,
"retrievalFee": 10.00,
"statementFee": 27.99,
"transactionFee": 0.05,
"voiceAuthFee": 0.10,
"wirelessActivationFee": 0.10,
"wirelessFee": 50.00,
"duesAndAssessmentsFlg": true,
"passthruInterchgCostsFlg": true
},
"cloverSecurityAndTransarmor": {
"transarmorDataProtectionFlg": false,
"transarmorTokenTypeCd": "MULTI",
"transarmorMultiPayToken": "A1B2",
"transarmorMonthyFee": 4.99
},
"customFields": [
{
"userFieldNumber": 1,
"customFieldValue": "example value 1"
},
{
"userFieldNumber": 2,
"customFieldValue": "example value 2"
}
],
},
"ownerSiteUser": {
"firstName": "Forename",
"lastName": "Surname",
"email": "name@email.com"
}
}
Use the POST method to create a new merchant account using a pre-existing application template that has been created in the CoPilot web interface. A successful request returns the merchantId
property, which is used to identify the account within CoPilot and is used in subsequent API calls for additional boarding operations.
The code example to the right is not representative of a legitimate request as it includes all possible fields, including those that would generate a conflict when creating a merchant.
See the CoPilot Developer Guides to learn about the minimum data requirements and process of creating a new merchant.
Method POST Host https://api-uat.cardconnect.com Path
/merchant Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes application/json Produces application/json
Create Merchant Request Body Example Create Merchant Request
{
"templateId": 9999,
"merchant": { ... } ,
"ownerSiteUser": { ... }
}
Field Size Type Required Comments templateId 19 number yes The ID of the application template created within the CoPilot web interface. merchant n/a object yes The merchant object . ownerSiteUser n/a object no The owner site user object is used to create the merchant's CardPointe user. If this is null, a CardPointe user will be created using the ownership fields in the merchant.
Example Create Merchant Response
{
"merchantId": 12345678,
"errors": null
}
Field Size Type Comments merchantId 19 number The merchant ID used to identify the account within CoPilot. errors n/a array The errors array containing one or more errors if there was a problem creating the merchant.
Example Get Merchant Data Response
{
"errors": null,
"merchant": {
"merchantId": 12345678,
"customerId": 87654321,
"akaBusinessName": "The Card Shoppe",
"custPrimaryAcctFlg": true,
"dbaName": "The Card Shoppe",
"legalBusinessName": "The Card Shoppe LLC",
"taxFilingName": "The Card Shoppe LLC",
"demographic": {
"businessIncorporatedStateCd": "CO",
"merchantTimeZone": "MT",
"websiteAddress": "www.example.com",
"businessPhone": "555-123-4567",
"businessFax": "555-987-6543",
"businessAddress": {
"address1": "123 Fake Street",
"address2": "Suite 300",
"city": "Keystone",
"countryCd": "US",
"stateCd": "CO",
"zip": "80435"
},
"mailingAddress": {
"address1": "123 Fake Street",
"address2": "Suite 300",
"city": "Keystone",
"countryCd": "US",
"stateCd": "CO",
"zip": "80435"
}
},
"businessIdTypeCd": "ARTICLE",
"businessStartDate": "04/26/2002",
"bankDetail": {
"depositBank": {
"bankAcctNum": "123456789",
"bankRoutingNum": "987654321",
"bankAcctTypeCd": "BIZ",
"bankName": "Deposit Bank"
},
"withdrawalBank": {
"bankAcctNum": "123456789",
"bankRoutingNum": "987654321",
"bankAcctTypeCd": "BIZ",
"bankName": "Withdrawal Bank"
}
},
"cloverSecurityAndTransarmor": {
"transarmorDataProtectionFlg": false,
"transarmorTokenTypeCd": "MULTI",
"transarmorMultiPayToken": "A1B2",
"transarmorMonthyFee": 4.99
},
"ownership": {
"owner": {
"ownerAddress": {
"address1": "1 Imaginary Lane",
"address2": "Apt 221B",
"city": "Dillon",
"countryCd": "US",
"stateCd": "CO",
"zip": "80435"
},
"ownerEmail": "name@email.com",
"ownerName": "Forename Surname",
"ownerDob": "09/04/1929",
"ownerPhone": "555-123-4567",
"ownerMobilePhone": "555-987-6543",
"ownerTitle": "CEO",
"ownerSSN": "111-22-3333"
},
"additionalOwners": [
{
"ownerFirstName": "Forename",
"ownerLastName": "Surname",
"ownerPhone": null,
"ownerAddress": {
"address1": null,
"address2": null,
"city": null,
"countryCd": null,
"stateCd": null,
"zip": null
},
"ownerSSN": null,
"ownershipPct": 15,
"ownerDob": null
},
{
"ownerFirstName": "Forename",
"ownerLastName": "Surname",
"ownerPhone": null,
"ownerAddress": {
"address1": null,
"address2": null,
"city": null,
"countryCd": null,
"stateCd": null,
"zip": null
},
"ownerSSN": null,
"ownershipPct": 5,
"ownerDob": null
}
],
"ownershipTypeCd": "PUBCORP",
"driversLicenseNumber": "123456789",
"driversLicenseStateCd": "CO",
"ownerOwnershipPct": 80,
"publiclyTradedFlag": "true",
"stockSymbol": "SPY"
},
"ownerSiteUserId": 234932,
"merchantContactInfo": {
"contactName": "Forename Surname",
"contactEmail": "name@email.com",
"contactPhone": "555-123-4567"
},
"salesCode": "API1",
"hierarchy": {
"sponsorBankCd": "WELLS",
"corpLevel": "000000000001",
"chainLevel": "000000000002"
},
"processing": {
"platformDetails": {
"backEndMid": null,
"frontEndMid": null,
"processorReportingMid": null,
"backEndPlatformCd": null,
"frontEndPlatformCd": null,
"amexProgramAssetCd": "OPTBLUE",
"amexProgramMid": "2341251235434",
"discoverMid": "601153746288719",
"discoverProgramCd": "MAP",
"incrementalAuthorizationFlg": false,
"debtRepaymentProgramFlg": false,
"acquiringFlg": true,
"taxId": "485968574",
"tid": "96859685",
"busnsId": "234444234234",
"busnsIdPlaceOfIssue": "CO",
"mccId": "3076",
"currencyCode": "USD",
"businessDescription": "Business Description",
"iataCode": "12345678",
"quasiCashFlg": false
},
"businessDetails": {
"customerBillPriorToShipFlg": false,
"depositReqForFulfillFlg": true,
"whenCustomerChargedCd": "INADVANCE",
"refundPolicyCd": "EXCHONLY",
"serviceProvidedInCd": "30LESS"
},
"volumeDetails": {
"averageMonthlyVolume": 9999,
"highTicketAmount": 99.99,
"averageTicketAmount": 9.99
},
"deliveryPercentages": {
"dlvry0To7DaysPct": 97,
"dlvry15To30DaysPct": 1,
"dlvry8To14DaysPct": 1,
"dlvryOver30DaysPct": 1
},
"modeOfTransaction": {
"eCommercePct": 0,
"keyedPct": 20,
"mailOrderPct": 30,
"swipedPct": 50
},
"blueChexVolume" : {
"averagePerTransactionSalesAmount" : "250.00",
"maxPerTransactionSalesAmount" : "9999.00",
"averagePerTransactionCreditAmount" : "200.00",
"maxPerTransactionCreditAmount" : "9999.00",
"averagePerMonthSalesAmount" : "25000.00",
"maxPerMonthSalesAmount" : "50000.00",
"averagePerMonthCreditAmount" : "5000.00",
"maxPerMonthCreditAmount" : "10000.00"
},
"blueChexSecOptions": {
"telSecOptionFlg": false,
"ccdSecOptionFlg": false,
"webSecOptionFlg": false,
"ppdSecOptionFlg": true
}
},
"webLeadFlg": true,
"taxFilingMethod": "EIN",
"pricing": {
"flatPricing": {
"amex": {
"esaQualDiscountPct": 22.00,
"optBlueQualDiscountPct": 11.00
},
"discover": {
"qualCreditDiscountPct": 1.00
},
"mastercard": {
"qualCreditDiscountPct": 5.00
},
"visa": {
"qualCreditDiscountPct": 4.00
}
},
"icPlusPricing": null
},
"fees": {
"achBatchFee": 1.11,
"addressVerifFee": 2.22,
"annualMembershipFee": 3.33,
"appFee": 4.44,
"authFee": 5.55,
"chargebackFee": 6.66,
"ddaRejectFee": 9.99,
"earlyCancelFee": 99.99,
"minProcessFee": 20,
"monthlyEquipmentRentalFee": 10.00,
"pciProgramCd": "ANNUAL",
"pciAnnualFee": 119.00,
"pciNonComplianceFee": 29.95,
"regProdMonthlyFee": 200,
"retrievalFee": 10,
"statementFee": 27.99,
"transactionFee": 0.05,
"voiceAuthFee": 0.1,
"wirelessActivationFee": 0.1,
"wirelessFee": 50,
"duesAndAssessmentsFlg": true,
"passthruInterchgCostsFlg": true
},
"customFields": [
{
"customFieldLabel": "Custom Field 1",
"isRequired": 0,
"isActive": 1,
"userFieldNumber": 1,
"customFieldValue": "example value 1"
},
{
"customFieldLabel": "Custom Field 2",
"isRequired": 1,
"isActive": 1,
"userFieldNumber": 2,
"customFieldValue": "example value 2"
}
],
"merchantStatus": {
"approvedDatetime": null,
"boardedDatetime": null,
"cancelledDatetime": null,
"declinedDatetime": null,
"liveDatetime": null,
"boardingProcessPendingFlg": false,
"boardingProcessStatusCd": "INPROG",
"gatewayBoardingStatusCd": "NOT_BOARDED"
},
"signatureStatus": {
"signedSiteUserId": null,
"signedDateTime": null,
"signer": null,
"signatureUrl": "https://apply.cardpointe.com/register?registrationKey=0ae27e24-bf8e-4151-9be4-0dd82cbbfcc4&merchantId=12345678",
"signatureStatusCd": "PENDING"
},
"changedDateTime": "07/11/2017 06:39:41 PM",
"createdDateTime": "07/11/2017 06:39:41 PM"
},
"ownerSiteUser": {
"firstName": "Forename",
"lastName": "Surname",
"email": "name@email.com"
}
}
Use the GET method to retrieve all
merchant account data, such as contact and owner information, business
details, processing information, pricing, and fees.
Method GET Host https://api-uat.cardconnect.com Path
/merchant/{merchantId} Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes n/a Produces application/json
Get Merchant Data Request
GET https://api-uat.cardconnect.com/merchant/123456789
Get Merchant Data Response
A successful request returns the following, as shown in the example to the right:
Update Merchant Data
Once a merchant account has been created, use the PUT method to update any account data prior to submitting for digital signing by the merchant.
Updating merchant data is only possible when the account has not yet been submitted for digital signature. Use the Get Merchant Status endpoint to verify that the boardingProcessStatusCd
is INPROG. If the boardingProcessStatusCd
is OFS, then the account has been submitted for digital signature but has not yet been signed. If that is the case, you must use the Retract Signature endpoint before modifying any account data.
Method PUT Host https://api-uat.cardconnect.com Path
/merchant/{merchantId} Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes application/json Produces application/json
Partial Updates
It is necessary to supply all children of an object when updating merchant data. When only one field within an object is supplied, the remaining fields within that object are overwritten with null. Objects omitted from the PUT request retain their values.
As an example, submitting a PUT request that only includes a value for merchant.ownership.driversLicenseNumber
within the request body sucessfully sets the new driversLicenseNumber
value, and overwrites all other fields within the merchant.ownership
object with null
. Objects not included in the request, such as the merchant.pricing object
, retain their existing values.
Updating the Owner
Updating data within the merchant.ownership.owner
object does not automatically update the values in the ownerSiteUser
object. Use the GET and PUT methods of the Owner Site User endpoint to check the current values for the ownerSiteUser
object and update if necessary.
Update Merchant Data Request Body Example Update Merchant Data Request
{
"merchant": { ... },
"ownerSiteUser": { ... }
}
Field Size Type Required Comments merchant n/a object yes The merchant object .
ownerSiteUser n/a object no The owner site user object is used to create the merchant's CardPointe user. When null, no changes are made to the owner site user.
Update Merchant Data Response Example Update Merchant Data Response
{
"errors": null
}
Field Size Type Comments errors n/a array The errors array containing one or more errors if there was a problem updating the merchant.
Get Merchant Status
Use the Merchant Status endpoint to retrieve the account boarding and gateway boarding status, as well as the date and time that the account transitioned to a new status.
Method GET Host https://api-uat.cardconnect.com Path
/merchant/{merchantId}/status Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes n/a Produces application/json
Get Merchant Status Request
GET https://api-uat.cardconnect.com/merchant/123456789/status
Get Merchant Status Response Example Get Merchant Status Response
{
"errors": null,
"merchantStatus": {
"approvedDatetime": "10/21/2013 08:18:18 AM",
"boardedDatetime": "10/21/2013 11:41:00 AM",
"cancelledDatetime": null,
"declinedDatetime": null,
"liveDatetime": "10/22/2013 07:09:09 AM",
"boardingProcessPendingFlg": false,
"boardingProcessStatusCd": "LIVE",
"gatewayBoardingStatusCd": "BOARDED"
}
}
A successful request returns the errors
object, as well as the merchantStaus
object containing the following fields:
Field Type Comments approvedDatetime string The date and time the account transitioned to the APPROVED status. The date and time is reported in local time, based on the timezone selected in the CoPilot web interface. boardedDatetime string The date and time the account transitioned to the BOARDED status. The date and time is reported in local time, based on the timezone selected in the CoPilot web interface. cancelledDatetime string The date and time the account transitioned to the CANCELLED status. The date and time is reported in local time, based on the timezone selected in the CoPilot web interface. declinedDatetime string The date and time the account transitioned to the DECLINED status. The date and time is reported in local time, based on the timezone selected in the CoPilot web interface. liveDatetime string The date and time the account transitioned to the LIVE status. The date and time is reported in local time, based on the timezone selected in the CoPilot web interface. boardingProcessPendingFlg boolean boardingProcessStatusCd enumeration
See below gatewayBoardingStatusCd enumeration See below
Boarding Process Status Codes
Code Description
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.
OFS The digital application is awaiting merchant signature. Displayed in the CoPilot web interface as "Pending Signature."
QUALIFY The digital application is signed and undergoing an inital review before being sent for underwriting. Displayed in the CoPilot web interface as "Qualifying."
UNDER The application is being reviewed by the Underwriting team. Displayed in the CoPilot web interface as "Underwriting."
DECLINED The application has been rejected by the Underwriting team.
BOARDING The merchant account is in the process of being boarded to the processing platform.
BOARDED The merchant account is successfully boarded to the processing platform.
LIVE The merchant account is boarded to the processing platform, the CardPointe Gateway, and is receiving deposits.
CANCELLED The merchant account is cancelled.
Gateway Boarding Status Codes
Code Description NOT_BOARDED The merchant ID is not yet boarded to the CardPointe Gateway. BOARDED The merchant account is boarded to the processing platform and the merchant ID is boarded to the CardPointe Gateway.
Signature
The Signature endpoint is used to provide the digital application to
the merchant for signature, view the current status of a digital
application that is pending signature, or retract the digital
application in order to modify it before the merchant has signed.
Request Signature
Use the PUT request when you are ready to submit the application for
the merchant to review and sign. If successful, the response returns a
unique URL that can be provided to the owner to review and sign the
application digitally.
See the CoPilot Developer Guides to learn about how to track the status of a new account after requesting the link to the digital application.
Method PUT Host https://api-uat.cardconnect.com Path
/merchant/{merchantId}/signature Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes application/json Produces application/json
Request Signature Request Body
No request body is required for this endpoint.
Request Signature Response Example Request Signature Response
{
"errors": null,
"signatureUrl": "https://cardpointe-uat.cardconnect.com/account/login#/password/02d34909-93b3-4b50-adf4-1ff91e92b33c/c08709da-8af1-4f35-8e0f-f52eca60ef81?newuser"
}
Field Type Comments errors array The errors array containing one or more errors if there was a problem requesting the signature. signatureUrl string The URL for the digital application that is provided to the merchant.
Get Signature Status
Use the GET request to view the current status of an application that has been submitted to the merchant for signing.
Method GET Host https://api-uat.cardconnect.com Path
/merchant/{merchantId}/signature Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes n/a Produces application/json
Get Signature Status Request
GET https://api-uat.cardconnect.com/merchant/123456789/signature
Get Signature Status Response Example Get Signature Status Response
{
"errors": null,
"signatureStatus": {
"signedSiteUserId": 237322,
"signedDateTime": "07/19/2017 04:44:28 PM",
"signer": {
"email": "name@email.com",
"firstName": "Forename",
"lastName": "Surname",
"ipAddress": "192.168.125.126",
"personalGuaranteeFlg": true
},
"signatureUrl": "https://cardpointe-uat.cardconnect.com/account/login#/password/02d34909-93b3-4b50-adf4-1ff91e92b33c/c08709da-8af1-4f35-8e0f-f52eca60ef81?newuser",
"signatureStatusCd": "SIGNED"
}
}
A successful request returns the errors
object, as well as the signatureStatus
object containing the following fields:
Field Type Comments signedSiteUserId number The ID of the owner site user who signed the application. signedDateTime string The date and time the application was signed. The date and time is reported in local time, based on the timezone selected in the CoPilot web interface. signer object The signer object containing the signer's details. signatureUrl string The URL for the digital application that the signer accessed to complete the digital application. signatureStatusCd enumeration Can be one of the following:
NOT_SENT - No URL for the digital application exists.PENDING - The URL for the digital application exists and is pending completion by the merchant.SIGNED - The digital application has been completed and signed.
Signer Definition
Field Type Comments email string The email of the signer. firstName string The first name of the signer. lastName string The last name of the signer. ipAddress string The signer's IP address at the time of signing. personalGuaranteeFlg boolean True when the owner selected the Personal Guarantee option.
Retract Signature
Use the DELETE method to disable the URL that is used by the owner to review and sign the digital application. This reverts the merchant's status to the INPROG state, allowing you to make modifications to the account data.
This method can only be used when the application is pending signature. Use Get Signature Status to verify that the current signature status is PENDING, which indicates that the application has been submitted to the owner for signing, but has not yet been signed.
After updating the account data, use Request Signature to generate a new unique URL that the owner will use to review and sign the digital application.
Method DELETE Host https://api-uat.cardconnect.com Path
/merchant/{merchantId}/signature Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes n/a Produces application/json
Retract Signature Request Body
No request body is required for this endpoint.
Retract Signature Response Example Retract Signature Response
{
"errors": null
}
Field Type Comments errors object The errors array containing one or more errors if there was a problem
Attachment
The Attachment endpoint allows you to upload documents that may be required before the account can be boarded, such as hard copies of agreements that have been completed and signed by the merchant, or a copy of a voided check. Refer to the Attachment Type Codes to view the various agreements, forms, and documents that can be attached to a merchant account.
Method PUT Host https://api-uat.cardconnect.com Path
/merchant/{merchantId}/attachment Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes application/json Produces application/json
Upload Attachment Request Body Example Upload Attachment Request
{
"attachment": {
"fileName" : "VoidedCheck.pdf",
"mimeType" : "application/pdf",
"description" : "This is the voided check",
"attachmentTypeCd" : "VOIDBNKCHK1",
"document" : "JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg=="
}
}
Field Size Type Required Comments fileName 60 string yes The file name of the attachment. mimeType 30 string yes The MIME type of the attachment file. description 1000 string yes The description of the attachment file. attachmentTypeCd n/a string yes The attachment type code that represents the type of attachment. document 100mb string yes The document to upload, provided as a Base 64 encoded file.
Note: Attach only documents or image files. Audio and video files are not supported.
Upload Attachment Response Example Upload Attachment Response
{
"errors": null,
"attachmentId": 123456
}
Field Type Comments errors array The errors array containing one or more errors if there was a problem uploading the attachment. attachmentId number The ID of the attachment for reference.
Equipment Catalog
The Equipment Catalog endpoint provides a list of terminals, gateways, and software available for ordering based on the Sales Code supplied in the query string. Use the endpoint to determine the equipment ID of a add-on to be used in a subsequent call to the Create Order endpoint.
Method GET Host https://api-uat.cardconnect.com Path
/equipmentCatalog/list Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes n/a Produces application/json
Equipment Catalog Request
GET https://api-uat.cardconnect.com/equipmentCatalog/list?salesCode=salescode1&equipmentSupplierCd=CARDCONNECT&equipmentTypeCd=TERMINAL&pageNumber=1&pageSize=2
Field Required Comments salesCode yes The Sales Code of the merchant that requires additional equipment. equipmentSupplierCd no The equipment supplier code . Used to return only equipment of a specific supplier. equipmentTypeCd no The equipment type code . Used to return only equipment of a specific type. pageNumber no The number of the page being requested. pageSize no The number of results to limit per page.
Equipment Catalog Response Example List Equipment Catalog Response
{
"rows": [
{
"equipmentId": 123,
"equipmentName": "Generic Card Swiper",
"description": "Equipment Description",
"make": "Acme",
"model": "200X",
"imageUrl": "https://image/image.png",
"sku": null,
"platformCd": null,
"equipmentTypeCd": "TERMINAL",
"equipmentSupplierCd": "CARDCONNECT",
"defaultPrice": 199,
"defaultPlanPrice": 25,
"allowCustomBillingFlg": 1,
"standardShippingPrice": 20,
"expeditedShippingPrice": 25
}
],
"totalServerItemsCount": 1,
"totalDisplayItemsCount": 1,
"moreRowsAvailable": false,
"columnSums": null,
"errors": null
}
Field Type Comments rows array List of equipment definitions returned as an array of equipment objects . totalServerItemsCount number Total number of rows. totalDisplayItemsCount number The total number of rows before and including this page. moreRowsAvailable boolean True if the are more rows available on the next page. columnSums n/a Internal use. errors array The errors array containing one or more errors if there was a problem with the request.
Order
The Order endpoint is used primarily to create a new equipment order for a merchant account, using the equipment's equipmentId
that can be obtained by calling the Equipment Catalog endpoint.
You can also use additional Order endpoints to retrieve the details of a specific order, update an order, cancel an order, as well as using the list endpoint to retrieve all orders for a merchant account.
Create Order Use the POST method to create a new equipment order for an existing merchant account. Submitting an order requires equipmentId
, which can be obtained by calling the Equipment Catalog endpoint for a list of available equipment and the associated equipment IDs.
When placing an equipment order, the following options are available:
Equipment orders may be billed using any of the methods supported by your partner account, such as billing to your partner residuals, partner credit card, or to the customer directly. Billing for equipment can be set as a monthly charge, or an upfront one-time charge.
Method POST Host https://api-uat.cardconnect.com Path
/order Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes application/json Produces application/json
Create Order Request Body Example Create Order Request
{
"order": { ... }
}
Field Size Type Required Comments order n/a object yes The order object .
Order Definition (Request) Example Order (Upfront Billing to Partner Residuals)
{
"order": {
"merchantId": 12345678,
"equipmentId": 35,
"orderNotes": "Test order notes",
"quantity": 1,
"unitPrice": 170.00,
"billToCd": "CUST",
"billingFrequencyCd": "ONETIME",
"profileId": "12345678901234567890",
"acctId": 1
"shippingDetails": {
"shippingAddress": {
"address1": "123 Fake Street",
"address2": "Suite 300",
"city": "Keystone",
"stateCd": "CO",
"zip": "80435",
"countryCd": "US"
},
"shipToAttn": "Forename Surname",
"shipToAttnEmail": "name@email.com",
"shippingMethodCd": "STANDARD",
"shippingBillToCd": "PARTNER",
"shippingCarrierCd": "FEDEX",
"trackingNumber": "12345abc",
"shippingCost": 10.50,
"merchantContactPhone": "555-123-4567",
"merchantContactPhoneExt": "55555",
"poNumber": "4455"
}
}
}
Field Size Type Required Comments merchantId 19 number yes The merchant ID associated with the order. equipmentId 19 number yes The equipment ID of the equipment being ordered. orderNotes 1000 string no Optional notes for the person fulfilling the order. quantity 4 number yes The number of devices being ordered. unitPrice 10 number See comments The price per unit. Required only when billToFrequencyCd is ONETIME. monthlyPrice 10 number See comments The price per month. Required only when billToFrequencyCd is MONTHLY. billToCd 100 string yes The bill to code that represents who is billed for the order. billingFrequencyCd 100 string yes The billing frequency code that represents the frequency of billing. profileId n/a string See comments The CardPointe Gateway profile ID to charge for this order. Required only when billToCd is PARTNERCC. acctId 10 number See comments The account ID of the card within the CardPointe Gateway profile to charge for this order. Required only when billToCd is PARTNERCC. shippingDetails n/a object yes The shipping details object .
Create Order Response {
"orderId": 1111111,
"errors": null
}
Field Type Comments orderId number The ID of the order for reference. errors array The errors array containing one or more errors if there was a problem creating the order.
Get Order
Use the GET method to retrieve the details and status of a specific equipment order.
Method GET Host https://api-uat.cardconnect.com Path
/order/{orderId} Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes n/a Produces application/json
Get Order Request
GET https://api-uat.cardconnect.com/order/123456
Get Order Response Example Get Order Response
{
"orderId": 1111111,
"merchantId": 1234567890,
"equipmentId": 35,
"orderNotes": "Order Notes example",
"quantity": 1,
"unitPrice": 170.00,
"monthlyPrice": null,
"profileId": "12345678901234567890",
"acctId": 1,
"billToCd": "CUST",
"billingFrequencyCd": "ONETIME",
"shippingDetails": {
"shippingAddress": {
"address1": "123 Fake Street",
"address2": "Suite 300",
"city": "Keystone",
"stateCd": "CO",
"zip": "80435",
"countryCd": "US"
},
"shipToAttn": "Forename Surname",
"shipToAttnEmail": "name@email.com",
"shippingMethodCd": "STANDARD",
"shippingBillToCd": "PARTNER",
"shippingCarrierCd": "FEDEX",
"trackingNumber": "12345abc",
"shippingCost": 10.50,
"merchantContactPhone": "555-123-4567",
"merchantContactPhoneExt": "55555",
"poNumber": "4455",
},
"orderStatusCd": "PLACED",
"placedDatetime": "10/27/2020 12:22:42 PM",
"shippedDatetime": null,
"canceledDatetime": null,
"fulfillingDatetime": null
}
Field Type Comments orderId number The order ID used to reference this order. merchantId number The merchant ID associated with the order. equipmentId number The equipment ID of the equipment ordered. orderNotes string Optional notes for the person fulfilling the order. quantity number The number of devices ordered. unitPrice number The price per unit. monthlyPrice number The price per month. billToCd string The bill to code that represents who is billed for the order. billingFrequencyCd string The billing frequency code that represents the frequency of billing. profileId string The CardPointe Gateway profile ID charged for this order. acctId number The account ID of the card within the CardPointe Gateway profile charged for this order shippingDetails string The shipping details object . orderStatusCd string The order status code that represents the current status of the order. placedDatetime string The date and time the order was placed. The date and time is reported in local time, based on the timezone selected in the CoPilot web interface. shippedDatetime string The date the order was shipped. The date and time is reported in local time, based on the timezone selected in the CoPilot web interface. canceledDatetime string The date the order was canceled. The date and time is reported in local time, based on the timezone selected in the CoPilot web interface. fulfillingDatetime string The date the order was fulfilled. The date and time is reported in local time, based on the timezone selected in the CoPilot web interface.
List Orders
You can retrieve a list of all orders for a specific merchant account by using the List Orders endpoint.
Method GET Host https://api-uat.cardconnect.com Path
/order/list Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes n/a Produces application/json
List Orders Request
GET https://api-uat.cardconnect.com/order/list?merchantId=123456789&pageSize=2&pageNumber=1
Field Required Comments merchantId yes The merchant ID used to identify the account within CoPilot. pageSize no The number of results to limit per page. pageNumber no The number of the page being requested.
List Orders Response Example List Orders Response
{
"errors": null,
"rows": [
{
"orderId": 1111111,
"equipmentId": 35,
"merchantId": 12345678,
"orderNotes": "Test order notes",
"quantity": 1,
"unitPrice": 170.00,
"monthlyPrice": null,
"profileId": "12345678901234567890",
"acctId": 1,
"billToCd": "CUST",
"billingFrequencyCd": "ONETIME",
"shippingDetails": {
"shippingAddress": {
"address1": "123 Fake Street",
"address2": "Suite 300",
"city": "Keystone",
"stateCd": "CO",
"zip": "80435",
"countryCd": "US"
},
"shipToAttn": "Forename Surname",
"shipToAttnEmail": "name@email.com",
"shippingCarrierCd": "FEDEX",
"trackingNumber": "12345abc",
"shippingCost": 10.50,
"shippingMethodCd": "STANDARD",
"shippingBillToCd": "PARTNER",
"merchantContactPhone": "555-123-4567",
"merchantContactPhoneExt": "55555",
"poNumber": "4455"
},
"orderStatusCd": "PLACED",
"placedDatetime": "10/27/2020 12:22:42 PM",
"shippedDatetime": null,
"canceledDatetime": null,
"fulfillingDatetime": null
}
],
"totalServerItemsCount": 1,
"totalDisplayItemsCount": 1,
"moreRowsAvailable": false,
"columnSums": null
}
Field Type
Comments errors
array The errors array containing one or more errors if there was a problem creating the order. rows array An array of order objects .
totalServerItemsCount number The total number of rows. totalDisplayItemsCount number The total number of rows before and including this page. moreRowsAvailable boolean True if there are more rows available on the next page. columnSums n/a Internal use.
Update Order
Use the Update Order endpoint to make changes to an existing order, such as the quantity, price, or the bill to code.
Method PUT Host https://api-uat.cardconnect.com Path
/order/{orderId} Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes application/json Produces application/json
Update Order Request Body Example Update Order Request
{
"order": { ... }
}
Field Size Type Required Comments order n/a object yes The order object .
Note: It is not possible to change merchantId
and equipmentId
for an existing order.
Example Update Order Response
{
"errors": null
}
Field Type Comments errors array
The errors array containing one or more errors if there was a problem creating the order.
Cancel Order
The Cancel Order endpoint can be used to cancel any order where the orderStatusCd
is NEW. Use the Get Order endpoint to verify an order's current status.
Method POST Host https://api-uat.cardconnect.com Path
/order/{orderId}/cancel Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes n/a Produces application/json
Cancel Order Response Example Cancel Order Response
{
"errors": null
}
Field Type Comments errors array
The errors array containing one or more errors if there was a problem cancelling the order.
Custom Fields
Custom fields can be enabled for your partner account to include additional merchant data, such as associated account numbers, the account's regional area, or any other type of data that you wish to notate.
You can use the PUT or GET methods to update the custom field values for a merchant, or view the current custom fields configured and the current merchant values. If you need to enable a field, disable it, or change whether the field is required, access the CoPilot web interface to make these changes to your partner account.
Update Custom Fields
Use the PUT method to update the custom field values for a merchant,
if custom fields are already configured for your merchant via the CoPiot
web interface. If unsure, you can use the GET method to view the currently
configured custom fields for your partner account. Custom fields that
are enabled and required need to be provided before the account can be
submitted for digital signature.
Method PUT Host https://api-uat.cardconnect.com Path
/merchant/{merchantId}/customfields Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes application/json Produces application/json
Update Custom Fields Request Example Update Custom Fields Request
{
"customFields": [ ... ]
}
Field Size Type Required Comments customFields n/a array See comments The custom fields array containing objects for each custom field. Required when one or more custom fields have been configured in the CoPilot web interface as a required field for new merchants.
Update Custom Fields Response Example Update Custom Fields Response
{
"errors": null
}
Field Size Type Comments errors n/a array The errors array containing one or more errors if there was a problem updating the custom fields.
Get Custom Fields
Use the GET method to retrieve the list of custom fields configured for your partner account, the custom fields you have set as required for new merchants, as well as the values currently set for the merchant.
Method GET Host https://api-uat.cardconnect.com Path
/merchant/{merchantId}/customfields Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes n/a Produces application/json
Get Custom Fields Request
GET https://api-uat.cardconnect.com/merchant/123456789/customfields
Get Custom Fields Response Example Get Custom Fields Response
{
"customFields": [
{
"customFieldLabel": "Custom Field 1",
"isRequired": 0,
"isActive": 1,
"userFieldNumber": 1,
"customFieldValue": "example value 1"
},
{
"customFieldLabel": "Custom Field 2",
"isRequired": 1,
"isActive": 1,
"userFieldNumber": 2,
"customFieldValue": "example value 2"
}
]
}
The customFields
array that is returned includes additional fields that provide details on the custom fields configured, including whether they are currently active or required fields. Refer to the following table for the extended customFields
object that is returned with the GET response.
Field Type Comments customFieldLabel string The label for this custom field, set via the CoPilot web interface. isRequired number When 0 , this custom field is configured in the CoPilot web interface as not required . When 1 , this custom field is configured in the CoPilot web interface as required . isActive number When 0 , this custom field is configured in the CoPilot web interface as inactive.
When 1 , this custom field is configured in the CoPilot web interface as active.
userFieldNumber number A value from 1-10 that represents this custom field's number and is used as an identifier when updating the value via a PUT request. customFieldValue string The custom field's value currently set for this account, whether set via the CoPilot web interface or via the CoPilot API.
Owner Site User
Owner Site User data is used to create a CardPointe account for the
owner when the merchant account is submitted for digital signing. If no ownerSiteUser
object was provided when creating a merchant account, the fields are populated using data from the merchant.ownership.owner
object. You can use the PUT method to update this data or the GET method to view the current values.
Ensure this information is accurate as the owner uses this account to review and sign the digital application. This CardPointe user account also provides the owner access to the CardPointe Web App to view the status of their application, manage account settings, and later view CardPointe Gateway transactions and reports once boarded to the Gateway.
Update Owner Site User
If the owner has not already registered a CardPointe account with the email address currently specified in the ownerSiteUser
object, use the PUT method to update these values. If the owner has already completed the CardPointe user registration process, they must log in to CardPointe in order to update this information.
Method PUT Host https://api-uat.cardconnect.com Path
/merchant/{merchantId}/ownerSiteUser Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes application/json Produces application/json
Update Owner Site User Request Body Example Update Owner Site User
{
"ownerSiteUser": { ... }
}
Update Owner Site User Response Example Update Site User Response
{
"errors": null
}
Field Type Comments errors array The errors array containing one or more errors if there was a problem updating the owner site user.
Get Owner Site User
Use the GET method to retrieve the current owner site user data for an account.
Method GET Host https://api-uat.cardconnect.com Path
/merchant/{merchantId}/ownerSiteUser Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Consumes n/a Produces application/json
Get Owner Site User Request
GET https://api-uat.cardconnect.com/merchant/123456789/ownerSiteUser
Get Owner Site User Response Example Get Owner Site User Response
{
"ownerSiteUser": { ... },
"errors": null
}
Field Type Comments ownerSiteUser object The owner site user object . errors array The errors array containing one or more errors if there was a problem retrieving the owner site user.
Schemas
See the schema definitions below to view the fields available for each object within the API.
Additional Owners Example Additional Owners
{
"ownerFirstName": "Forename",
"ownerLastName": "Surname",
"ownerPhone": "555-123-4567",
"ownerAddress": { ... },
"ownerSSN": "111-22-3333",
"ownershipPct": 25
}
Field Size Type Required Comments ownerFirstName 100 string no The owner's first name. ownerLastName 100 string no The owner's last name. ownerPhone 12 string no The owner's phone number, formatted as ###-###-####. ownerAddress n/a object no The address object , containing the owner's address information. ownerSSN 11 string no The owner's Social Security Number, formatted as ###-##-####. ownershipPct 3 number
yes The percentage owned by the owner.
Example Address Object
{
"address1": "123 Fake Street",
"address2": "Suite 300",
"city": "Keystone",
"stateCd": "CO",
"zip": "80435",
"countryCd": "US"
}
Field Size Type Required Comments address1 200 string yes The number and street of the address. address2 200 string no Any additional address information such as apartment number or suite number of the address.
city 300 string yes The city of the address. stateCd 2 string no The state code that represents the US state where the address is located. zip 15 string yes The ZIP code of the address. countryCd 2 string no The country code that represents the country where the address is located.
Example Attachment Object
"attachment" : {
"fileName" : "VoidedCheck.pdf",
"mimeType" : "application/pdf",
"description" : "This is the voided check",
"attachmentTypeCd" : "VOIDBNKCHK1",
"document" : "JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg=="
}
Field Size Type Required Comments fileName 60 string yes The file name of the attachment. mimeType 30 string yes The MIME type of the attachment file.
description 1000 string yes The description of the attachment file. attachmentTypeCd n/a string yes The attachment type code that represents the type of attachment. document 100Mb string yes The document to upload, provided as a Base 64 encoded file.
Note: Attach only documents or image files. Audio and video files are not supported.
Example Bank Object
{
"bankAcctNum": "123456789",
"bankRoutingNum": "987654321",
"bankAcctTypeCd": "BIZ",
"bankName": "Bank of Gainesville"
}
Field Size Type Required Comments bankAcctNum 25 string yes The bank account number. bankRoutingNum 9 string yes The bank account's routing number. bankAcctTypeCd 10 string yes The bank account type code that represents the type of bank account. bankName 200 string yes The name of the bank that holds the account.
Example Bank Detail Object
"bankDetail": {
"depositBank": { ... },
"withdrawalBank": { ... }
}
Field Size Type Required Comments depositBank n/a object yes The bank object containing the account details used when depositing funds. withdrawalBank n/a object yes The bank object containing the account details used when withdrawing funds.
BlueChex Volume Definition The blueChexVolume object is required for merchants with the ACH from Fiserv add-on. All fields must be provided.
Example BlueChex Volume Object
"blueChexVolume" : {
"averagePerTransactionSalesAmount" : "250.00",
"maxPerTransactionSalesAmount" : "9999.00",
"averagePerTransactionCreditAmount" : "200.00",
"maxPerTransactionCreditAmount" : "9999.00",
"averagePerMonthSalesAmount" : "25000.00",
"maxPerMonthSalesAmount" : "50000.00",
"averagePerMonthCreditAmount" : "5000.00",
"maxPerMonthCreditAmount" : "10000.00"
}
Field Size Type Comments averagePerTransactionSalesAmount 18.2 number The average sales amount per ACH transaction. maxPerTransactionSalesAmount 18.2 number The maximum sales amount per ACH transaction. averagePerTransactionCreditAmount 18.2 number The average credit (refund) amount per ACH transaction. maxPerTransactionCreditAmount 18.2 number The maximum credit (refund) amount per ACH transaction. averagePerMonthSalesAmount 18.2 number The average monthly sales amount for all ACH transactions. maxPerMonthSalesAmount 18.2 number The maximum monthly sales amount for all ACH transactions. averagePerMonthCreditAmount 18.2 number The average monthly credit (refund) amount for all ACH transactions. maxPerMonthCreditAmount 18.2 number The maximum monthly credit (refund) amount for all ACH transactions.
BlueChex SEC Options Definition Example BlueChex SEC Options Object
"blueChexSecOptions": {
"telSecOptionFlg": false,
"ccdSecOptionFlg": false,
"webSecOptionFlg": false,
"ppdSecOptionFlg": true
}
Field Size Type
Required Comments telSecOptionFlg n/a
boolean See comments Telephone-Initiated Entry : A single entry debit application initiated by an originator pursuant to an oral authorization obtained over the telephone to effect a transfer of funds from an account of the receiver.
Note: At least one SEC Option required for applications that include the ACH from Fiserv add-on for manual signature.
ccdSecOptionFlg n/a boolean See comments Cash Concentration and Disbursement : A credit or debit application where funds are transferred between unrelated corporate entities or transmitted as intra-company concentrations and disbursement transactions. Serves as stand-alone funds transfer, or it can support a limited amount of payment-related data with the fund's transfer.
Note: At least one SEC Option required for applications that include the ACH from Fiserv add-on for manual signature.
webSecOptionFlg n/a boolean See comments Internet-Initiated Entry : Debit applications initiated by an originator pursuant to an authorization from the receiver via the internet to effect a transfer of funds from an account of the receiver.
Note: At least one SEC Option required for applications that include the ACH from Fiserv add-on for manual signature.
ppdSecOptionFlg n/a boolean See comments Prearranged Payment and Deposit : Both direct payments and direct deposits.
Note: At least one SEC Option required for applications that include the ACH from Fiserv add-on for manual signature.
Business Details Definition Example Business Details Object
"businessDetails": {
"customerBillPriorToShipFlg": false,
"depositReqForFulfillFlg": true,
"whenCustomerChargedCd": "INADVANCE",
"refundPolicyCd": "EXCHONLY",
"serviceProvidedInCd": "30LESS"
}
Field Size Type Required Comments customerBillPriorToShipFlg n/a boolean no True if the customer is billed prior to shipment. depositReqForFulfillFlg n/a boolean no True if deposit is required for order fulfillment. whenCustomerChargedCd 10 string no The when customer charged code that represents when the customer is charged. refundPolicyCd 10 string no The refund policy code that represents the customer's refund policy. serviceProvidedInCd 10 string no The service provided in code that represents the typical timeframe between purchase and delivery.
Clover Security and TransArmor Definition Example Clover Security and TransArmor Object
"cloverSecurityAndTransarmor": {
"transarmorDataProtectionFlg": true,
"transarmorTokenTypeCd": "MULTI",
"transarmorMultiPayToken": "A1B2",
"transarmorMonthyFee": 4.99,
"cloverSecurityBundleCd": null,
"cloverSecurityFee": null,
"cloverSecurityPlusFee": null,
"pciComplianceServiceFee": null,
"pciComplianceServiceFeeFrequency": null,
"pciComplianceServiceFeeMonthToBill": null
}
Field Size Type Required Comments
transarmorDataProtectionFlg n/a boolean no True if TransArmor Data protection is active.
Requires FALSE when cloverSecurityBundleCd = PCI.
transarmorTokenTypeCd n/a string See comments The TransArmor token type code that represents the token type. Required when transarmorDataProtectionFlg = TRUE. transarmorMultiPayToken 4 string See comments The TransArmor multi-pay token. Required when transarmorTokenTypeCd = MULTI. transarmorMonthyFee 7.2 number See comments The Monthly TransArmor Fee amount.
Required when transarmorDataProtectionFlg = TRUE.
cloverSecurityBundleCd n/a
string no Note: Only applicable for merchants with a Clover Security Bundle.
The Clover security bundle code that represents the applicable bundle.
cloverSecurityFee n/a number See comments Note: Only applicable for merchants with a Clover Security Bundle.
The Monthly Clover Security Fee amount.
Required when cloverSecurityBundleCd = TDPPCI.
cloverSecurityPlusFee n/a number See comments Note: Only applicable for merchants with a Clover Security Bundle.
The Monthly Clover Security Plus Fee amount.
Required when cloverSecurityBundleCd = CSPFB.
pciComplianceServiceFee n/a number See comments Note: Only applicable for merchants with a Clover Security Bundle.
The PCI Compliance Service Fee.
Required when cloverSecurityBundleCd = PCI.
pciComplianceServiceFeeFrequency 7 string See comments Note: Only applicable for merchants with a Clover Security Bundle.
The frequency to bill the PCI Compliance Service Fee. Can be either MONTHLY or ANNUAL.
Required when cloverSecurityBundleCd = PCI.
pciComplianceServiceFeeMonthToBill n/a string See comments Note: Only applicable for merchants with a Clover Security Bundle.
The month to bill the PCI Compliance Service Fee, starting with a capital letter.
Required when pciComplianceServiceFeeFrequency = ANNUAL.
Example Contact Info Object
{
"contactName": "Forename Surname",
"contactEmail": "name@email.com",
"contactPhone": "555-123-4567"
}
Field Size Type Required Comments contactName 300 string no The full name of the contact. contactEmail 300 string no The email address of the contact. contactPhone 12 string no The phone number of the contact, formatted as ###-###-####.
Example Custom Fields Object
"customFields": [
{
"userFieldNumber": 1,
"customFieldValue": "example custom field value 1"
},
{
"userFieldNumber": 2,
"customFieldValue": "example custom field value 2"
}
]
Field Size Type Required Comments userFieldNumber n/a number yes The index number of the custom field. Must be a number between 1-10. customFieldValue 100 string yes Required when the userFieldNumber is marked as required in the CoPilot web interface.
Delivery Percentages Definition Example Delivery Percentages Object
"deliveryPercentages": {
"dlvry0To7DaysPct": 97,
"dlvry8To14DaysPct": 1,
"dlvry15To30DaysPct": 1,
"dlvryOver30DaysPct": 1
}
Field Size Type Required Comments dlvry0To7DaysPct 3 number no The percentage of products or services delivered within 7 days of purchase, represented as a whole number. dlvry8To14DaysPct 3 number no The percentage of products or services delivered within 8-14 days of purchase, represented as a whole number. dlvry15To30DaysPct 3 number no The percentage of products or services delivered within 15-30 days of purchase, represented as a whole number. dlvryOver30DaysPct 3 number no The percentage of products or services delivered more than 30 days after purchase, represented as a whole number.
Example Demographic Object
"demographic": {
"businessIncorporatedStateCd": "CO",
"merchantTimeZone": "MT",
"websiteAddress": "www.example.com",
"businessPhone": "555-123-4567",
"businessFax": "555-987-6543",
"businessAddress": { ... },
"mailingAddress": { ... }
}
Field Size Type Required Comments businessIncorporatedStateCd 2 string no The state code where the business is incorporated. merchantTimeZone 3 string yes The 2 or 3 character time zone, such as ET, CT, MT, PT or HST. websiteAddress 200 string yes Business website is required if merchant.processing.modeOfTransaction.eCommercePct is greater than 0. businessPhone 12 string no The business phone number, formatted as ###-###-####. businessFax 12 string no The business fax number, formatted as ###-###-####. businessAddress n/a object yes The address object , containing the business address. mailingAddress n/a object yes The address object , containing the business mailing address.
Example Equipment Object
{
"equipmentId": 123,
"equipmentName": "Generic Card Swiper",
"description": "Equipment Description",
"make": "Acme",
"model": "200X",
"imageUrl": "https://copilot.cardconnect.com/copilot/logos/equipment/123456.png",
"sku": 09103215704,
"platformCd": null,
"equipmentTypeCd": "TERMINAL",
"equipmentSupplierCd": "CARDCONNECT",
"defaultPrice": 199,
"defaultPlanPrice": 25,
"allowCustomBillingFlg": 1,
"standardShippingPrice": 20,
"expeditedShippingPrice": 25
}
Field Size Type Comments equipmentId 60 number The unique identifier for this piece of equipment. equipmentName 60 string The name for this piece of equipment. description 60 string The description for this piece of equipment. make 60 string The manufacturer for this piece of equipment. model 60 string The model name for this piece of equipment. imageUrl 60 string The URL for the image representing this piece of equipment. sku 60 string The SKU for this piece of equipment.
platformCd 60 string The platform for this piece of equipment. equipmentTypeCd 60 string The equipment type code representing the type or category of this piece of equipment. equipmentSupplierCd 60 string The equipment supplier code representing the provider of this piece of equipment. defaultPrice 60 string The default one-time price. defaultPlanPrice 60 string The default monthly price, if allowed. allowCustomBillingFlg 60 string True if monthly billing is allowed. standardShippingPrice 60 string The standard shipping price per unit. expeditedShippingPrice 60 string The expedited shipping price per unit.
Example Fees Object
"fees": {
"achBatchFee": 1.11,
"addressVerifFee": 2.22,
"annualMembershipFee": 3.33,
"appFee": 4.44,
"authFee": 5.55,
"chargebackFee": 6.66,
"ddaRejectFee": 9.99,
"earlyCancelFee": 99.99,
"minProcessFee": 20.00,
"monthlyEquipmentRentalFee": 10.00,
"pciProgramCd": "ANNUAL",
"pciAnnualFee": 119.00,
"pciNonComplianceFee": 29.95,
"regProdMonthlyFee": 200.00,
"retrievalFee": 10.00,
"statementFee": 27.99,
"transactionFee": 0.05,
"voiceAuthFee": 0.10,
"wirelessActivationFee": 0.10,
"wirelessFee": 50.00,
"duesAndAssessmentsFlg": true,
"passthruInterchgCostsFlg": true
}
Field Size Type Required Comments achBatchFee 7.3 number yes The ACH Batch Fee. addressVerifFee 7.3 number yes The Address Verification Fee (AVS). annualMembershipFee 8.2 number yes The Annual Membership Fee. appFee 8.2 number yes The Application Fee (One Time). authFee 7.3 number yes The Authorization Fees (All Card Types). chargebackFee 8.2 number yes The Chargeback Fee (Per Item). ddaRejectFee 8.2 number yes The DDA Rejects (Per Item). earlyCancelFee 8.2 number yes The Early Termination Fee. minProcessFee 8.2 number yes The Minimum Processing Fee (Monthly). monthlyEquipmentRentalFee 8.2 number no The Equipment Rental Fee (Monthly). pciAnnualFee 8.2 number no The PCI Annual Fee, applicable when pciProgramCd
is ANNUAL
. pciConciergeMonthlyFee 8.2 number see comments The PCI Concierge Monthly Fee.
Required to submit merchants when pciProgramCd
is CONCIERGE
.
pciNonComplianceFee 8.2 number no The PCI Non-Compliance Fee (Monthly), applicable when pciProgramCd
is ANNUAL
. pciProgramCd 10 string yes The PCI Program Code that identifies the merchant's PCI Program. regProdMonthlyFee 8.2 number yes The Regulatory Product Fee (Monthly). retrievalFee 8.2 number yes The Retrieval Fee (Per Item). statementFee 8.2 number yes The Statement Fee (Monthly). transactionFee 7.3 number yes The Transaction Fees (All Card Types). voiceAuthFee 7.3 number yes The Voice Authorization Fee. wirelessActivationFee 8.2 number yes The Wireless Activation Fee (One Time). wirelessFee 8.2 number yes The Wireless Fee (Monthly). duesAndAssessmentsFlg n/a boolean no True if Dues & Assessments is enabled. passthruInterchgCostsFlg n/a boolean no Returned only for accounts created prior to the introduction of the interchangeTypeCode
field in the 5/5/20 update. True when the account using the IC Plus Pricing model.
Example Flat Pricing Object
"flatPricing": {
"amex": {
"esaQualDiscountPct": 22.00,
"optBlueQualDiscountPct": 11.00
},
"discover": {
"qualCreditDiscountPct": 1.00
},
"mastercard": {
"qualCreditDiscountPct": 5.00
},
"visa": {
"qualCreditDiscountPct": 4.00
}
}
Field Size Type Required Comments amex.esaQualDiscountPct 7.3 number See comments The percentage used to calculate the Amex ESA Qualified Credit Discount Fees. Required when amexProgramAssetCd = ESA. amex.optBlueQualDiscountPct 7.3 number See comments
The percentage used to calculate the Amex OptBlue Qualified Credit Discount Fees. Required when amexProgramAssetCd = OPTBLUE. discover.qualCreditDiscountPct 7.3 number See comments
The percentage used to calculate the Discover Qualified Credit Discount Fees. Required when Discover entitlement is enabled.. mastercard.qualCreditDiscountPct 7.3 number yes The percentage used to calculate the Mastercard Qualified Credit Discount Fees. visa.qualCreditDiscountPct 7.3 number yes The percentage used to calculate the Visa Qualified Credit Discount Fees.
Example Hierarchy Definition
"hierarchy": {
"corpLevel": "000000000001",
"chainLevel": "000000000002",
"sponsorBankCd": "WELLS"
}
Field Size Type Required Comments corpLevel 12 string no The Corporate Chain used to associate merchant accounts. chainLevel 12 string no The Chain Level used to link merchant accounts for reporting, statement, or financial rollup. sponsorBankCd 5 string no The Sponsor Bank code for merchant accounts using the FD North backend. Enter WELLS for Wells Fargo or BBVA for BBVA.
IC-Plus Pricing Definition Example IC-Plus Pricing Object
"icPlusPricing": {
"interchangeTypeCode": "GROSS",
"amex": {
"optBlueQualDiscountPct": 8.00
},
"discover": {
"qualCreditDiscountPct": 1.00
},
"mastercard": {
"qualCreditDiscountPct": 5.00
},
"visa": {
"qualCreditDiscountPct": 4.00
}
}
Field Size Type Required Comments interchangeTypeCode 5 string no The interchange type code that represents the Passthrough Interchange Costs calculation used. amex.optBlueQualDiscountPct 7.3 number See comments The percentage used to calculate the Amex OptBlue Qualified Credit Discount Fees. Required when amexProgramAssetCd = OPTBLUE. discover.qualCreditDiscountPct 7.3 number See comments
The percentage used to calculate the Discover Qualified Credit Discount Fees. Required when Discover entitlement is enabled. mastercard.qualCreditDiscountPct 7.3 number yes The percentage used to calculate the Mastercard Qualified Credit Discount Fees. visa.qualCreditDiscountPct 7.3 number yes The percentage used to calculate the Visa Qualified Credit Discount Fees.
Example Merchant Object
"merchant": {
"salesCode": "API1",
"akaBusinessName": "The Card Shoppe",
"dbaName": "The Card Shoppe",
"legalBusinessName": "The Card Shoppe LLC",
"taxFilingName": "The Card Shoppe LLC",
"taxFilingMethod" : "EIN",
"businessStartDate": "09/17/1949",
"businessIdTypeCd": "ARTICLE",
"custPrimaryAcctFlg": false,
"webLeadFlg": true,
"hierarchy": { ... },
"demographic": { ... },
"ownership": { ... },
"bankDetail": { ... },
"merchantContactInfo": { ... },
"processing": { ... }
"pricing": { ... },
"fees": { ... },
"cloverSecurityAndTransarmor": { ... },
"customFields": [ ... ]
}
Field Size Type Required Comments
salesCode 25 string yes The Sales Code created within the CoPilot web interface that is applicable for this merchant account.
akaBusinessName 200 string no The 'Also Known As' business name, such as an informal or shorthand moniker of the legal or DBA name.
dbaName 100 string yes The 'Doing Business As' name, sometimes referred to as the 'Fictitious Business Name' or 'Assumed Business Name' that is legally registered.
legalBusinessName 500 string yes The full legal name of the registered business.
taxFilingName 500 string yes The business name used in tax filing. Include only the following special characters: &, -
taxFilingMethod 3 string yes The method used to identify the business for tax filing. Can be either EIN or SSN. Only the SSN method is possible when merchant.ownership.ownershipType is INDIVSOLE.
businessStartDate 8 string no The business inception date, formatted as MM/DD/YYYY.
businessIdTypeCd 7 string no The business identification type code, used to verify the business. Can be either ARTICLE or GOVT.
custPrimaryAcctFlg n/a boolean no True when the account is considered the primary account among linked MIDs.
webLeadFlg n/a boolean no True when this merchant account is created as the result of an unsolicited merchant inquiry using a hosted web form or a similar lead generation strategy.
hierarchy n/a object no The hierarchy object , containing custom hierarchy information for this merchant.
demographic n/a object yes The demographic object , containing business information.
ownership n/a object yes The ownership object , containing ownership information for this merchant account.
bankDetail n/a object yes The bank detail object , containing the depositBank and withdrawalBank objects.
merchantContactInfo n/a object no The contact info object , containing contact information for this merchant account.
processing n/a object no The processing object , containing various data and options necessary for payment processing.
pricing n/a object no The pricing object , containing the pricing structure used for this merchant account.
fees n/a object no The fees object , containing the fee structure used for this merchant account.
cloverSecurityAndTransarmor n/a object no
The Clover security and TransArmor object , containing applicable Clover Security Bundle information and TransArmor Data Protection settings.
customFields 10 array yes The custom fields array , containing an object for each custom field object. Required when one or more custom fields have been configured in the CoPilot web interface as a required field for new merchants.
Mode of Transaction Definition Example Mode of Transaction Details Object
"modeOfTransaction": {
"eCommercePct": 0,
"keyedPct": 20,
"mailOrderPct": 30,
"swipedPct": 50
}
Field Size Type Required Comments eCommercePct 3 number yes The percentage of card-not-present transactions accepted via eCommerce solutions, represented as a whole number. keyedPct 3 number yes The percentage of card-not-present transactions entered manually using a hardware terminal keypad or the Virtual Terminal, represented as a whole number. mailOrderPct 3 number yes The percentage of card-not-present transactions accepted via a call center, represented as a whole number. swipedPct 3 number yes The percentage of card-present transactions accepted via hardware terminals, represented as a whole number.
Order Definition (Response) Example Order Object
"order": {
"orderId": 1111111,
"merchantId": 12345678,
"equipmentId": 35,
"orderNotes": "Test order notes",
"quantity": 1,
"unitPrice": 100,
"monthlyPrice": null,
"billToCd": "CUST",
"billingFrequencyCd": "ONETIME",
"profileId": "12344565676",
"acctId": 1
"shippingDetails": { ... }
"orderStatusCd": "PLACED",
"placedDatetime": "01/01/2018 00:00:01 PM",
"shippedDatetime": null,
"canceledDatetime": null,
"fulfillingDatetime": null
}
Field Size Type Required Comments orderId 19 number no The unique ID used to identify this order. This value is only returned via a GET request, and cannot be set. merchantId 19 number yes The merchant ID associated with this order. equipmentId 19 number yes The equipment ID of the equipment ordered. orderNotes 1000 string no Optional notes for the person fulfilling the order. quantity 4 number yes The number of devices ordered. unitPrice 10 number yes (when billToFrequencyCd is ONETIME) The price per unit. monthlyPrice 10 number yes (if billToFrequencyCd is MONTHLY) The price per month. billToCd 100 string yes The bill to code that represents who is billed for the order. billingFrequencyCd 100 string yes The billing frequency code that represents the frequency of billing. profileId n/a string yes (if billToCd is PARTNERCC) The CardPointe Gateway profile ID charged for this order. acctId 10 number yes (if billToCd is PARTNERCC) The account ID of the card within the CardPointe Gateway profile charged for this order. shippingDetails n/a object yes The shipping details object . orderStatusCd n/a string no The order status code that represents the current status of the order. placedDatetime n/a string no The date and time the order was placed. The date and time is reported in local time, based on the timezone selected in the CoPilot web interface. shippedDatetime n/a string no The date and time the order was shipped. The date and time is reported in local time, based on the timezone selected in the CoPilot web interface. canceledDatetime n/a string no The date and time the order was canceled. The date and time is reported in local time, based on the timezone selected in the CoPilot web interface. fulfillingDatetime n/a string no The date and time the order was fulfilled. The date and time is reported in local time, based on the timezone selected in the CoPilot web interface.
Example Owner Object
"owner": {
"ownerAddress": { ... },
"ownerEmail": "name@email.com",
"ownerName": "Forename Surname",
"ownerDob": "09/04/1929",
"ownerPhone": "555-123-4567",
"ownerMobilePhone": "555-987-6543",
"ownerSSN": "111-22-3333",
"ownerTitle": "CEO"
}
Field Size Type Required Comments ownerAddress n/a string yes The address object , containing the owner's address information. ownerEmail 300 string yes The email address of the owner. ownerName 300 string yes The first and last name of the owner.
Note: Do no include title, middle name, or suffix. First name must contain only characters. Last name must not contain more than 1 hyphen or 1 apostrophe.
ownerDob 8 string no The date of birth of the owner, formatted as MM/DD/YYYY. ownerPhone 12 string yes The phone number of the owner, formatted as ###-###-####. ownerMobilePhone 12 string yes The mobile phone number of the owner, formatted as ###-###-####. ownerSSN 11 string yes The Social Security Number of the owner, formatted as ###-##-####. ownerTitle 200 string yes One of the Valid Owner Titles listed below.
Valid Owner Titles
Ownership Type Valid Owner Titles PRTNRSHP (Partnership) 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 Site User Definition Example Owner Site User Object
"ownerSiteUser": {
"firstName": "Forename",
"lastName": "Surname",
"email": "name@email.com"
}
Field Size Type Required Comments firstName 300 string yes The first name of the CardPointe user. lastName 300 string yes The last name of the CardPointe user. email 300 string yes The email address used to create the CardPointe User.
Example Ownership Object
"ownership": {
"owner": { ... },
"additionalOwners": [ ... ]
"ownershipTypeCd": "PUBCORP",
"publiclyTradedFlag": "true",
"stockSymbol": "SPY",
"driversLicenseNumber": "123456789",
"driversLicenseStateCd": "CO",
"ownerOwnershipPct": 100
}
Field Size Type Required Comments owner n/a object yes The owner object , containing information about the owner. additionalOwners n/a array
no An array of additional owner objects containing one object for each additional owner. ownershipTypeCd 10 string no The ownership type code that represents the business entity. publiclyTradedFlag n/a boolean no True when the business offers public stock on the NYSE or NASDAQ stock exchanges. stockSymbol 10 string no The NYSE or NASDAQ stock symbol of the business. driversLicenseNumber 100 string yes The primary owner's state issued driver's license number. driversLicenseStateCd 2 string yes The state code that represents the state who issued the driver's license. ownerOwnershipPct 3 number no The percentage of ownership held by the primary owner.
Platform Details Definition Example Platform Details Object for Merchant Services account
"platformDetails": {
"amexProgramAssetCd": "OPTBLUE",
"amexProgramMid": "2341251235434",
"discoverMid": "601153746288719",
"discoverProgramCd": "MAP",
"incrementalAuthorizationFlg": false,
"debtRepaymentProgramFlg": false,
"acquiringFlg": true,
"taxId": "485968574",
"tid": "96859685",
"busnsId": "234444234234",
"busnsIdPlaceOfIssue": "CO",
"currencyCode": "USD",
"mccId": "3076",
"businessDescription": "Business Description",
"iataCode": "12345678",
"quasiCashFlg": false
}
Example Platform Details Object for CardPointe Only account
"platformDetails": {
"backEndMid": "418493849598",
"frontEndMid": "418493849598",
"processorReportingMid": "418493849598",
"backEndPlatform": "FDNOB",
"frontEndPlatformCd": "FDNOF",
"amexProgramAssetCd": "OPTBLUE",
"amexProgramMid": "2341251235434",
"discoverMid": "601153746288719",
"discoverProgramCd": "MAP",
"incrementalAuthorizationFlg": false,
"debtRepaymentProgramFlg": false,
"acquiringFlg": false,
"taxId": "485968574",
"tid": "96859685",
"busnsId": "234444234234",
"busnsIdPlaceOfIssue": "CO",
"currencyCode": "USD",
"mccId": "3076",
"businessDescription": "Business Description",
"iataCode": "12345678",
"quasiCashFlg": false
}
Field Size Type Required Comments backEndMid 25 string See comments The settlement processor merchant ID. Required for CardPointe-only accounts. frontEndMid 25 string See comments The authorization processor merchant ID. Required for CardPointe-only accounts. processorReportingMid 25 string See comments The processor merchant ID used for reporting. Required for CardPointe-only accounts. backEndPlatformCd 20 string See comments The back end platform code that represents the settlement processor. Required for CardPointe-only accounts. frontEndPlatformCd 20 string See comments The front end platform code that represents the authorization processor. Required for CardPointe-only accounts. amexProgramAssetCd 7 string See comments The Amex program asset code that represents the American Express program used. Required when Amex entitlement is enabled. amexProgramMid 25 string See comments The Amex merchant ID used to process American Express transactions. Required when amexProgramAssetCd = ESA. discoverMid 25 string See comments
The Discover merchant ID used to process Discover transactions. Required when discoverProgramCd = EASI. discoverProgramCd 10 string See comments
The Discover program code that represents the Discover program used. Required when Discover entitlement is enabled. incrementalAuthorizationFlg n/a boolean no True when the account operates within the travel and entertainment industries and requires multiple incremental authorizations.
Note: Requires Discover entitlement and compatible MCC.
debtRepaymentProgramFlg n/a boolean no True when the account accepts payments to satisfy a loan, mortgage, or other debt.
Note: Requires Discover MAP entitlement and compatible MCC.
acquiringFlg n/a boolean yes True when the account is a Merchant Services account. False when the account is a CardPointe-only account. taxId 9 string
no The merchant's Social Security Number or Employer Identification Number. tid 30 string no busnsId 18 string no The merchant's government-issued business license number. busnsIdPlaceOfIssue 2 string yes The state code that represents the state who issued the business license. currencyCode 5 string no The currency code that represents the local currency where the business is located. mccId 5 string yes The Merchant Category Code (MCC) that represents the business industry. businessDescription 4000 string yes The description of the business. iataCode 8 string no The International Air Transportation Association (IATA) code for the business.
quasiCashFlg n/a
boolean no True for accounts that accept Quasi Cash transactions.
Example Flat Pricing Object
{
"flatPricing": { ... }
}
Field Size Type Required Comments flatPricing n/a object
yes The flat pricing object containing the pricing structure.
Example IC-Plus Pricing Object
{
"icPlusPricing": { ... }
}
Field Size Type Required Comments icPlusPricing n/a object yes The IC-Plus pricing object containing the containing the pricing structure.
Example Processing Object
{
"platformDetails": { ...},
"businessDetails": { ... },
"volumeDetails": { ... },
"deliveryPercentages": { ... },
"modeOfTransaction": { ... },
"blueChexVolume": { ... },
"blueChexSecOptions": { ... }
}
Field Size Type Required Comments platformDetails n/a object yes The platform details object containing platform processing information. businessDetails n/a object yes The business details object containing business policy information. volumeDetails n/a object yes The volume details object containing transaction volume information. deliveryPercentages n/a object no The delivery percentages object containing days until delivery information. modeOfTransaction n/a object no The mode of transaction object containing transaction mode information. blueChexVolume n/a object See comments The BlueChex volume object containing ACH transaction volume data. Required for applications that include the ACH from Fiserv add-on and a digital signature. blueChexSecOptions n/a object See comments The BlueChex SEC Options object containing SEC Option Flags. At least one SEC Option required for applications that include the ACH from Fiserv add-on for manual signature.
Shipping Details Definition Example Shipping Details Object
"shippingDetails": {
"shippingAddress": {
"address1": "123 Fake Street",
"address2": "Suite 300",
"city": "Keystone",
"stateCd": "CO",
"zip": "80435",
"countryCd": "US"
},
"shipToAttn": "Forename Surname",
"shipToAttnEmail": "name@email.com",
"shippingMethodCd": "STANDARD",
"shippingBillToCd": "PARTNER",
"shippingCarrierCd": "FEDEX",
"trackingNumber": "12345abc",
"shippingCost": 10.50,
"merchantContactPhone": "555-123-4567",
"merchantContactPhoneExt": "55555",
"poNumber": "4455"
}
Field Size Type Required Comments shippingAddress n/a object yes The address object containing the shipping address. shipToAttn 100 string yes The name of the person receiving the order. shipToAttnEmail 100 string yes The email address of the person receiving the order. shippingMethodCd 100 string yes The shipping method code that represents the shipping method used. shippingBillToCd 100 string See comments The bill to code that represents who is billed for the shipping charges. Only required if shippingMethodCd = EXPEDITED. shippingCarrierCd 100 string no The shipping carrier code that represents the shipping provider used. trackingNumber 100 string no The tracking number of the shipment. shippingCost n/a number no The shipping cost. merchantContactPhone 12 string yes The merchant phone number, formatted as ###-###-####. merchantContactPhoneExt 5 string no The merchant phone number extension. poNumber 30 string no The purchase order number.
Swipe/Non-Swipe Pricing Definition Example Swipe/Non-Swipe Pricing Object
"swipeNonSwipePricing": {
"swipedDiscountPct": 3.33,
"swipedTransactionFee": 4.44,
"nonSwipedDiscountPct": 5.55,
"nonSwipedTransactionFee": 6.667
}
Field Size Type Required Comments swipedDiscountPct number yes The percentage used to calculate the Credit Discount Fees for Visa, Mastercard, Discover Full Service, PIN Debit, PINless Debit, Star Access, and Amex OptBlue transactions when card data is captured from MSR (swiped) or EMV (dipped). Sales volume only. swipedTransactionFee number yes The transaction fee applied for Visa, Mastercard, Discover Full Service, Star Access, and Amex OptBlue transactions when card data is captured from MSR (swiped) or EMV (dipped). Sales count only. nonSwipedDiscountPct number yes The percentage used to calculate the Credit Discount Fees for Visa, Mastercard, Discover Full Service, Star Access, and Amex OptBlue transactions when card data is entered manually. Sales volume only. nonSwipedTransactionFee number yes The transaction fee applied for Visa, Mastercard, Discover Full Service, Star Access, and Amex OptBlue transactions when card data is entered manually. Sales count only.
Volume Details Definition Third Party Provider Details Definition Example Volume Details Object
"volumeDetails": {
"averageMonthlyVolume": 9999.00,
"highTicketAmount": 99.99,
"averageTicketAmount": 9.99
}
Example Third Party Provider Details Object
"thirdPartyProviderDetails": {
"thirdPartyProviderFlg": true,
"thirdPartyProviderCd": "04",
"thirdPartyProviderOtherName": null,
"thirdPartyProviderEmail": "test2@email.com",
"thirdPartyProviderPhone": "6108675309"
}
Field Size Type Required Comments averageMonthlyVolume 18.2 decimal yes The average monthly volume of transactions for this merchant. highTicketAmount 18.2 decimal yes The most expensive transaction total expected for this merchant. averageTicketAmount 18.2 decimal yes The average transaction total per sale for this merchant.
Field Size Type Comments thirdPartyProviderFlg Boolean A true/false indicator which determines whether the merchant uses a third party provider to store, process, or transmit cardholder data.
If true , thirdPartyProviderCd
, thirdPartyProviderEmail
, and thirdPartyProviderPhone
are required .
If false , all other fields can be null
.
thirdPartyProviderCd String A 2-character code representing the TPP.
If thirdPartyProviderFlg
is true , this field is required and must be one of the following values:
01 - Yahoo 02 - Authorize.net 03 - Cybersource 04 - VeriFone 05 - Merchant Link 06 - Shift 4 07 - Apriva 08 - FIS 09 - Six Payment Services Corp 10 - Verisign 99 - Other
If 99 , the thirdPartyProviderOtherName
field is required .
thirdPartyProviderOtherName String The TPP name if thirdPartyProviderCd
is 99 .
Must be null or omitted if thirdPartyProviderCd
is any other value.
This field must not contain the a name from the thirdPartyProviderCd
list (for example, "Yahoo").
thirdPartyProviderEmail String The contact email address for the TPP.
Must be a less than or equal to 32 characters.
thirdPartyProviderPhone String The contact phone number for the TPP.
Must be 7-12 characters.
Amex Program Asset Codes Response Object
{
"amexProgramAssetCodes": [
{
"code": "OPTBLUE",
"name": "American Express(AMEX) OptBlue"
},
{
"code": "ESA",
"name": "American Express(AMEX) ESA"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/amexProgramAssetCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Attachment Types Response Object
{
"attachmentTypeCodes": [
{
"code": "501C",
"name": "501C Form"
},
{
"code": "ACCTUPDTR",
"name": "Account Updater Addendum"
},
{
"code": "ACCTUPDTRINTAKE",
"name": "Account Updater - Intake Form"
},
{
"code": "ACCTUPDTRMC",
"name": "Account Updater - MasterCard Update Form"
},
{
"code": "ACCTUPDTRVISA",
"name": "Account Updater - VISA Update Form"
},
{
"code": "ACCTUPDTRAGG",
"name": "Account Updater Aggregator Addendum"
},
{
"code": "ACHFEESCHD",
"name": "ACH - Fee Schedule"
},
{
"code": "ACHLST3BNK",
"name": "ACH - Last 3 Bank Statements"
},
{
"code": "ACHPROCSRV",
"name": "ACH - Processing Services Agreement"
},
{
"code": "ACHPROFITSTR",
"name": "ACH - ProfitStars Application"
},
{
"code": "ACKACCEPTAGRMT",
"name": "Acknowledgement of Acceptance of Agreement"
},
{
"code": "APPLIC",
"name": "Application form"
},
{
"code": "BPACHPROCESSING",
"name": "Blue Chex ACH Processing"
},
{
"code": "BOARDING",
"name": "Boarding Form"
},
{
"code": "CANCELREQ",
"name": "Cancel Request"
},
{
"code": "CLIQUEAGREEMENT",
"name": "Clique Agreement"
},
{
"code": "CLOVER",
"name": "Clover Addendum"
},
{
"code": "CLOVERGO",
"name": "CloverGo Addendum"
},
{
"code": "DISCARD",
"name": "Discard"
},
{
"code": "EQUIPMENTRENTAL",
"name": "Equipment Rental"
},
{
"code": "GEP",
"name": "GEP Addendum"
},
{
"code": "FIN",
"name": "Merchant Financials"
},
{
"code": "OTHER",
"name": "Other"
},
{
"code": "SIGNEDAPP",
"name": "Signed Application"
},
{
"code": "SIGNEDCONFIRMATION",
"name": "Signed Confirmation Page"
},
{
"code": "STMTS",
"name": "Statements"
},
{
"code": "TELECHECK",
"name": "Telecheck Addendum"
},
{
"code": "VOIDBNKCHK1",
"name": "Bank 1 Voided Check"
},
{
"code": "VOIDBNKCHK2",
"name": "Bank 2 Voided Check"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/attachmentTypeCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Back End Platform Codes Response Object
{
"backEndPlatformCodes": [
{
"code": "AMEX",
"name": "American Express Pltfrm"
},
{
"code": "PSTR",
"name": "ProfitStars Pltfrm"
},
{
"code": "MNRS",
"name": "Moneris Pltfrm"
},
{
"code": "PEXP",
"name": "Payment Express Pltfrm"
},
{
"code": "WLDP",
"name": "Worldpay Pltfrm"
},
{
"code": "PPAL",
"name": "PayPal Pltfrm"
},
{
"code": "TSYSB",
"name": "TSYS - BE Pltfrm"
},
{
"code": "SVS",
"name": "Stored Value Solutions Pltfrm"
},
{
"code": "CPSAB",
"name": "CP Salem - BE Pltfrm"
},
{
"code": "VNTV",
"name": "Vantiv Pltfrm"
},
{
"code": "FDSOB",
"name": "FD South - BE Pltfrm"
},
{
"code": "FDMEB",
"name": "FE Memphis - BE Pltfrm"
},
{
"code": "LITL",
"name": "Litle Pltfrm"
},
{
"code": "FDNOB",
"name": "FD North - BE Pltfrm"
},
{
"code": "FDOMB",
"name": "FD Omaha - BE Pltfrm"
},
{
"code": "CRDX",
"name": "Credorax Pltfrm"
},
{
"code": "CPTAB",
"name": "CP Tampa - BE Pltfrm"
},
{
"code": "GBLP",
"name": "Global Payment Pltfrm"
},
{
"code": "ELVN",
"name": "Elavon Pltfrm"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/backEndPlatformCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Bank Account Types Response Object
{
"bankAcctTypes": [
{
"code": "BIZ",
"name": "Business Checking"
},
{
"code": "GL",
"name": "General Ledger"
},
{
"code": "SAVINGS",
"name": "Savings"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/bankAcctTypes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Bill To Codes Response Object
{
"billToCodes": [
{
"code": "PARTNER",
"name": "Partner Residuals"
},
{
"code": "PARTNERCC",
"name": "Partner Credit Card"
},
{
"code": "CUST",
"name": "Customer"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/billToCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Bill To Detail Codes Response Object
{
"billToDetailCodes": [
{
"code": "CC",
"name": "CardConnect"
},
{
"code": "INTSALE",
"name": "Internal Sale"
},
{
"code": "SWAP",
"name": "Swap"
},
{
"code": "NEXTECH",
"name": "NexTech"
},
{
"code": "PO",
"name": "Purchase Order"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/billToDetailCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Billing Frequency Codes Response Object
{
"billingFequencyCodes": [
{
"code": "ONETIME",
"name": "One Time"
},
{
"code": "MONTHLY",
"name": "Monthly"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/billingFrequencyCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Clover Security Bundle Codes Clover Security Bundle Codes Response Object
{
"cloverSecurityBundleCodes": [
{
"code": "CSPFB",
"name": "Clover Security Plus - Full Bundle (01)"
},
{
"code": "PCI",
"name": "PCI Compliance Tool Only (04)"
},
{
"code": "OPTOUT",
"name": "Opt Out (09)"
},
{
"code": "TDP",
"name": "TransArmor Data Protection (13)"
},
{
"code": "TDPPCI",
"name": "Clover Security-TransArmor Data Protection + PCI Compliance Tool (21)"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/cloverSecurityBundleCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Country Codes Response Object
{
"countryCodes": [
{
"code": "US",
"name": "United States of America"
},
{
"code": "AF",
"name": "Afghanistan"
},
{
"code": "AL",
"name": "Albania"
},
{
"code": "DZ",
"name": "Algeria"
},
{
"code": "AS",
"name": "American Samoa"
},
{
"code": "AD",
"name": "Andorra"
},
{
"code": "AO",
"name": "Angola"
},
{
"code": "AI",
"name": "Anguilla"
},
{
"code": "AQ",
"name": "Antarctica"
},
{
"code": "AG",
"name": "Antigua and Barbuda"
},
{
"code": "AR",
"name": "Argentina"
},
{
"code": "AM",
"name": "Armenia"
},
{
"code": "AW",
"name": "Aruba"
},
{
"code": "AU",
"name": "Australia"
},
{
"code": "AT",
"name": "Austria"
},
{
"code": "AZ",
"name": "Azerbaijan"
},
{
"code": "BS",
"name": "Bahamas"
},
{
"code": "BH",
"name": "Bahrain"
},
{
"code": "BD",
"name": "Bangladesh"
},
{
"code": "BB",
"name": "Barbados"
},
{
"code": "BY",
"name": "Belarus"
},
{
"code": "BE",
"name": "Belgium"
},
{
"code": "BZ",
"name": "Belize"
},
{
"code": "BJ",
"name": "Benin"
},
{
"code": "BM",
"name": "Bermuda"
},
{
"code": "BT",
"name": "Bhutan"
},
{
"code": "BO",
"name": "Bolivia"
},
{
"code": "BQ",
"name": "Bonaire"
},
{
"code": "BA",
"name": "Bosnia and Herzegovina"
},
{
"code": "BW",
"name": "Botswana"
},
{
"code": "BV",
"name": "Bouvet Island"
},
{
"code": "BR",
"name": "Brazil"
},
{
"code": "IO",
"name": "British Indian Ocean Territory"
},
{
"code": "BN",
"name": "Brunei Darussalam"
},
{
"code": "BG",
"name": "Bulgaria"
},
{
"code": "BF",
"name": "Burkina Faso"
},
{
"code": "BI",
"name": "Burundi"
},
{
"code": "CV",
"name": "Cabo Verde"
},
{
"code": "KH",
"name": "Cambodia"
},
{
"code": "CM",
"name": "Cameroon"
},
{
"code": "CA",
"name": "Canada"
},
{
"code": "KY",
"name": "Cayman Islands"
},
{
"code": "CF",
"name": "Central African Republic"
},
{
"code": "TD",
"name": "Chad"
},
{
"code": "CL",
"name": "Chile"
},
{
"code": "CN",
"name": "China"
},
{
"code": "CX",
"name": "Christmas Island"
},
{
"code": "CC",
"name": "Cocos Islands"
},
{
"code": "CO",
"name": "Colombia"
},
{
"code": "KM",
"name": "Comoros"
},
{
"code": "CD",
"name": "Congo"
},
{
"code": "CG",
"name": "Congo"
},
{
"code": "CK",
"name": "Cook Islands"
},
{
"code": "CR",
"name": "Costa Rica"
},
{
"code": "HR",
"name": "Croatia"
},
{
"code": "CU",
"name": "Cuba"
},
{
"code": "CW",
"name": "Curaçao"
},
{
"code": "CY",
"name": "Cyprus"
},
{
"code": "CZ",
"name": "Czech Republic"
},
{
"code": "CI",
"name": "Côte d'Ivoire"
},
{
"code": "DK",
"name": "Denmark"
},
{
"code": "DJ",
"name": "Djibouti"
},
{
"code": "DM",
"name": "Dominica"
},
{
"code": "DO",
"name": "Dominican Republic"
},
{
"code": "EC",
"name": "Ecuador"
},
{
"code": "EG",
"name": "Egypt"
},
{
"code": "SV",
"name": "El Salvador"
},
{
"code": "GQ",
"name": "Equatorial Guinea"
},
{
"code": "ER",
"name": "Eritrea"
},
{
"code": "EE",
"name": "Estonia"
},
{
"code": "ET",
"name": "Ethiopia"
},
{
"code": "FK",
"name": "Falkland Islands"
},
{
"code": "FO",
"name": "Faroe Islands"
},
{
"code": "FJ",
"name": "Fiji"
},
{
"code": "FI",
"name": "Finland"
},
{
"code": "FR",
"name": "France"
},
{
"code": "GF",
"name": "French Guiana"
},
{
"code": "PF",
"name": "French Polynesia"
},
{
"code": "TF",
"name": "French Southern Territories"
},
{
"code": "GA",
"name": "Gabon"
},
{
"code": "GM",
"name": "Gambia"
},
{
"code": "GE",
"name": "Georgia"
},
{
"code": "DE",
"name": "Germany"
},
{
"code": "GH",
"name": "Ghana"
},
{
"code": "GI",
"name": "Gibraltar"
},
{
"code": "GR",
"name": "Greece"
},
{
"code": "GL",
"name": "Greenland"
},
{
"code": "GD",
"name": "Grenada"
},
{
"code": "GP",
"name": "Guadeloupe"
},
{
"code": "GU",
"name": "Guam"
},
{
"code": "GT",
"name": "Guatemala"
},
{
"code": "GG",
"name": "Guernsey"
},
{
"code": "GN",
"name": "Guinea"
},
{
"code": "GW",
"name": "Guinea-Bissau"
},
{
"code": "GY",
"name": "Guyana"
},
{
"code": "HT",
"name": "Haiti"
},
{
"code": "HM",
"name": "Heard and McDonald Islands"
},
{
"code": "VA",
"name": "Holy See"
},
{
"code": "HN",
"name": "Honduras"
},
{
"code": "HK",
"name": "Hong Kong"
},
{
"code": "HU",
"name": "Hungary"
},
{
"code": "IS",
"name": "Iceland"
},
{
"code": "IN",
"name": "India"
},
{
"code": "ID",
"name": "Indonesia"
},
{
"code": "IR",
"name": "Iran"
},
{
"code": "IQ",
"name": "Iraq"
},
{
"code": "IE",
"name": "Ireland"
},
{
"code": "IM",
"name": "Isle of Man"
},
{
"code": "IL",
"name": "Israel"
},
{
"code": "IT",
"name": "Italy"
},
{
"code": "JM",
"name": "Jamaica"
},
{
"code": "JP",
"name": "Japan"
},
{
"code": "JE",
"name": "Jersey"
},
{
"code": "JO",
"name": "Jordan"
},
{
"code": "KZ",
"name": "Kazakhstan"
},
{
"code": "KE",
"name": "Kenya"
},
{
"code": "KI",
"name": "Kiribati"
},
{
"code": "KP",
"name": "Korea (Democratic People's Republic of)"
},
{
"code": "KR",
"name": "Korea (Republic of)"
},
{
"code": "KW",
"name": "Kuwait"
},
{
"code": "KG",
"name": "Kyrgyzstan"
},
{
"code": "LA",
"name": "Lao People's Democratic Republic"
},
{
"code": "LV",
"name": "Latvia"
},
{
"code": "LB",
"name": "Lebanon"
},
{
"code": "LS",
"name": "Lesotho"
},
{
"code": "LR",
"name": "Liberia"
},
{
"code": "LY",
"name": "Libya"
},
{
"code": "LI",
"name": "Liechtenstein"
},
{
"code": "LT",
"name": "Lithuania"
},
{
"code": "LU",
"name": "Luxembourg"
},
{
"code": "MO",
"name": "Macao"
},
{
"code": "MK",
"name": "Macedonia"
},
{
"code": "MG",
"name": "Madagascar"
},
{
"code": "MW",
"name": "Malawi"
},
{
"code": "MY",
"name": "Malaysia"
},
{
"code": "MV",
"name": "Maldives"
},
{
"code": "ML",
"name": "Mali"
},
{
"code": "MT",
"name": "Malta"
},
{
"code": "MH",
"name": "Marshall Islands"
},
{
"code": "MQ",
"name": "Martinique"
},
{
"code": "MR",
"name": "Mauritania"
},
{
"code": "MU",
"name": "Mauritius"
},
{
"code": "YT",
"name": "Mayotte"
},
{
"code": "MX",
"name": "Mexico"
},
{
"code": "FM",
"name": "Micronesia"
},
{
"code": "MD",
"name": "Moldova"
},
{
"code": "MC",
"name": "Monaco"
},
{
"code": "MN",
"name": "Mongolia"
},
{
"code": "ME",
"name": "Montenegro"
},
{
"code": "MS",
"name": "Montserrat"
},
{
"code": "MA",
"name": "Morocco"
},
{
"code": "MZ",
"name": "Mozambique"
},
{
"code": "MM",
"name": "Myanmar"
},
{
"code": "NA",
"name": "Namibia"
},
{
"code": "NR",
"name": "Nauru"
},
{
"code": "NP",
"name": "Nepal"
},
{
"code": "NL",
"name": "Netherlands"
},
{
"code": "NC",
"name": "New Caledonia"
},
{
"code": "NZ",
"name": "New Zealand"
},
{
"code": "NI",
"name": "Nicaragua"
},
{
"code": "NE",
"name": "Niger"
},
{
"code": "NG",
"name": "Nigeria"
},
{
"code": "NU",
"name": "Niue"
},
{
"code": "NF",
"name": "Norfolk Island"
},
{
"code": "MP",
"name": "Northern Mariana Islands"
},
{
"code": "NO",
"name": "Norway"
},
{
"code": "OM",
"name": "Oman"
},
{
"code": "PK",
"name": "Pakistan"
},
{
"code": "PW",
"name": "Palau"
},
{
"code": "PS",
"name": "Palestine, State of"
},
{
"code": "PA",
"name": "Panama"
},
{
"code": "PG",
"name": "Papua New Guinea"
},
{
"code": "PY",
"name": "Paraguay"
},
{
"code": "PE",
"name": "Peru"
},
{
"code": "PH",
"name": "Philippines"
},
{
"code": "PN",
"name": "Pitcairn"
},
{
"code": "PL",
"name": "Poland"
},
{
"code": "PT",
"name": "Portugal"
},
{
"code": "PR",
"name": "Puerto Rico"
},
{
"code": "QA",
"name": "Qatar"
},
{
"code": "RO",
"name": "Romania"
},
{
"code": "RU",
"name": "Russian Federation"
},
{
"code": "RW",
"name": "Rwanda"
},
{
"code": "RE",
"name": "Réunion"
},
{
"code": "BL",
"name": "Saint Barthélemy"
},
{
"code": "SH",
"name": "Saint Helena, Ascension and Tristan da Cunha"
},
{
"code": "KN",
"name": "Saint Kitts and Nevis"
},
{
"code": "LC",
"name": "Saint Lucia"
},
{
"code": "MF",
"name": "Saint Martin"
},
{
"code": "PM",
"name": "Saint Pierre and Miquelon"
},
{
"code": "VC",
"name": "Saint Vincent and the Grenadines"
},
{
"code": "WS",
"name": "Samoa"
},
{
"code": "SM",
"name": "San Marino"
},
{
"code": "ST",
"name": "Sao Tome and Principe"
},
{
"code": "SA",
"name": "Saudi Arabia"
},
{
"code": "SN",
"name": "Senegal"
},
{
"code": "RS",
"name": "Serbia"
},
{
"code": "SC",
"name": "Seychelles"
},
{
"code": "SL",
"name": "Sierra Leone"
},
{
"code": "SG",
"name": "Singapore"
},
{
"code": "SX",
"name": "Sint Maarten"
},
{
"code": "SK",
"name": "Slovakia"
},
{
"code": "SI",
"name": "Slovenia"
},
{
"code": "SB",
"name": "Solomon Islands"
},
{
"code": "SO",
"name": "Somalia"
},
{
"code": "ZA",
"name": "South Africa"
},
{
"code": "GS",
"name": "South Georgia"
},
{
"code": "SS",
"name": "South Sudan"
},
{
"code": "ES",
"name": "Spain"
},
{
"code": "LK",
"name": "Sri Lanka"
},
{
"code": "SD",
"name": "Sudan"
},
{
"code": "SR",
"name": "Suriname"
},
{
"code": "SJ",
"name": "Svalbard and Jan Mayen"
},
{
"code": "SZ",
"name": "Swaziland"
},
{
"code": "SE",
"name": "Sweden"
},
{
"code": "CH",
"name": "Switzerland"
},
{
"code": "SY",
"name": "Syrian Arab Republic"
},
{
"code": "TW",
"name": "Taiwan"
},
{
"code": "TJ",
"name": "Tajikistan"
},
{
"code": "TZ",
"name": "Tanzania, United Republic of"
},
{
"code": "TH",
"name": "Thailand"
},
{
"code": "TL",
"name": "Timor-Leste"
},
{
"code": "TG",
"name": "Togo"
},
{
"code": "TK",
"name": "Tokelau"
},
{
"code": "TO",
"name": "Tonga"
},
{
"code": "TT",
"name": "Trinidad and Tobago"
},
{
"code": "TN",
"name": "Tunisia"
},
{
"code": "TR",
"name": "Turkey"
},
{
"code": "TM",
"name": "Turkmenistan"
},
{
"code": "TC",
"name": "Turks and Caicos Islands"
},
{
"code": "TV",
"name": "Tuvalu"
},
{
"code": "UG",
"name": "Uganda"
},
{
"code": "UA",
"name": "Ukraine"
},
{
"code": "AE",
"name": "United Arab Emirates"
},
{
"code": "GB",
"name": "United Kingdom"
},
{
"code": "UM",
"name": "United States Minor Outlying Islands"
},
{
"code": "UY",
"name": "Uruguay"
},
{
"code": "UZ",
"name": "Uzbekistan"
},
{
"code": "VU",
"name": "Vanuatu"
},
{
"code": "VE",
"name": "Venezuela"
},
{
"code": "VN",
"name": "Viet Nam"
},
{
"code": "VG",
"name": "Virgin Islands (British)"
},
{
"code": "VI",
"name": "Virgin Islands (U.S.)"
},
{
"code": "WF",
"name": "Wallis and Futuna"
},
{
"code": "EH",
"name": "Western Sahara"
},
{
"code": "YE",
"name": "Yemen"
},
{
"code": "ZM",
"name": "Zambia"
},
{
"code": "ZW",
"name": "Zimbabwe"
},
{
"code": "AX",
"name": "Åland Islands"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/countryCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Discover Program Codes Response Object
{
"discoverProgramCodes": [
{
"code": "EASI",
"name": "External Agent Sales Incentive"
},
{
"code": "MAP",
"name": "Merchant Acquiring Program"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/discoverProgramCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Equipment Supplier Codes Response Object
{
"equipmentSupplierCodes": [
{
"code": "FDMP",
"name": "First Data Marketplace"
},
{
"code": "CARDCONNECT",
"name": "CardConnect"
},
{
"code": "THIRDPARTY",
"name": "Thirdparty"
},
{
"code": "TMS",
"name": "TMS"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/equipmentSupplierCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Equipment Type Codes Response Object
{
"equipmentTypeCodes": [
{
"code": "TERMINAL",
"name": "Terminal"
},
{
"code": "GATEWAY",
"name": "Gateway"
},
{
"code": "SOFTWARE",
"name": "Software"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/equipmentTypeCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Front End Platform Codes Response Object
{
"frontEndPlatformCodes": [
{
"code": "AMEX",
"name": "American Express Pltfrm"
},
{
"code": "CPSAF",
"name": "CP Salem - FE Pltfrm"
},
{
"code": "CPTAF",
"name": "CP Tampa - FE Pltfrm"
},
{
"code": "CRDX",
"name": "Credorax Pltfrm"
},
{
"code": "ELVN",
"name": "Elavon Pltfrm"
},
{
"code": "FDBUF",
"name": "FD BuyPass - FE Pltfrm"
},
{
"code": "RCBUF",
"name": "FD RC BuyPass - FE Pltfrm"
},
{
"code": "RCBUF",
"name": "FD RC BuyPass - FE Pltfrm"
},
{
"code": "FDBUF",
"name": "FD BuyPass - FE Pltfrm"
},
{
"code": "RCBUF",
"name": "FD RC BuyPass - FE Pltfrm"
},
{
"code": "FDBUF",
"name": "FD BuyPass - FE Pltfrm"
},
{
"code": "FDCOF",
"name": "FD Compass - FE Pltfrm"
},
{
"code": "FDNAF",
"name": "FD Nashville - FE Pltfrm"
},
{
"code": "FDNAF",
"name": "FD Nashville - FE Pltfrm"
},
{
"code": "FDNAF",
"name": "FD Nashville - FE Pltfrm"
},
{
"code": "FDNOF",
"name": "FD North - FE Pltfrm"
},
{
"code": "FDNOF",
"name": "FD North - FE Pltfrm"
},
{
"code": "FDOMF",
"name": "FD Omaha - FE Pltfrm"
},
{
"code": "RCNAF",
"name": "FD RC Nashville - FE Pltfrm"
},
{
"code": "RCNAF",
"name": "FD RC Nashville - FE Pltfrm"
},
{
"code": "RCNOF",
"name": "FD RC North - FE Pltfrm"
},
{
"code": "RCNOF",
"name": "FD RC North - FE Pltfrm"
},
{
"code": "FDSOF",
"name": "FD South - FE Pltfrm"
},
{
"code": "GBLP",
"name": "Global Payment Pltfrm"
},
{
"code": "LITL",
"name": "Litle Pltfrm"
},
{
"code": "MNRS",
"name": "Moneris Pltfrm"
},
{
"code": "PPAL",
"name": "PayPal Pltfrm"
},
{
"code": "PEXP",
"name": "Payment Express Pltfrm"
},
{
"code": "PSTR",
"name": "ProfitStars Pltfrm"
},
{
"code": "SVS",
"name": "Stored Value Solutions Pltfrm"
},
{
"code": "TSYSF",
"name": "TSYS - FE Pltfrm"
},
{
"code": "TSYSF",
"name": "TSYS - FE Pltfrm"
},
{
"code": "VNTV",
"name": "Vantiv Pltfrm"
},
{
"code": "VITLF",
"name": "Vital - FE Pltfrm"
},
{
"code": "WLDP",
"name": "Worldpay Pltfrm"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/frontEndPlatformCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Interchange Type Codes Response Object
{
"interchangeTypeCodes":[
{
"code": "GROSS",
"name": "Gross"
},
{
"code": "NET",
"name": "Net"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/interchangeTypeCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Order Status Codes Response Object
{
"orderStatusCodes": [
{
"code": "NEW",
"name": "New"
},
{
"code": "CANCELLED",
"name": "Cancelled"
},
{
"code": "EXPORTED",
"name": "Exported"
},
{
"code": "PLACED",
"name": "Placed"
},
{
"code": "FULFILLING",
"name": "Fulfilling"
},
{
"code": "SHIPPED",
"name": "Shipped"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/orderStatusCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Ownership Types Response Object
{
"ownershipTypes": [
{
"code": "GOVT",
"name": "Government"
},
{
"code": "INDIVSOLE",
"name": "Individual / Sole Proprietor"
},
{
"code": "LLC",
"name": "LLC"
},
{
"code": "NONPRFT",
"name": "Non-Profit Org"
},
{
"code": "PRTNRSHP",
"name": "Partnership"
},
{
"code": "PRIVCORP",
"name": "Private Corporation"
},
{
"code": "PUBCORP",
"name": "Public Corporation"
},
{
"code": "TAXEXMPT",
"name": "Tax Exempt"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/ownershipTypes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
PCI Program Codes Response Object
{
"pciProgramCodes": [
{
"code": "ANNUAL",
"name": "PCI Annual Program"
},
{
"code": "CONCIERGE",
"name": "PCI Concierge Program"
}
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/pciProgramCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Refund Policy Codes Response Object
{
"refundPolicyCodes": [
{
"code": "EXCHONLY",
"name": "Exchange Only"
},
{
"code": "NOREFEXCH",
"name": "No Refund or Exchange"
},
{
"code": "MORE30",
"name": "More than 30 days"
},
{
"code": "LESSEQL30",
"name": "30 Days or Less"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/refundPolicyCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Service Provided In Codes Service Provided In Codes Response Object
{
"serviceProvidedInCodes": [
{
"code": "30LESS",
"name": "30 Days or Less"
},
{
"code": "31TO60",
"name": "31 to 60 Days"
},
{
"code": "60PLUS",
"name": "60+ Days"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/serviceProvidedInCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Shipping Carrier Codes Response Object
{
"shippingCarrierCodes": [
{
"code": "FEDEX",
"name": "FedEx"
},
{
"code": "UPS",
"name": "UPS"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/shippingCarrierCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
Shipping Method Codes Response Object
{
"shippingMethodCodes": [
{
"code": "EXPEDITED",
"name": "Expedited"
},
{
"code": "STANDARD",
"name": "Standard"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/shippingMethodCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
State Codes Response Object
{
"stateCodes": [
{
"code": "AL",
"name": "Alabama"
},
{
"code": "AK",
"name": "Alaska"
},
{
"code": "AZ",
"name": "Arizona"
},
{
"code": "AR",
"name": "Arkansas"
},
{
"code": "CA",
"name": "California"
},
{
"code": "CO",
"name": "Colorado"
},
{
"code": "CT",
"name": "Connecticut"
},
{
"code": "DE",
"name": "Delaware"
},
{
"code": "DC",
"name": "District of Columbia"
},
{
"code": "FL",
"name": "Florida"
},
{
"code": "GA",
"name": "Georgia"
},
{
"code": "HI",
"name": "Hawaii"
},
{
"code": "ID",
"name": "Idaho"
},
{
"code": "IL",
"name": "Illinois"
},
{
"code": "IN",
"name": "Indiana"
},
{
"code": "IA",
"name": "Iowa"
},
{
"code": "KS",
"name": "Kansas"
},
{
"code": "KY",
"name": "Kentucky"
},
{
"code": "LA",
"name": "Louisiana"
},
{
"code": "ME",
"name": "Maine"
},
{
"code": "MD",
"name": "Maryland"
},
{
"code": "MA",
"name": "Massachusetts"
},
{
"code": "MI",
"name": "Michigan"
},
{
"code": "MN",
"name": "Minnesota"
},
{
"code": "MS",
"name": "Mississippi"
},
{
"code": "MO",
"name": "Missouri"
},
{
"code": "MT",
"name": "Montana"
},
{
"code": "NE",
"name": "Nebraska"
},
{
"code": "NV",
"name": "Nevada"
},
{
"code": "NH",
"name": "New Hampshire"
},
{
"code": "NJ",
"name": "New Jersey"
},
{
"code": "NM",
"name": "New Mexico"
},
{
"code": "NY",
"name": "New York"
},
{
"code": "NC",
"name": "North Carolina"
},
{
"code": "ND",
"name": "North Dakota"
},
{
"code": "OH",
"name": "Ohio"
},
{
"code": "OK",
"name": "Oklahoma"
},
{
"code": "OR",
"name": "Oregon"
},
{
"code": "PA",
"name": "Pennsylvania"
},
{
"code": "RI",
"name": "Rhode Island"
},
{
"code": "SC",
"name": "South Carolina"
},
{
"code": "SD",
"name": "South Dakota"
},
{
"code": "TN",
"name": "Tennessee"
},
{
"code": "TX",
"name": "Texas"
},
{
"code": "UT",
"name": "Utah"
},
{
"code": "VT",
"name": "Vermont"
},
{
"code": "VA",
"name": "Virginia"
},
{
"code": "WA",
"name": "Washington"
},
{
"code": "WV",
"name": "West Virginia"
},
{
"code": "WI",
"name": "Wisconsin"
},
{
"code": "WY",
"name": "Wyoming"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/stateCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
TransArmor Token Type Codes TransArmor Token Type Codes Response Object
{
"transarmorTokenTypeCodes": [
{
"code": "SINGLE",
"name": "Single Pay"
},
{
"code": "MULTI",
"name": "Multi Pay"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/transarmorTokenTypeCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/json
When Customer Charged Codes When Customer Charged Codes Response Object
{
"whenCustomerChargedCodes": [
{
"code": "INADVANCE",
"name": "In Advance"
},
{
"code": "WHENSERV",
"name": "When Service Provided"
}
]
}
Method
GET Host https://api-uat.cardconnect.com Path /lookup/whenCustomerChargedCodes Headers Authorization: Bearer
X-CopilotAPI-Version: 1.0 Content-Type: application/json
Body none Consumes N/A Produces application/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.
Example Error Array
{
"errors": [
{
"code": "1113",
"message": "Owner date of birth is invalid. Please use MM/DD/YYYY format.",
"errorField": "merchant.ownership.owner.ownerDob",
"status": "BAD_REQUEST"
},
{
"code": "1115",
"message": "Phone is invalid. Please use XXX-XXX-XXXX format.",
"errorField": "merchant.demographic.businessPhone",
"status": "BAD_REQUEST"
}
]
}
Field Type Comments code String The error code message String The error message errorField String The field that caused the error status String The HTTP Status Code