Profile Schema
Organizational configurations for processing settings and business branding
The Profile schema defines the structure and properties of profile objects in the Payload API. Profiles represent organizational configurations that control processing settings, business categorization, timezone preferences, and branding for payment processing accounts, supporting both direct processing and payment facilitation models.
Profile Object Properties
Complete reference for all properties available in the Profile schema
attrsobject
Custom attributes for extending the resource with additional key-value pairs. Maximum length is 255 characters when serialized.
created_atstring (date-time)Read-only
Timestamp when the resource was created. Automatically set by the system and immutable.
default_categoryenum[string]
The default industry or business category for this profile. This category is used for risk assessment and determines default processing capabilities. When creating accounts under this profile, they will inherit this category unless explicitly overridden. Must be one of the supported industry categories.
Values:
computer_network_services, utilities, bakeries, food_stores_misc, apparel_accessory_shops, real_estate, sporting_recreation_camps, trailer_parks_campgrounds, general_services_misc, landscaping_services, legal_services, dance_schools, theatrical_ticket_agencies, bands_orchestras, sports_clubs_fields, country_clubs, courier_services, recreation_services_misc, doctors, medical_services, schools_elementary_secondary, colleges_universities, vocational_trade_schools, educational_services, child_care_services, charitable_organizations_fundraising, charitable_fundraising, civic_social_associations, political_organizations, religious_organizations, membership_organizations, professional_services, court_costs_alimony_child_support, fines_government_entities, bail_bond_payments, government_services_misc, insurance_sales_underwriting, shoe_stores, software_services, electrical_parts_equipment, restaurants_eating_places, general_contractors, business_services_misc, travel_tour_companies, publishing_printing_miscenvironstring
The environment context for this organization. Returns "test" for sandbox/testing environments or "prod" for production. This determines which data set and processing configuration is used.
idstringRead-only
Unique identifier for the resource. Automatically generated upon creation and cannot be modified. (ID prefix: pfl)
Pattern:
^pfl_[A-Za-z0-9]+$modified_atstring (date-time)Read-only
Timestamp when the resource was last modified. Automatically updated whenever any field changes.
namestringRequired
The display name of the organization or profile. This name is used throughout the system for identification and is visible to users with access to this organization.
Max length: 72
objectenum[string]Read-only
String representing the object type for this resource.
Values:
profileprocessing_settingsProcessingSettingsobject
The expanded processing settings object that configures default processing behavior for this profile. When included, this provides the full configuration including payment types, features, limits, funding, and billing settings that will be inherited by accounts under this profile.
processing_settings_id ID of ProcessingSettingsstringImmutable
ID of the associated processing settings object. (ID prefix: ps)
Pattern:
^ps_[A-Za-z0-9]+$timezonestring
The primary timezone for this organization, specified in IANA timezone format (e.g., "America/New_York"). This affects how dates and times are displayed in reports, invoices, and transaction records for this organization.
Max length: 32
typeenum[string]Required
The profile type determining the business model and capabilities. Possible values: direct (standard merchant account for direct payment processing), or facilitator (platform/marketplace account that can manage sub-accounts and facilitate payments for other businesses).
Values:
direct, facilitator