PayrocOnboardRequest
- accountType: string · Account ID
_id requiredThe merchant account ID
- processorType: string · Processor Config ID
_config _id requiredPayroc processor configuration ID
- surchargeType: string | null · Surcharge Basisenum
_basis What the surcharge is calculated on. Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits from the level above; a null at the account level leaves it unset.
values- total
- subtotal
- subtotal
_plus _tax - subtotal
_plus _tip - null
- surchargeType: boolean | null · Surcharge Confirmation Required
_confirmation _required Whether the cardholder must confirm the surcharge before the sale proceeds. When true, sale/preauth returns a surcharge-pending state that must be confirmed before the transaction completes. Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits from the level above; a null at the account level defaults to no confirmation.
- surchargeType: number | null · Surcharge Rate
_rate Surcharge percentage (e.g., 3.5 for 3.5%). Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits the value from the level above; a null at the account (root) level disables automatic surcharge logic (no surcharge is applied). 0 means surcharges are never applied unless explicitly overridden.
- taxType: string | null · Tax Basisenum
_basis What the tax is calculated on. Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits from the level above; a null at the account level leaves it unset.
values- total
- subtotal
- null
- taxType: number | null · Tax Rate
_rate Tax percentage (e.g., 8.25 for 8.25%). Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits from the level above; a null at the account level disables tax defaults.
