Simular Antecipação
POST /antecipation/simulate
Para utilizar esse método, o access_token deve conter o scope antecipation.write
Simula a antecipação dos recebíveis.
URL da Requisição
https://api.sandbox.cel.cash/v2/antecipation/simulate
Body da requisição
Código da resposta
---
Tempo de resposta
---
Body da Resposta
{
"type": true,
"Antecipation": {
"galaxPayId": 34,
"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",
"createdAt": "2024-05-20",
"updatedAt": "2024-05-20"
},
"Releases": [
{
"galaxPayId": 68884668,
"transactionGalaxPayId": 761,
"createdAt": "2024-05-20",
"installment": 1,
"netValue": 402,
"grossValue": 415,
"expectedDate": "2024-05-20",
"daysAntecipation": 16,
"netValueAfterAntecipation": 395,
"taxValueAntecipation": 6
}
],
"OperationSummary": {
"grossTotal": 1912,
"mdr": 1850,
"mdrTax": 62,
"averageDays": 16,
"finalTax": 30,
"cet": 93,
"netValue": 1819
}
}
Nome
Tipo
Explicação
type
bool
Simulação foi realizada com sucesso.
Antecipation
Objeto de antecipação.
Clique para ver os campos.
Clique para ver os campos.
galaxPayId
int 32 dígitos
Id da antecipação.
companyGalaxPayId
int 32 dígitos
Id da empresa.
transactionsGalaxPayIds
string 255 caracteres
Transações a serem antecipadas.
totalValue
int 32 dígitos
Valor total das transações.
totalMdr
int 32 dígitos
Valor total das taxas.
averageDays
int 32 dígitos
Média em dias das datas das transações que serão liquidadas.
totalAntecipateTax
int 32 dígitos
Valor total da taxa de antecipação.
netValue
int 32 dígitos
Valor líquido das transações.
cet
int 32 dígitos
Custo Efetivo Total. A soma de todas as taxas juntas.
uuid
string 255 caracteres
Id gerado aleatoriamente para realizar a antecipação.
done
string 255 caracteres
Campo para verificar se esta antecipação já foi realizada.
createdAt
date
Data de criação da antecipação.
updatedAt
date
Data de atualização da antecipação.
Releases
Array dos recebíveis.
Clique para ver os campos.
Clique para ver os campos.
galaxPayId
int 32 dígitos
Id do recebível.
transactionGalaxPayId
int 32 dígitos
Id da transação.
createdAt
date
Data de criação do recebível.
installment
int 32 dígitos
Número da parcela.
netValue
int 32 dígitos
Valor líquido do recebível.
grossValue
int 32 dígitos
Valor bruto do recebível.
expectedDate
date
Data esperada de liquidação.
daysAntecipation
int 32 dígitos
Dias até a liquidação.
netValueAfterAntecipation
int 32 dígitos
Valor líquido após a antecipação.
taxValueAntecipation
int 32 dígitos
Valor da taxa de antecipação.
OperationSummary
Objeto do cálculo de antecipação.
Clique para ver os campos.
Clique para ver os campos.
grossTotal
int 32 dígitos
Valor total das transações sem taxas.
mdr
int 32 dígitos
Valor das transações - taxas
mdrTax
int 32 dígitos
Valor das taxas.
averageDays
int 32 dígitos
Média em dias das transações que serão antecipadas.
finalTax
int 32 dígitos
Valor da taxa de antecipação.
cet
int 32 dígitos
Custo Efetivo Total. A soma de todas as taxas juntas.
netValue
int 32 dígitos
Valor das transações - Cet
Código
Explicação
200
Sucesso.
400
Erros de validação.
401
Falha ao autenticar.
403
Validação de segurança.