Skip to content
  • There are no suggestions because the search field is empty.

CPM - Introduction

A high-level explanation of Channel Payments Manager (CPM) architecture and common Terms/Concepts to be aware of.

We built CPM as a fully integrated, feature-rich application embedded within Business Central, connecting your ERP directly to your digital payment processor.

We currently have integrations built to connect Business Central with: Stripe and Usio.

 

Note: We have four areas of key Terms/Concepts that we will reference in much of our subsequent documentation:

(while this is quite technical, understanding these terms will help make the onboarding guides easier to understand)

BC Navigation | API Terms | CPM Extensions | CPM Specific Terms

 

Business Central Navigation

As we guide you through our self-service install and setup, we will often refer to accessing BC or CPM cards, data and settings. Here is a quick overview of the terms we'll be using.  If you are a seasoned Business Central power user, you may already know all of this information.

  • Search / Magnifying Glass button (ALT+Q) - when we give instructions to search for a particular Card (or an installed application extension), this is where you start. Simply click on the magnifying glass button (or type the ALT+Q shortcut), enter in your search terms and click the related link.
    • Search / Magnifying Glass button in Business Central
  • Navigation Ribbon / Actions - once you've loaded your card/extension, you will have a navigation ribbon at the top which has several categories of options, including drop-down menus. Directly below that main navigation ribbon is an action bar with buttons.
    • Navigation Ribbon / Actions in Business Central
  • FastTab - this is what BC calls a section header in a particular card. Here is an example showing the Address & Contact FastTab for the Customer Card
    • FastTabs in Business Central
  • FactBox - this refers to a panel on the right side of the screen that shows related information without needing to click to another screen. We're using the same customer card from above to show you the example below:
    • FactBox in Business Central

 

General API Terms

API

  • The term API means Application Programming Interface. An API is a set of rules or protocols that enables software applications to communicate with each other to exchange data, features and functionality.

 Endpoint

  • When described alongside APIs, an Endpoint is a destination (usually a website URL) that a source set of API code connects to and passes data and instructions through that address.

Scopes

  • Scopes in an API connection refer to types or categories of functions that are permitted to be used within the API connection.

Client ID, Client Secret and Token

  • Client ID, Client Secret, and Token are permission-based values that authorize your API calls and grant the connected systems access to each other. They are all progressively more private/critical than the prior.



CPM Extensions Defined

CPM Core

  • This contains the core functionality of the CPM solution, such as the tables in which data is stored.

CSM Core

  • This contains the API engine that processes the API calls used to send and receive data between a payment processor and Dynamics 365 Business Central, and the automation routines that execute these API calls.

CPM for [processor]

  • This facilitates communication between CPM Core and an external environment.

Suite Engine Common Base

  • This is used to manage your subscription to CPM and other Suite Engine products. 

 

CPM Specific Terms

API Sets

  • You can consider the API Set as a master container to hold a set of API Credentials

  • Search for API Sets and select the related link

  • API Sets have a unique identifier called an API Set Code

API Credentials

  • API Credentials live inside of a particular API Set

  • API Credentials contain key items to connect to an Endpoint, such as: Scopes, Client ID, Client Secret and Token
  • You can access your API Credentials inside of the API Sets card by selecting your API Set and under the Related option, select API Credentials and then click the API Set Code
    • API Credentials in Business Central

Payment Platform

  • We use the term Payment Platform to describe the core configuration that represents the connection between Business Central and your hosted digital payment processor

  • You can access your Payment Platforms by searching CPM Payment Platforms and selecting the related link
  • Payment Platforms contain unique configuration rules, customer mapping, and item mapping. 
  • You can have unlimited Payment Platforms in CPM



Note: This is the relational architecture of CPM:

API Sets house the API Credentials

API Credentials connect Business Central to your Payment Processor

Business Central's configuration settings to your Payment Processor are found in the Payment Platform.

 

➡️Next Step: Installation