Skip to main content

Settings

Merchant settings are exposed through the merchant route family and cover dashboard layout, alerts, payouts, enterprise profile, payment settings, currency, radar, identity, communication, and related operational configuration.

See Settings Reference for the implementation-aligned route map.

Account Settings

SettingLocationDescription
Business InfoSettings → Enterprise → LegalLegal entity, registration, tax ID
BankingSettings → Enterprise → BankingPayout destinations and schedule
BrandingSettings → Enterprise → BrandingLogo, colors, custom domain
NotificationsSettings → Enterprise → NotificationsEmail notification preferences

Product Settings

SettingLocationDescription
PaymentsSettings → PaymentsPayment methods, currencies, countries
CheckoutSettings → CheckoutHosted checkout page configuration
PayoutsSettings → PayoutsPayout destinations and scheduling
RadarSettings → RadarFraud detection rules
TerminalSettings → TerminalIn-person payment configuration

Security Settings

SettingLocationDescription
TeamSettings → Team & SecurityTeam members and roles
2FASettings → Team & Security → 2FATwo-factor authentication enforcement
SSOSettings → Team & Security → SSOSingle sign-on configuration
API KeysDevelopers → API KeysAPI key management

Personal Settings

SettingLocationDescription
ProfileSettings → Personal InfoName, email, password
CommunicationSettings → CommunicationEmail preferences

Implemented merchant settings routes

Current settings routes include:

  • GET/PATCH /api/v1/merchant/settings/dashboard-layout
  • GET/PATCH /api/v1/merchant/settings/alerts
  • GET/PATCH /api/v1/merchant/settings/payouts
  • GET/PATCH /api/v1/merchant/settings/enterprise
  • GET/PATCH /api/v1/merchant/settings/payments
  • GET/PATCH /api/v1/merchant/settings/currency
  • GET/PATCH /api/v1/merchant/settings/radar
  • GET/PATCH /api/v1/merchant/settings/identity
  • GET/PATCH /api/v1/merchant/settings/data-pipeline
  • GET/PATCH /api/v1/merchant/settings/communication