Skip to main content
POST
Create a new Submerchant

Authorizations

Authorization
string
header
required

HTTP Basic authentication. Use your secret key as the username and an empty string as password. The API key should be base64 encoded in the format 'username:' when sending the Authorization header.

Body

application/json

The legal name of the merchant.

Example:

"ACME Corp"

tradeName
string
required

The trade name of the merchant.

Example:

"ACME"

companyTaxId
string
required

The tax identification number of the merchant.

Example:

"12.345.678/0001-99"

website
string<uri>
required

The website URL of the merchant.

Example:

"https://google.com"

averageMonthlyRevenue
number
required

The average monthly revenue of the merchant.

Example:

5000

averageOrderValue
number
required

The average order value of the merchant.

Example:

100

productType
enum<string>
required

The type of products sold by the merchant.

Available options:
digital,
physical,
both
Example:

"digital"

contactEmail
string
required

The contact email of the merchant.

productDescription
string
required

A brief description of the products or services offered by the merchant.

Example:

"We sell electronic gadgets and accessories."

address
object
required

The address of the merchant.

phones
object[]
required

List of phone numbers for the merchant.

canAccessDashboard
boolean
required

Defines if the merchant can access the dashboard.

Example:

true

bankAccount
object
required
additionalRepresentatives
object[]

Sócios adicionais da empresa (opcional). Cada item tem o mesmo formato do objeto legalRepresentative. O legalRepresentative continua obrigatório e é sempre o representante legal da subconta; os adicionais são cadastrados como sócios não-representantes.

Os documentos dos sócios não vão neste corpo — após a criação, use os id retornados em legalRepresentatives (resposta) para vincular o upload de documentos de cada sócio via token de upload.

softDescriptor
string

The soft descriptor that will appear on customers' credit card statements.

Maximum string length: 40
Example:

"ACME*GADGETS"

postbackUrl
string<uri>

Optional URL to receive a webhook notification when the merchant approval status changes.

Example:

"https://merchant.com/webhooks/merchant-status"

user
object

Required when canAccessDashboard is true.

Response

The charge has been successfully created

id
string
required

The unique identifier of the created submerchant

Example:

"2vorkDcXyvzifL63YX09S9VqcnI"

Representantes criados — o principal primeiro (isPrimary: true) e depois os sócios adicionais na ordem enviada. Use os id dos itens com isPrimary: false para vincular o upload de documentos de cada sócio.