Skip to main content
POST
Criar subconta
Cadastra um vendedor como subconta da sua loja.
Requer a permissão SUB_ACCOUNT:CREATE.
Formato aceito pela API:
A criação é idempotente pelo CPF/CNPJ: se já existe uma subconta com o mesmo taxId, a API devolve essa subconta, com o saldo atual, e ignora os outros campos.
Erros comuns:

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Body

application/json
name
string
required

Nome do titular.

Required string length: 1 - 100
Example:

"João da Silva"

taxId
string
required

CPF ou CNPJ do titular, com ou sem máscara.

Required string length: 11 - 18
Example:

"111.444.777-35"

externalId
string

Identificador da subconta no seu sistema. Não pode se repetir entre as subcontas da loja.

Required string length: 1 - 100
Example:

"vendedor-42"

metadata
object

Campos livres; todos os valores precisam ser texto.

Example:

Response

Subconta criada, ou a existente com o mesmo taxId.

data
object

Subconta de um vendedor, com o saldo atual.

error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true