Editar Subconta

PUT /company/subaccount/{subaccountId}

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

Método utilizado para editar subconta.

Dados da requisição

Nome

Tipo

Obrigatório

Explicação

Address

Não

Endereço da subconta. Não será atualizado se a documentação da subconta já estiver verificada.
Clique para ver os campos.

zipCode

string 255 caracteres

Não

CEP. Informe apenas números.

street

string 255 caracteres

Não

Logradouro.

number

string 255 caracteres

Não

Número.

complement

string 255 caracteres

Não

Complemento.

neighborhood

string 255 caracteres

Não

Bairro.

city

string 255 caracteres

Não

Cidade.

state

string 255 caracteres

Não

Estado.

logo

text

Não

Logo da empresa em base64

canAccessPlatform

bool

Não

Subconta poderá acessar a plataforma cel_cash.

Parâmetros da URL:

{subaccountId}: Id da Subconta

URL da Requisição

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

URL da Requisição

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

Body da requisição

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "type": true,
    "Company": {
        "galaxPayId": 1,
        "galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe",
        "name": "Lorem ipsum",
        "document": "012345678909",
        "nameDisplay": "Lorem Ipsum dolor sit amet.",
        "active": true,
        "emailContact": "[email protected]",
        "urlLogo": "https://www.celcoin.com.br/",
        "publicToken": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe",
        "canAccessPlatform": false,
        "createdAt": "2020-06-02 10:10:00",
        "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": {
            "galaxPayId": 1,
            "name": "Lorem ipsum",
            "internalName": "doctor",
            "label": "CRM",
            "inscription": "inscriptonBla"
        },
        "Users": [
            {
                "galaxPayId": 1,
                "master": true,
                "email": "[email protected]",
                "name": "Lorem ipsum",
                "document": "012345678909",
                "phone": "31994939651"
            }
        ],
        "BoletoDays": [
            {
                "day": 1,
                "value": 2
            }
        ],
        "Config": {
            "confirmHashWebhook": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe",
            "taxWithdraw": 599,
            "taxPixDone": 599,
            "taxPixBoleto": 139,
            "taxPixReceived": 198,
            "taxPixTransaction": 399
        },
        "Verification": {
            "Status": {
                "status": "approved",
                "description": "Aprovada"
            },
            "Reasons": [
                "Documento de identidade não enviada."
            ]
        }
    }
}

Nome

Tipo

Explicação

type

bool

Sucesso ou não da ação.

Company

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

galaxPayId

int 11 dígitos

Id da subconta no cel_cash.

galaxHash

string 255 caracteres

Galax Hash da subconta no cel_cash.

name

string 255 caracteres

Nome ou razão social da subconta.

document

string 255 caracteres

CPF ou CNPJ da subconta.

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.

publicToken

string 255 caracteres

Token publico.

canAccessPlatform

bool

Subconta poderá acessar a plataforma cel_cash.

createdAt

datetime

Data de criação.

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 da subconta.
Clique para ver os campos.

galaxPayId

int 11 dígitos

Id no cel_cash.

name

string 255 caracteres

Nome do Profissional da subconta.

name

string 255 caracteres

Nome do Profissional da subconta.

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.

Users

Usuários da Subconta.
Clique para ver os campos.

galaxPayId

int 11 dígitos

Id do usuário no cel_cash.

master

bool

O usuário é master na subconta.

email

string 255 caracteres

Email do usuário.

name

string 255 caracteres

Nome do usuário.

document

string 255 caracteres

Documento do usuário.

phone

string 255 caracteres

Telefone do usuário.

BoletoDays

Dias de Boletos da Subconta.
Clique para ver os campos.

day

int 11 dígitos

Dias para liquidação do boleto.

value

int 11 dígitos

Valor da Taxa

Config

Configuração da Subconta.
Clique para ver os campos.

confirmHashWebhook

string 255 caracteres

Confirmação do Hash do Webhook.

taxWithdraw

int 11 dígitos

Taxa de Saque realizado.

taxPixDone

int 11 dígitos

Taxa para fazer um Pix.

taxPixBoleto

int 11 dígitos

Taxa para boleto recebido via Pix.

taxPixReceived

int 11 dígitos

Taxa para receber um Pix QR Code estático ou manual.

taxPixTransaction

int 11 dígitos

Taxa para receber um Pix QR Code dinâmico.

Verification

Status de Verificação da subconta.
Clique para ver os campos.

Status

Status da Verificação.
Clique para ver os campos.

status

string 255 caracteres

Status interno da Subconta.

Valor

Explicação

approved

Aprovada

denied

Negado

pending

Pendente

analyzing

Documentos estão sendo analizados

empty

Documentos não informados

description

text

Descrição do Status da Subconta.

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.