The Secure Payments feature provides secure credit card processing. After payment is initiated by the agent, the customer is taken through a series of payment prompts.
The agent can watch payment progress on their Agent Adapter while the customer enters payment information but they are unable to hear the consumer side of the call.
Prerequisite
- Payment provider credentials are integrated with the CCAI Platform portal.
Retrieve your payment gateway credentials
To retrieve your payment provider credentials, you can follow these instructions on a per provider basis.
Stripe
-
From your Stripe account, toggle View Test Datato on.
-
API Key: The API key is the information you'll need in the next section.
FreedomPay
-
Set up a merchant account with payment gateway(s).
-
From the FreedomPay portal, retrieve the following information:
- Store ID.
- Terminal ID for that merchant, specific to the Contact Center AI Platform (CCAI Platform) integration.
Braintree
Retrieve the following credentials for your Braintree account: Environment
, Merchant ID
, Public Key
, Private Key
, Tokenization Key
, and Merchant Accounts
. See Important Gateway Credentials
in the Braintree documentation.
Admin configuration
Additional settings can be configured by the administrator in the CCAI Platform portal. These settings are outlined in the following sections.
Customize messages about payment details
A succession of messages are displayed to the agent while the caller is making their payment. These messages are standardized by default. To set custom messages, you can update the Text-to-Speech script at Settings> Languages & Messages> IVR Purchase Flow Messages.
See IVR Purchase Flow Messages for sample scripted messages.
Enable and add a provider
-
Go to Settings > Developer Settings.
-
In the Credit Card Payment Providerssection, click Manage Payment Providers. Current providers previously set up in your environment are displayed.
-
Click +Add Provider. You are brought to the Payment Provider details page.
-
Enter a Namefor the payment option.
-
Select Payment Provider.
-
Select Type. Dynamic fields to enter credentials will display after the provider type has been selected.
-
Enter credentials:
- For Stripe, enter the
API secret keyfound in your Stripe account. - For FreedomPay, enter the Store ID and the Terminal ID. The format
of these two IDs must be
storeID,terminalID.
- For Stripe, enter the
-
Select the currencytype. The default option is USD. Stripe and Braintree offer additional currency options. For more information, see the multi-currency documentation .
-
Click Save.
Configure Secure Payments for inbound calls
-
Go to Settings> Queue> {select preferred channel}> select a queue> Credit Card Payment Settings.
-
Toggle the Credit Card Payment Settingsto Enable.
-
Select Providerfrom the drop-down menu.
-
Select Use ZIP Codeto have the customer verify their zip code during payment.
-
Select Currencyfrom the drop-down menu.
-
Click Save.
Configure Secure Payments for outbound calls
-
Toggle the Payments for Outbound Callsswitch to On.
-
Select an existing payment provider from the Providerdrop-down.
-
Select the Use ZIP Codecheckbox is if you want to require the customer to verify their billing zip code during payment.
-
Click Save Payment.
Configure Secure Payments for multi-currency
When you set up secure credit card payment options through Stripe or Braintree, you have the option to select from the following international currencies:
- United States Dollar - USD (default option)
- British Pounds - EUR
- Euros - EUR
- Canadian Dollars - CAD
Set a new default currency
-
Go to Settings> Developer Settings> Credit Card Payment Providers.
-
Expand the Default Currencydrop-down and select a currency option.
-
Click Save Payment.
Apply multi-currency options to your payment provider
-
Go to Settings> Developer Settings> Credit Card Payment Providers.
-
Click Manage Payment Providers.
-
Click +Add Provider.
-
Enter a name for the provider.
-
Select the Provider Typefrom the drop-down menu. If you select Braintree, dynamic fields for adding a merchant account will appear. To add multiple currencies for Braintree, click +Add Merchant Accountand enter the details.
-
Click +Add Currencyand select from the list. To add multiple currencies, keep clicking Add currency. Your selected currencies will appear in a list on the Payment Providerpage. Click Xto remove a currency type

