Criar Subconta CPF

POST /company/subaccount

Para utilizar esse método, o access_token deve conter o scope company.write

Método utilizado para criar subconta do tipo CPF.

Dados da requisição

Nome

Tipo

Obrigatório

Explicação

name

string 255 caracteres

Sim

Nome ou razão social da subconta.

document

string 255 caracteres

Sim

CPF do cliente. Apenas números.

phone

string 11 caracteres

Sim

Telefone da subconta.

emailContact

string 255 caracteres

Sim

Contato por e-mail da subconta.

logo

text

Não

Logo da empresa em base64

canAccessPlatform

bool

Não

Subconta poderá acessar a plataforma cel_cash.

softDescriptor

string 18 caracteres

Sim

Nome que deve aparecer na fatura do seu cliente.

Professional

Sim

Tipo de profissional liberal
Clique para ver os campos.

internalName

string 255 caracteres

Sim

Nome interno no cel_cash.

Valor	Explicação
lawyer	Advogado
doctor	Médico
accountant	Contador
realtor	Corretor de Imóveis
broker	Corretor de Seguro, Vida ou Previdência
physicalEducator	Educador Físico
physiotherapist	Fisioterapeuta
others	Outros

inscription

string

Sim

Inscrição do profissional.

Address

Sim

Endereço da subconta.
Clique para ver os campos.

zipCode

string 255 caracteres

Sim

CEP. Informe apenas números.

street

string 255 caracteres

Sim

Logradouro.

number

string 255 caracteres

Sim

Número.

complement

string 255 caracteres

Não

Complemento.

neighborhood

string 255 caracteres

Sim

Bairro.

city

string 255 caracteres

Sim

Cidade.

state

string 255 caracteres

Sim

Estado.

URL da Requisição

https://api.sandbox.cel.cash/v2/company/subaccount

Body da requisição

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "type": true,
    "Company": {
        "galaxPayId": 13,
        "name": "Lorem ipsum dolor sit amet.",
        "document": "49853630060",
        "nameDisplay": "Lorem Ipsum dolor sit amet.",
        "active": true,
        "emailContact": "[email protected]",
        "urlLogo": "https://www.celcoin.com.br/",
        "createdAt": "2020-06-02 10:10:00",
        "canAccessPlatform": false,
        "updatedAt": "2020-06-02 10:10:00",
        "Address": {
            "zipCode": "30411330",
            "street": "Rua platina",
            "number": "1330",
            "complement": "2º andar",
            "neighborhood": "Prado",
            "city": "Belo Horizonte",
            "state": "MG"
        },
        "Professional": {
            "internalName": "doctor",
            "label": "CRM",
            "inscription": "inscriptonBla"
        },
        "ApiAuth": {
            "galaxId": "5473",
            "galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe",
            "publicToken": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe",
            "confirmHashWebhook": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
        },
        "Verification": {
            "status": "approved",
            "Reasons": [
                "Documento de identidade não enviada"
            ]
        }
    }
}

Nome

Tipo

Explicação

type

bool

Sucesso ou não da ação.

Company

Informações da subconta
Clique para ver os campos.

galaxPayId

int 11 dígitos

ID da subconta

name

string 255 caracteres

Nome ou razão social da subconta

document

string 255 caracteres

CPF OU CNPJ do cliente. Apenas números.

nameDisplay

string 255 caracteres

Nome fantasia da subconta.

active

bool

Status da subconta no sistema.

emailContact

string 255 caracteres

Contato por e-mail da subconta

urlLogo

string 255 caracteres

Url da logo da Subconta.

createdAt

datetime

Data de criação.

canAccessPlatform

bool

Subconta poderá acessar a plataforma cel_cash.

updatedAt

datetime

Data de alteração.

Address

Endereço de cobrança do cliente.
Clique para ver os campos.

zipCode

string 255 caracteres

CEP. Informe apenas números.

street

string 255 caracteres

Logradouro.

number

string 255 caracteres

Número.

complement

string 255 caracteres

Complemento.

neighborhood

string 255 caracteres

Bairro.

city

string 255 caracteres

Cidade.

state

string 255 caracteres

Estado.

Professional

Tipo de profissional liberal
Clique para ver os campos.

internalName

string 255 caracteres

Nome interno do Profissional.

Valor

Explicação

lawyer

Advogado

doctor

Médico

accountant

Contador

realtor

Corretor de Imóveis

broker

Corretor de Seguro, Vida ou Previdência

physicalEducator

Educador Físico

physiotherapist

Fisioterapeuta

others

Outros

label

string 255 caracteres

Label da Subconta.

inscription

string 255 caracteres

Inscrição do profissional.

ApiAuth

Informações de autenticação via API
Clique para ver os campos.

galaxId

string

Seu Galax Id.

galaxHash

string 255 caracteres

Seu Galax Hash.

publicToken

string 255 caracteres

Token publico.

confirmHashWebhook

string 255 caracteres

Confirmação do Hash do Webhook.

Verification

Informações de verificação da conta
Clique para ver os campos.

status

string 255 caracteres

Nome interno do motivo

Valor

Explicação

approved

Aprovada

denied

Negado

pending

Pendente

analyzing

Documentos estão sendo analizados

empty

Documentos não informados

Reasons

array de string

Array de Motivos da Análise de Conta.

Código

Explicação

200

Sucesso.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.