Skip to main content

V1CreateMerchantOnboardingBody

    onboarding_id stringrequired

    Finished legal person onboarding ID.

    trade_name stringrequired

    Establishment trade name. Maximum 30 characters.

    mcc stringrequired

    MCC (Merchant Category Code). 4 digits identifying the business type.

    cnae stringrequired

    CNAE code (Classificação Nacional de Atividades Econômicas).

    bank_number stringrequired

    Bank number (3 digits).

    bank_branch stringrequired

    Bank branch number.

    bank_branch_check_digit string

    Bank branch check digit.

    bank_account_number stringrequired

    Bank account number.

    bank_account_digit stringrequired

    Bank account check digit.

    bank_account_type stringrequired

    Possible values: [CHECKING, SAVINGS, DEPOSIT, PAYMENT]

    Bank account type.

    opening_date stringrequired

    Establishment opening date. Format: YYYY-MM-DD.

    opening_days stringrequired

    Operating days. 7-character binary string where each position represents a day (Sun-Sat). Position 0 = Sunday, 1 = Monday, ..., 6 = Saturday. Use 1 for open, 0 for closed.

    opening_hour stringrequired

    Opening hour. Format: HH:mm.

    closing_hour stringrequired

    Closing hour. Format: HH:mm.

    municipal_registration string

    Municipal registration number.

    state_subscription string

    State registration number.

    establishment_format stringrequired

    Possible values: [EI, MEI, EIRELI, LTDA, SS, SA, ME, EPP, EMPG, COOP, OTHER]

    Establishment legal format.

    revenue numberrequired

    Annual revenue in BRL cents.

    legal_nature_code stringrequired

    Legal nature code. Common codes:

    • 213-5: Empresário Individual (includes MEI)
    • 206-2: Sociedade Empresária Limitada (LTDA)
    • 232-1: Sociedade Unipessoal de Advocacia