---
title: "Simular antecipação"
method: POST
path: "/v2/anticipation/simulate"
---

# Simular antecipação

`POST /v2/anticipation/simulate`

Esse endpoint permite a simulação de uma antecipação dos valores disponíveis.

## Request body

- object
  - `PaymentStartDate` string, date, required — Data de pagamento inicial das transações. Ex 2021-07-23
  - `PaymentEndDate` string, date, required — Data de pagamento final das transações. Ex 2025-10-23

## Response `200`

- object
  - `ResponseDetail` object, required — Objeto com os detalhes do response
    - `TotalAmount` number, float, required — Limite total bruto disponível para antecipação, é o valor calculado de acordo com nossa política interna e pode ser inalcançável de acordo com o valor de cada um dos seus recebíveis
    - `TotalAmountNet` number, float, required — Limite total líquido disponível para antecipação, descontado a taxa de antecipação, é o valor calculado de acordo com nossa pollítica interna e pode ser inalcançável de acordo com o valor de cada um dos seus recebíveis
    - `AmountReceivables` number, float, required — Valor total bruto filtrado dos recebíveis futuros
    - `AmountNetReceivables` number, float, required — Valor total líquido filtrado de recebíveis futuros
    - `Tax` number, float, required — Valor da taxa de antecipação, a taxa é em percentual e ao mês
    - `ExpectedPaymentDate` string, date, required — Data da liquidação/repasse da antecipação
    - `GroupedListByDate` object[] — Array de recebíveis futuros agrupados por dia
      - `ReleaseDate` string, date, required — Data original de pagamento das transações/recebíveis futuros (sem antecipação).
      - `TotalDayAmountNet` number, float, required — Valor total líquido de recebíveis do dia.
      - `TotalDayAmount` number, float, required — Valor total bruto de recebíveis do dia.
      - `TotalDayTax` number, float, required — Valor total de taxas descontadas do dia.
      - `NumberCheckingAccounts` string, required — Número de transações/recebíveis disponivel no dia.
    - `SessionGuid` string, required — Código único que identifica a simulação de antececipação
    - `MerchantsWithTheSameIdentityButWithNegativeBalance` object[] — No caso de existir outras contas/Merchants com mesmo documento (CNPJ/CPF) e algum dessas contas/Merchants estarem com saldo negativo, será mostrado o array destas outras contas/Merchants
      - `IdMerchant` integer, required — Id da conta/Merchant com saldo negativo
      - `Document` string, required — CPF/CNPJ da conta/Merchant
      - `Name` string, required — Nome do Merchant
      - `Brand` object, required — Bandeira
        - `Id` number, required — Id da bandeira
        - `Code` number, required — Código da bandeira
        - `Name` string, required — Nome da bandeira
  - `HasError` object — Indica se ocorreu erro na simulação de antecipação

---

[API](https://skmtc.net/safe2pay/apis/payment.md) · [All operations](https://skmtc.net/safe2pay/apis/payment/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/safe2pay/payment/versions/8efee77775ac/schema)