Skip to main content
POST
Criar uma subconta
O reference é imutável. Ele é o identificador que você envia no header X-Sub-Account para operar na subconta e o valor que chega no campo subAccount dos webhooks — escolha com cuidado, porque não é possível alterá-lo depois da criação.Formato: ^[a-z0-9][a-z0-9_-]{1,31}$ — de 2 a 32 caracteres, apenas letras minúsculas, números, - e _, começando por letra minúscula ou número. O reference precisa ser único dentro da conta: repetir um já existente retorna 409 SUB_ACCOUNT_REFERENCE_TAKEN.A subconta nasce com saldo próprio, zerado e totalmente independente do saldo da conta principal. Veja Subcontas para o comportamento do header X-Sub-Account e a tabela completa de erros.

Autorizações

Authorization
string
header
obrigatório

Access token obtido no POST /auth (client_id + client_secret). Válido por 300 segundos.

Corpo

application/json
reference
string
obrigatório

Identificador da subconta definido por você. Único dentro da conta e imutável depois da criação. principal é palavra reservada da conta principal e não pode ser usada: devolve 400 SUB_ACCOUNT_INVALID_REFERENCE.

Pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
Exemplo:

"loja-centro"

name
string
obrigatório

Nome de exibição da subconta

Maximum string length: 255
Exemplo:

"Loja Centro"

Resposta

Subconta criada com sucesso

id
string<uuid>
obrigatório

ID da subconta

reference
string
obrigatório

Reference da subconta

Exemplo:

"loja-centro"

name
string
obrigatório

Nome da subconta

Exemplo:

"Loja Centro"

status
string
obrigatório

Status da subconta

Exemplo:

"approved"

createdAt
string<date-time>
obrigatório

Data de criação