CoPilot API

The following entries describe changes to the CoPilot API and documentation.

Date Updated: 1/19/2022

This release contains the following updates:

Third Party Provider Details

The Merchant Definition now includes an additional thirdPartyProviderDetails object, to specify third party provider (TPP) details in a merchant create or update request. This object is also returned in a GET merchant details response.

This change aligns with a previous update to the MPA and CoPilot to ask if the merchant uses any third party provider (TPP) to store, process, or transmit cardholder data, and if so, to provide the TPP Name and contact phone and email.

The thirdPartyProviderDetails object is optional, but requires the following fields when provided:

Field	Type	Description
thirdPartyProviderFlg	Boolean	A true/false indicator the determines whether or not 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.

Date Updated: 11/17/2021

This release contains the following updates:

Clover Platform Fee

The Fees definition now includes a Clover Platform Fee, cloverPlatformFee, which is required to submit merchant applications that include Clover orders.

Billing Plan Updates

This release includes the following updates to billing plan requests:

Billing Plan Definition

The profileGuid field has been added.
Billing Plan Schedule Definition

The billingPlanId field is now required in the request.
Mark as Paid Request

The billingPlanId and merchId fields are now required in the request.
Cancel Payment Request

The merchId field is now required in the request.

New Sponsor Bank Code

The Hierarchy definition sponsorBankCd enumeration now includes PNC to support the migration from BBVA to PNC Bank sponsorship.

Date Updated: 9/1/2021

This release contains the following updates:

PCI Program Selection

The Fees definition now includes a required PCI Program Code field, pciProgramCd, to identify the merchant's PCI program enrollment.

Additionally, the Fees definition includes a new pciConciergeMonthlyFee, required to submit merchant applications when the pciProgramCd is CONCIERGE.

Date Updated: 6/23/2020

This release contains the following updates:

New Clover Security Bundle Code

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

New Attachment Type Code

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

New Cancel Billing Plan Payment Endpoint

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

Date Updated: 5/5/2020

This release contains the following updates:

New Interchange Type Field

The IC Plus Pricing schema includes a new optional interchangeTypeCode field to set the Passthrough Interchange Costs.

When interchangeTypeCode is not included in the request, the default interchange type remains GROSS interchange.

New Clover Security and TransArmor Fields

The Merchant schema now includes a new cloverSecurityAndTransarmor object, to add a Clover Security bundle or enable TransArmor Data Protection for Clover equipment.

TansArmor Data Protection and Clover Security bundles are not applicable to Bolt on Clover terminals.

The Fees schema now includes new cloverSecurityFee and pciAnnualFeeMonthToBill fields.

New Corporate Level and Chain Level Fields

The Merchant schema now includes a new Hierarchy object, containing optional fields to set corpLevel and chainLevel for merchants boarding to First Data North.

New Publicly Traded Flag and Stock Symbol Fields

The Ownership Schema now includes a new publiclyTradedFlag field and stockSymbol field for boarding merchants with the PUBCORP Ownership Type Code to the First Data North or Omaha platforms.

New Attachment Type Codes

The Attachment Type Codes include a new SIGNEDCONFIRMATION attachment type.

Use the new SIGNEDCONFIRMATIONcode when uploading a physical copy of the Program Guide signed by the merchant.

Date Updated: 10/8/2019

This release includes the following update:

BlueChex Volume Fields

The CoPilot API includes a new blueChexVolume object in the Processing schema.

The blueChexVolume details are required for merchants using the BlueChex add-on.

This object includes the following fields:

Field	Size	Type	Description
avgPerTransactionSalesAmount	18.2	Decimal	Average sales amount per BlueChex transaction.
maxPerTransactionSalesAmount	18.2	Decimal	Maximum sales amount per BlueChex transaction.
avgPerTransactionCreditAmount	18.2	Decimal	Average credit (refund) amount per BlueChex transaction.
maxPerTransactionCreditAmount	18.2	Decimal	Maximum credit (refund) amount per BlueChex transaction.
avgPerMonthSalesAmount	18.2	Decimal	Average monthly sales amount for all BlueChex transactions.
maxPerMonthSalesAmount	18.2	Decimal	Maximum monthly sales amount for all BlueChex transactions.
avgPerMonthCreditAmount	18.2	Decimal	Average monthly credit (refund) amount for all BlueChex transactions.
maxPerMonthCreditAmount	18.2	Decimal	Maximum monthly credit (refund) amount for all BlueChex transactions.

For example:

"processing": {
     "blueChexVolume" : {
          "avgPerTransactionSalesAmount" : "250.00",
          "maxPerTransactionSalesAmount" : "9999.00",
          "avgPerTransactionCreditAmount" : "200.00",
          "maxPerTransactionCreditAmount" : "9999.00",
          "avgPerMonthSalesAmount" : "25000.00",
          "maxPerMonthSalesAmount" : "50000.00",
          "avgPerMonthCreditAmount" : "5000.00",
          "maxPerMonthCreditAmount" : "10000.00"
         }
      }