A fee profile is the discounting object on each store. It sets the merchant’s fees and the rate charged per card type and card state.
Fields
Field | Type | Description |
| string | Profile name. Required, and can’t be empty. |
| enum | Billing cycle, for example |
| enum | Pricing model, for example |
| number | Fee per chargeback, within the country’s tier |
| number | Fee per ACH return, within the country’s tier, or |
| array | One entry per card type and card state |
| enum | For example |
| enum | For example |
| number | Rate on each transaction, as a decimal |
| number | Extra rate on cross-border transactions, as a decimal |
| number | Fixed amount per transaction, for example |
| object | Card types to switch on; send |
| enum | Amex program, for example |
| string | Optional Amex merchant number |
The full value lists for each enum are in the API spec at /api-docs/ on the onboarding host.
Rules
Rates are decimal fractions with up to 4 decimal places:
0.0265is 2.65%, and0.05is 5%. Sending2.65means 265%.Fees follow the country’s tier. Chargeback and ACH return fees must be inside the tier’s range, and ACH fees must be
0where ACH is disabled (see Onboarding API: supported countries and regions).
Example
A Canadian card-present profile (tier 2: fees 10 to 100):
{
"name": "Standard CA card present",
"cycle": "DAILY",
"rateType": "FLAT",
"chargebackFee": 35,
"achReturnFee": 35,
"feeProfiles": [
{ "cardType": "VISA", "cardState": "CARD_PRESENT", "rate": 0.0265, "crossborderRate": 0.01, "transactionFee": 0.1 },
{ "cardType": "MASTERCARD", "cardState": "CARD_PRESENT", "rate": 0.0265, "crossborderRate": 0.01, "transactionFee": 0.1 }
],
"cardTypesToEnable": {},
"amexType": "OPT_BLUE"
}