Skip to main content

Create Merchant Onboarding

POST 
/v1/users/merchant-onboarding

Creates a merchant onboarding to register the legal person as a commercial establishment at Dock Acquiring. The PJ onboarding must be finished.

Request​

Header Parameters

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid string

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Body

required
    onboarding_id stringrequired

    Finished legal person (PJ) 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. Example: "0111110" means Mon-Fri open.

    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, DEMAIS]

    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

Responses​

Merchant onboarding created successfully.

Schema
    id stringrequired

    Merchant onboarding ID.

    status stringrequired

    Possible values: [PENDING, WAITING_DOCUMENTS, APPROVED, DECLINED, FAILED]

    Merchant onboarding status.

    external_id string

    Merchant external identifier.

    created_at date-timerequired

    Created at timestamp.

Loading...