Merchant Profile API

Use the merchant profile endpoint to read your current FairShare merchant profile and update onboarding-related fields.

This endpoint is useful when you want to:

• Check your current merchant status
• Read your preferred convenience fee defaults
• Update your profile as part of onboarding

On This Page

• Authentication
• Get Your Profile
• Update Your Profile
• Preferred Convenience Fee Fields
• Validation Rules

Authentication

Include your merchant API key in the X-SplitPay-API-Key header.

X-SplitPay-API-Key: YOUR_API_KEY

Use your sandbox API key in sandbox and your live API key in live.

Get Your Profile

Use this endpoint:

GET https://api.fairsharepay.com/api/v1/merchants/me

Common response fields include:

Field	Type	Description
status	string	Current merchant status, such as PENDING_PROFILE or ACTIVE
preferredConvenienceFeeType	string	Merchant-level preferred convenience fee mode
preferredConvenienceFeeValue	number	Merchant-level preferred convenience fee value

Update Your Profile

Use this endpoint:

PATCH https://api.fairsharepay.com/api/v1/merchants/me

You can update onboarding and profile fields through this endpoint, including:

Field	Type	Description
preferredConvenienceFeeType	string	Preferred convenience fee mode
preferredConvenienceFeeValue	number	Preferred convenience fee value

When a profile update completes the required onboarding data and your merchant moves from PENDING_PROFILE to ACTIVE, your account is treated as onboarding-complete by FairShare.

Preferred Convenience Fee Fields

These fields let you store merchant-level default convenience fee preferences on your profile:

Field	Values	Notes
preferredConvenienceFeeType	NONE, FIXED_PER_CONTRIBUTION	Controls the preferred fee mode
preferredConvenienceFeeValue	number	Preferred fee amount

These are merchant-level profile settings. Split sessions can still include their own session-specific convenienceFeeType and convenienceFeeValue when you create them.

Validation Rules

• Negative convenience fee values are rejected.
• If preferredConvenienceFeeType is NONE, preferredConvenienceFeeValue must be 0.
• Use the same environment-specific API key as the merchant profile you want to read or update.