Listar Subcontas

GET /company/subaccounts

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

Retorna todas as informações das subcontas de acordo com o filtro informado.

Dados da requisição

Nome

Tipo

Obrigatório

Explicação

galaxPayIds

string

Não

Ids da subcontas no cel_cash. Separe cada id por vírgula.

documents

array de string

Não

CPF OU CNPJ do cliente. Informe apenas números e separe cada um por vírgula.

limit

int

Sim

Qtd máxima de registros para trazer.

startAt

int

Sim

Ponteiro inicial para trazer os registros.

order

string

Não

Ordenação do resultado. String que deverá ser montada da seguinte maneira: campoDaEntidade.tipoDeOrdem.

Valor	Explicação
createdAt.asc	Subconta criada em - Ordem crescente
createdAt.desc	Subconta criada em - Ordem decrescente
galaxPayId.asc	Id da subconta criada em - Ordem crescente
galaxPayId.desc	Id da subconta criada em - Ordem decrescente

URL da Requisição

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

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "type": true,
    "SubAccounts": [
        {
            "galaxPayId": 1,
            "name": "Lorem ipsum",
            "document": "012345678909",
            "nameDisplay": "Lorem Ipsum dolor sit amet.",
            "active": true,
            "emailContact": "[email protected]",
            "urlLogo": "https://www.celcoin.com.br/",
            "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"
            },
            "ApiAuth": {
                "galaxId": "5473",
                "galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe",
                "publicToken": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe",
                "confirmHashWebhook": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
            },
            "Professional": {
                "internalName": "doctor",
                "label": "CRM",
                "inscription": "inscriptonBla"
            },
            "Verification": {
                "status": "approved",
                "Reasons": [
                    "Documento de identidade não enviada."
                ]
            }
        }
    ]
}

Nome

Tipo

Explicação

type

bool

Sucesso ou não da ação.

SubAccounts

Array de Subcontas.
Clique para ver os campos.

galaxPayId

int 11 dígitos

Id 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.

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.

ApiAuth

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

galaxId

string

Seu Galax Id.

galaxHash

string 255 caracteres

Galax Hash da subconta no cel_cash.

publicToken

string 255 caracteres

Token publico.

confirmHashWebhook

string 255 caracteres

Confirmação do Hash do Webhook.

Professional

Tipo de profissional da subconta.
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.

Verification

Status de Verificação da subconta.
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

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.