Criar Subconta

curl --request POST \
  --url https://gateway.3xpay.co/sub-accounts \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --header 'api_secret: <api-key>' \
  --data '
{
  "company_infos": {
    "cnpj": "12345678000195",
    "company_name": "Empresa Exemplo LTDA",
    "trade_name": "Empresa Exemplo",
    "company_type": "LTDA",
    "constitution_date": "2020-01-01",
    "monthly_income": 50000
  },
  "representative": {
    "name": "João Silva",
    "email": "[email protected]",
    "cpf": "12345678901",
    "full_name": "João Silva Santos",
    "phone": "+5511987654321",
    "mother_name": "Maria Silva",
    "monthly_income": "3000",
    "birth_date": "1990-01-01",
    "was_signed": true,
    "signature_date": "2024-01-01"
  },
  "address": {
    "street": "Rua Exemplo",
    "number": "123",
    "city": "São Paulo",
    "zip_code": "01234567",
    "neighborhood": "Centro",
    "uf": "SP",
    "adress_type": 1
  },
  "ref": "A12as31qw78gb"
}
'

{
  "status": "success",
  "account": {
    "name": "Empresa Exemplo LTDA",
    "document": "12345678000195",
    "status": "PENDING",
    "secrets": {
      "api_key": "ak_1234567890abcdef",
      "api_secret": "as_1234567890abcdef"
    }
  }
}

POST

sub-accounts

Criar Subconta

curl --request POST \
  --url https://gateway.3xpay.co/sub-accounts \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --header 'api_secret: <api-key>' \
  --data '
{
  "company_infos": {
    "cnpj": "12345678000195",
    "company_name": "Empresa Exemplo LTDA",
    "trade_name": "Empresa Exemplo",
    "company_type": "LTDA",
    "constitution_date": "2020-01-01",
    "monthly_income": 50000
  },
  "representative": {
    "name": "João Silva",
    "email": "[email protected]",
    "cpf": "12345678901",
    "full_name": "João Silva Santos",
    "phone": "+5511987654321",
    "mother_name": "Maria Silva",
    "monthly_income": "3000",
    "birth_date": "1990-01-01",
    "was_signed": true,
    "signature_date": "2024-01-01"
  },
  "address": {
    "street": "Rua Exemplo",
    "number": "123",
    "city": "São Paulo",
    "zip_code": "01234567",
    "neighborhood": "Centro",
    "uf": "SP",
    "adress_type": 1
  },
  "ref": "A12as31qw78gb"
}
'

{
  "status": "success",
  "account": {
    "name": "Empresa Exemplo LTDA",
    "document": "12345678000195",
    "status": "PENDING",
    "secrets": {
      "api_key": "ak_1234567890abcdef",
      "api_secret": "as_1234567890abcdef"
    }
  }
}

Criação de Subconta

Cria uma nova subconta completa, incluindo usuário e informações da empresa.

Headers

api_key

string

required

Chave de API do usuário

api_secret

string

required

Secret de API do usuário

Content-Type

string

required

application/json

Body

company_infos

object

required

Informações da empresa

company_infos.cnpj

string

required

CNPJ da empresa (formato: 12345678000195)

company_infos.company_name

string

required

Razão social da empresa

company_infos.trade_name

string

required

Nome fantasia da empresa

company_infos.company_type

string

required

Tipo da empresa (ex: LTDA, S.A., etc.)

company_infos.constitution_date

string

required

Data de constituição (formato: YYYY-MM-DD)

company_infos.monthly_income

number

required

Renda mensal da empresa

representative

object

required

Informações do representante legal

representative.name

string

required

Nome do representante

representative.email

string

required

Email do representante

representative.cpf

string

required

CPF do representante

representative.full_name

string

required

Nome completo do representante

representative.phone

string

required

Telefone do representante

representative.mother_name

string

required

Nome da mãe do representante

representative.monthly_income

string

required

Renda mensal do representante

representative.birth_date

string

required

Data de nascimento (formato: YYYY-MM-DD)

representative.was_signed

boolean

required

Se o representante já assinou os documentos

representative.signature_date

string

required

Data da assinatura (formato: YYYY-MM-DD)

address

object

required

Endereço da empresa

address.street

string

required

Rua/Logradouro

address.number

string

required

Número

address.city

string

required

Cidade

address.zip_code

string

required

CEP

address.neighborhood

string

required

Bairro

address.uf

string

required

UF (Estado)

address.adress_type

number

required

Tipo de endereço

ref

string

Referência opcional para identificação

Resposta de Sucesso (201)

{
  "status": "success",
  "account": {
    "name": "Empresa Exemplo LTDA",
    "document": "12345678000195",
    "status": "PENDING",
    "secrets": {
      "api_key": "ak_1234567890abcdef",
      "api_secret": "as_1234567890abcdef"
    }
  }
}

Possíveis Erros

400 - Bad Request

Dados inválidos ou campos obrigatórios não preenchidos

401 - Unauthorized

Api Key não encontrada ou inválida

409 - Conflict

Email já cadastrado no sistema

500 - Internal Server Error

Erro interno do servidor durante a criação

Authorizations

api_key

string

header

required

api_secret

string

header

required

Body

application/json

company_infos

object

required

Show child attributes

company_infos.cnpj

string

required

CNPJ da empresa

Example:

"12345678000195"

company_infos.company_name

string

required

Razão social da empresa

Example:

"Empresa Exemplo LTDA"

company_infos.trade_name

string

required

Nome fantasia da empresa

Example:

"Empresa Exemplo"

company_infos.company_type

string

required

Tipo da empresa

Example:

"LTDA"

company_infos.constitution_date

string<date>

required

Data de constituição

Example:

"2020-01-01"

company_infos.monthly_income

number

required

Renda mensal da empresa

Example:

50000

representative

object

required

Show child attributes

representative.name

string

required

Nome do representante

Example:

"João Silva"

representative.email

string<email>

required

Email do representante

Example:

"[email protected]"

representative.cpf

string

required

CPF do representante

Example:

"12345678901"

representative.full_name

string

required

Nome completo do representante

Example:

"João Silva Santos"

representative.phone

string

required

Telefone do representante

Example:

"+5511987654321"

representative.mother_name

string

required

Nome da mãe do representante

Example:

"Maria Silva"

representative.monthly_income

string

required

Renda mensal do representante

Example:

"3000"

representative.birth_date

string<date>

required

Data de nascimento

Example:

"1990-01-01"

representative.was_signed

boolean

required

Se o representante já assinou os documentos

Example:

true

representative.signature_date

string<date>

required

Data da assinatura

Example:

"2024-01-01"

address

object

required

Show child attributes

address.street

string

required

Rua/Logradouro

Example:

"Rua Exemplo"

address.number

string

required

Número

Example:

"123"

address.city

string

required

Cidade

Example:

"São Paulo"

address.zip_code

string

required

CEP

Example:

"01234567"

address.neighborhood

string

required

Bairro

Example:

"Centro"

address.uf

string

required

UF (Estado)

Example:

"SP"

address.adress_type

number

required

Tipo de endereço

Example:

1

ref

string

Referência opcional para identificação

Example:

"A12as31qw78gb"

Response

201 - application/json

Subconta criada com sucesso

status

string

Status da resposta

Example:

"success"

account

object

Show child attributes

account.name

string

Nome da empresa

Example:

"Empresa Exemplo LTDA"

account.document

string

CNPJ da empresa

Example:

"12345678000195"

account.status

string

Status da conta

Example:

"PENDING"

account.secrets

object

Show child attributes

account.secrets.api_key

string

Chave de API da subconta

Example:

"ak_1234567890abcdef"

account.secrets.api_secret

string

Secret de API da subconta

Example:

"as_1234567890abcdef"

Introdução Upload Documento Pessoal

⌘I

API Documentation

Sub-accounts API

Endpoint Examples

Webhooks

Criar Subconta

Criação de Subconta

Headers

Body

Resposta de Sucesso (201)

Possíveis Erros

Authorizations

Body

Response

API Documentation

Sub-accounts API

Endpoint Examples

Webhooks

​Criação de Subconta

​Headers

​Body

​Resposta de Sucesso (201)

​Possíveis Erros

Authorizations

Body

Response

Criação de Subconta

Headers

Body

Resposta de Sucesso (201)

Possíveis Erros