Listar Clientes

GET /customers

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

Retorna todas as informações dos clientes de acordo com o filtro informado.

Dados da requisição

Nome

Tipo

Obrigatório

Explicação

documents

array de string

Não

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

emails

array de string

Não

Emails do cliente. Separe cada email por vírgula.

createdAtFrom

date

Não

Data de criação inicial

createdAtTo

date

Não

Data de criação final.

createdOrUpdatedAtFrom

date

Não

Data de criação/atualização inicial.

createdOrUpdatedAtTo

date

Não

Data de criação/atualização final.

myIds

string

Não

Ids do cliente no seu sistema.
Separe cada id por vírgula.

galaxPayIds

string

Não

Ids do cliente no cel_cash.
Separe cada id por vírgula.

startAt

int

Sim

Ponteiro inicial para trazer os registros.

status

string

Não

Status atual do cliente.

Valor	Explicação
active	Clientes que possuem assinaturas/cobranças avulsas ativos.
delayed	Clientes que têm pelo menos 1 transação vencida com status de negada,em aberto ou decurso de prazo.
inactive	Clientes que não possuem assinaturas/cobranças avulsas ativos.
withoutSubscriptionOrCharge	Clientes que não têm assinaturas/cobranças avulsas.

limit

int

Sim

Qtd máxima de registros para trazer.

order

string

Não

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

Caso queira passar mais de uma ordenação, separar por vírgula:
campoDaEntidade.tipoDeOrdem, campoDaEntidade2.tipoDeOrdem

Valor	Explicação
createdAt.asc	Cliente criado em - Ordem crescente
createdAt.desc	Cliente criado em - Ordem decrescente
updatedAt.asc	Cliente alterado em - Ordem crescente
updatedAt.desc	Cliente alterado em - Ordem decrescente

URL da Requisição

https://api.sandbox.cel.cash/v2/customers

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "totalQtdFoundInPage": 1,
    "Customers": [
        {
            "galaxPayId": 1,
            "myId": "pay-68d2fd8f4e33d5.20096899",
            "name": "Lorem ipsum dolor sit amet.",
            "document": "12899341340",
            "emails": [
                "[email protected]",
                "[email protected]"
            ],
            "phones": [
                3140201512,
                31983890110
            ],
            "status": "active",
            "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"
            }
        }
    ]
}

Nome

Tipo

Explicação

totalQtdFoundInPage

int 11 dígitos

Quantidade total de registros do retorno da busca na página atual.

Customers

Array de clientes
Clique para ver os campos.

galaxPayId

int 11 dígitos

Id no cel_cash

myId

string 255 caracteres

Id referente no seu sistema.

name

string 255 caracteres

Nome ou razão social do cliente.

document

string 14 caracteres

CPF OU CNPJ do cliente. Apenas números.

emails

array de string 255 caracteres

Emails do cliente.

phones

array de int 11 dígitos

Telefones do cliente.

status

string 255 caracteres

Status atual do cliente

Valor

Explicação

active

Clientes que possuem assinaturas/cobranças avulsas ativos.

delayed

Clientes que têm pelo menos 1 transação vencida com status de negada,em aberto ou decurso de prazo.

inactive

Clientes que não possuem assinaturas/cobranças avulsas ativos.

withoutSubscriptionOrCharge

Clientes que não têm assinaturas/cobranças avulsas.

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 8 caracteres

CEP

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 2 caracteres

Estado.

error

Nó de erros, caso haja.
Clique para ver os campos.

message

string 255 caracteres

Mensagem que indica qual o erro.

details

Objeto com detalhes sobre o erro, mostrando qual o campo referente e qual o erro.
Clique para ver os campos.

Entity.field

array de string

Array cuja chave é Entidade.campo onde deu o erro e cada valor é uma descrição sobre o problema.

Código

Explicação

200

Sucesso.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.

404

Nenhum cliente encontrado com os parâmetros utilizados.