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.

    timezone stringrequired

    Establishment timezone. Format: ±HHmm (e.g., -0300, +0300).

    mcc string

    MCC (Merchant Category Code). 4 digits.

    bank_number stringrequired

    Bank number (3 digits).

    bank_agency stringrequired

    Bank branch number.

    bank_account_number stringrequired

    Bank account number.

    bank_account_digit stringrequired

    Bank account check digit.

    bank_account_type stringrequired

    Possible values: [CHECKING, SAVINGS]

    Bank account type.

    table_type stringrequired

    Possible values: [SIMPLE, CUSTOM]

    Price table type.

    anticipation_type stringrequired

    Possible values: [NONE, EVENTUAL, COMPULSORY]

    Anticipation type.

    table_name string

    Price table name.

    compulsory_anticipation_days number

    Compulsory anticipation days.

    opening_date stringrequired

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

    opening_days stringrequired

    Operating days. 7-character string, each char 0 or 1 representing Sun-Sat.

    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.

    has_tef booleanrequired

    Indicates whether TEF is enabled.

    has_pix booleanrequired

    Indicates whether PIX is enabled.

    has_top booleanrequired

    Indicates whether Tap On Phone is enabled.

    has_3ds boolean

    Indicates whether 3DS is enabled.

    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.

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...