CoPilot API

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

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"
         }
      }