CoPilot API

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

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:

FieldSizeTypeDescription
avgPerTransactionSalesAmount18.2DecimalAverage sales amount per BlueChex transaction.
maxPerTransactionSalesAmount18.2DecimalMaximum sales amount per BlueChex transaction.
avgPerTransactionCreditAmount18.2DecimalAverage credit (refund) amount per BlueChex transaction.
maxPerTransactionCreditAmount18.2DecimalMaximum credit (refund) amount per BlueChex transaction.
avgPerMonthSalesAmount18.2DecimalAverage monthly sales amount for all BlueChex transactions.
maxPerMonthSalesAmount18.2DecimalMaximum monthly sales amount for all BlueChex transactions.
avgPerMonthCreditAmount18.2DecimalAverage monthly credit (refund) amount for all BlueChex transactions.
maxPerMonthCreditAmount18.2DecimalMaximum 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"
         }
      }