Supported services and features
The service and feature codes a business can turn on, and what each one does.
Onboarding provisions three groups of services: Accept Payments (card-not-present), Treasury deposit accounts, and payouts. 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 services
| Service | Code | What it enables |
|---|---|---|
| Accept Payments | payin.card | Take credit and debit card payments online (eCommerce) or by mail or telephone order (MOTO). |
| FBO deposit account | treasury.fbo | A deposit account held for the business and managed by the program manager. FBO stands for "for the benefit of". |
| Business-owned deposit account | treasury.owned | A deposit account owned and operated by the business. Needs the account agreement (account_agreement). |
| ACH payouts | payout.ach | Send payments to others by ACH (bank-to-bank transfer). |
| Wire payouts | payout.wire | Send payments to others by wire transfer. |
| Check payouts | payout.check | Send payments to others by check. |
On a business, a service appears under its group, for example services.payin.card or services.treasury.fbo. On the services endpoint, you send the same nesting, for example { "treasury": { "fbo": { "enabled": true } } }.
- Card processing is set up per location, so it needs at least one location. Treasury and payout services are set for the whole business and don't need a location.
- Payouts are paid from the business-owned deposit account when the business has one, otherwise from the FBO deposit account.
- You can turn on both deposit accounts for the same business, in one request or one at a time.
- Treasury and payout services have no features. Each takes only
enabled.
Supported features
A feature is an option within a service. The features below belong to card processing (payin.card). 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:
- Card issuing.
- Payment terminals.
- Accepting ACH payments (taking bank-to-bank payments from customers).
- 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:
- Which card processors your account offers. You choose one of them per business; see Card processor.
- 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.
Card processor (cardNotPresent)
cardNotPresent)The card processor is the company that processes the business's card payments. Choose it in the data of the cardNotPresent feature:
| Field | Values | Description |
|---|---|---|
data.processor | tsys, fiserv_north | The processor for card-not-present payments. It must be one your account offers. |
- When you don't send
processor,fiserv_northis used, ortsysif that is the only processor your account offers. - The processor is fixed once the card account is created.
- You can set
processoronly oncardNotPresent.
For a request that sets it, see Configure services.
Next steps
See also
- Businesses: where services and features sit in the entity model
- Locations: set features per location
Updated 9 days ago