Fee allocations define from which accounts transaction fees are deducted and offer a structured way to manage allocation settings. There are two types of fee allocations: tenant and merchant fee allocations.
Tenant Fee Allocations
Tenant fee allocations apply universally across all customers associated with a specific tenant. They are designed for broad use cases and provide a consistent fee application mechanism for general transaction scenarios. These settings are ideal for tenants managing multiple customers with similar fee structures and are not tied to specific currencies.
Merchant Fee Allocations
Merchant fee allocations are designed for merchants to define their own fee structures, offering greater customization. These settings allow merchants to tailor fee allocations for specific transactions involving particular currencies.
Tenant Fee Allocation Setting
| Attribute | Description | Format |
|---|---|---|
| id | Identifier of the tenant allocation setting. | UUID e.g., 5def2f43-2c81-4230-85b2-c8a62f7460c9 |
| tenantId | Identifier of the tenant associated with the fee allocation. | UUID e.g., 5def2f43-2c81-4230-85b2-c8a62f7460c9 |
| sourceCurrencyType | The currency type of the source account of a transaction. | FIAT, CRYPTO |
| targetCurrencyType | The currency type of the target account of a transaction. | FIAT, CRYPTO |
| prioritizeStableCoin | Prioritize stable currencies when allocating the fee. Used when both currency types are CRYPTO, if both currencies are/aren't stable the set feeAllocation will be used. | true, false |
| feeAllocation | The account from which the currency will be deducted from. | SOURCE, TARGET |
Merchant Fee Allocation Setting
| Attribute | Description | Format |
|---|---|---|
| id | Identifier of the merchant allocation setting. | UUID e.g., 5def2f43-2c81-4230-85b2-c8a62f7460c9 |
| merchantId | Identifier of the merchant associated with the fee allocation. | UUID e.g., 5def2f43-2c81-4230-85b2-c8a62f7460c9 |
| currencyOne | One of the currency from a transaction case. | String e.g., EUR |
| currencyTwo | The other currency from a transaction case. | String e.g., EUR |
| allocationCurrency | The currency from which the fee will be deducted from. | String e.g., EUR |