Listar Simulações de Antecipação

GET /antecipation/simulate/get-by-filters

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

O endpoint retorna as simulações feitas pela empresa de acordo com os filtros escolhidos.

Dados da requisição

Você pode alterar todos os dados abaixo do registro ou apenas o campo que desejar.
Apenas os campos enviados serão validados.

Nome

Tipo

Obrigatório

Explicação

limit

int

Sim

Quantidade de dados retornados

startAt

int

Não O campo se torna obrigatório na busca caso o parâmetro "page" não for informado.

A partir de que posição da query irá pegar os dados

done

string

Não

Campo para verificar se esta antecipação já foi realizada.

page

int

Não

página atual da paginação

createdAtFrom

date

Não

Data de criação inicial

createdAtTo

date

Não

Até que data foi criada a simulação

URL da Requisição

https://api.sandbox.cel.cash/v2/antecipation/simulate/get-by-filters

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "totalQtdFoundInPage": 1,
    "Antecipation": [
        {
            "galaxPayId": 1,
            "companyGalaxPayId": 16966,
            "transactionsGalaxPayIds": "761,760,764",
            "totalValue": 1912,
            "totalMdr": 62,
            "averageDays": 16,
            "totalAntecipateTax": 30,
            "netValue": 1819,
            "cet": 93,
            "uuid": "d9c66552-03aa-41c5-a443-cfedd8212847",
            "done": "F",
            "createdAtTo": "2024-05-19",
            "createdAtFrom": "2024-05-19"
        }
    ]
}

Nome

Tipo

Explicação

totalQtdFoundInPage

int

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

Antecipation

Array de simulações de antecipação
Clique para ver os campos.

galaxPayId

int 11 dígitos

Id cel_cash da empresa

companyGalaxPayId

int 11 dígitos

Id da empresa.

transactionsGalaxPayIds

string

Transações a serem antecipadas.

totalValue

int

Valor total das transações.

totalMdr

int

Valor total das taxas.

averageDays

int 32 dígitos

Média em dias das transações que serão antecipadas.

totalAntecipateTax

int

Valor total da taxa de antecipação.

netValue

int

Valor das transações - Cet

cet

int

Custo Efetivo Total. A soma de todas as taxas juntas.

uuid

string

Id gerado aleatoriamente para realizar a antecipação.

done

string 1 caracteres

Campo para verificar se esta antecipação já foi realizada.

createdAtTo

date

Até que data foi criada a simulação

createdAtFrom

date

Data de criação inicial

Código

Explicação

200

Sucesso.

400

Erros de validação.

401

Falha ao autenticar

403

Validação de segurança