Supported services and features
The service and feature codes a business can turn on, and what each one does.
Onboarding provisions Accept Payments (card-not-present), the service services.payin.card, end-to-end. Card-not-present means the card isn't physically there when the customer pays, such as online or by phone. Use the codes here when you configure services.
Supported service
| Service | Code | What it enables |
|---|---|---|
| Accept Payments | payin.card | Take credit and debit card payments online (eCommerce) or by mail or telephone order (MOTO). |
On a business, the service appears as services.payin.card. On the services endpoint, you send it as payin.card. Only payin.card is provisioned through onboarding.
Supported features
A feature is an option within a service. Some features need another feature turned on first. Features are sent in the services map under payin.card.features.
| Feature | Code | What it does | Needs |
|---|---|---|---|
| Card not present | cardNotPresent | Accept card payments when the card is not physically present, such as online or by phone. | |
| MX Advantage fee programs | mxAdvantage | Pass some or all of the card processing cost on to the customer. Only one program can be enabled at a time. | |
| Amex OptBlue | amexOptBlue | Accept American Express cards through the Amex OptBlue program. | |
| 3-D Secure | 3DSecureAuthentication | Add 3-D Secure authentication to online card payments. | cardNotPresent |
| Account updater | accountUpdater | Automatically update stored card details when a customer's card is replaced. | cardNotPresent |
| Priority program fee | priorityProgramFee | Enroll the business in the Priority Managed Fee Program. | cardNotPresent |
What onboarding doesn't cover
You can't set these up through onboarding:
- Treasury (banking and money movement, including faster funding) and card issuing.
- Payment terminals.
- ACH enablement (bank-to-bank payments).
- Electronic signature. Merchant agreements, the contract your merchant signs with Priority, are signed by hand.
- Status webhooks. Read the business to check its status. See Service lifecycle.
Settings from your partner configuration
Some settings come from your partner configuration and apply to every business you onboard. You don't set them per business:
- Processor setup.
- Pricing template.
- Statement branding.
- The welcome kit email.
Fee programs (mxAdvantage)
mxAdvantage)The four mxAdvantage features are fee programs. Each one passes some or all of the card processing cost on to the customer. A business can have one fee program on at a time. To switch, see Configure services.
In a request, the codes nest under features.mxAdvantage, for example features.mxAdvantage.surcharge. Each program takes a data object that sets the fee:
| Field | Values | Description |
|---|---|---|
data.type | PERCENTAGE, PER_ITEM, CASH | How the fee is calculated. Surcharge supports PERCENTAGE only. |
data.value | Number, 0 or more | A percentage from 0 to 100 (0 to 4 for surcharge), or an amount in US dollars for PER_ITEM and CASH. |
| Program | Code | What it does |
|---|---|---|
| Surcharge | mxAdvantage.surcharge | Adds a percentage surcharge to credit card payments. data.type must be PERCENTAGE and data.value between 0 and 4. |
| Service fee | mxAdvantage.serviceFee | Adds a service fee to payments. |
| Convenience fee | mxAdvantage.convenienceFee | Adds a convenience fee to payments taken through an alternative channel, such as online. |
| Cash discount | mxAdvantage.cashDiscount | Offers a lower price to customers who pay by cash. |
To enable any of these, see Configure services and the PATCH /v1/businesses/{businessId}/services endpoint.
Next steps
See also
- Businesses: where services and features sit in the entity model
- Locations: set features per location
Updated 9 days ago