> ## Documentation Index > Fetch the complete documentation index at: https://docs.ephra.io/llms.txt > Use this file to discover all available pages before exploring further. # Consultar antecipação disponível > Devolve quanto dos recebíveis de cartão da empresa autenticada pode virar saldo disponível hoje, o que ainda está em carência e em que dias libera. Informe `amount` para receber também a taxa e o valor líquido simulados daquele valor antes de solicitar a antecipação. ## OpenAPI ````yaml /openapi.yaml get /v1/anticipations/summary openapi: 3.0.3 info: title: Ephra API description: >- API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks e a API do vendedor sobre catálogo, checkout, vendas, reembolsos, financeiro, crescimento e plataforma. **Limite de requisições.** 1000 requisições por minuto por IP de origem. Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a resposta é `429` com `retry-after`. **Erros.** Toda falha responde o mesmo envelope: `{ "success": false, "message": "..." }`. version: 1.0.0 servers: - url: https://api.ephra.io description: Servidor de produção security: [] tags: - name: Catálogo description: Produtos, ofertas, categorias e cupons — o que a empresa vende. - name: Checkout description: Checkouts, order bumps, upsells e links de pagamento. - name: Vendas description: Vendas, clientes, assinaturas e entregas já realizadas. - name: Reembolsos description: Pedidos de reembolso, contestações e o quiz de retenção. - name: Financeiro description: Saldo, saques, antecipações, taxas e extratos da empresa. - name: Crescimento description: Afiliados, coprodução, indicações, pixels e integrações de marketing. - name: Plataforma description: Conta, membros, chaves de API, webhooks e configurações gerais. paths: /v1/anticipations/summary: get: tags: - Financeiro summary: Consultar antecipação disponível description: >- Devolve quanto dos recebíveis de cartão da empresa autenticada pode virar saldo disponível hoje, o que ainda está em carência e em que dias libera. Informe `amount` para receber também a taxa e o valor líquido simulados daquele valor antes de solicitar a antecipação. operationId: getAnticipationSummary parameters: - schema: type: integer exclusiveMinimum: true minimum: 0 in: query name: amount required: false description: Valor em centavos para simular taxa e líquido antes de solicitar. responses: '200': description: Limites de antecipação da empresa. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: object properties: availableToAnticipate: type: integer description: >- Quanto a empresa pode antecipar agora, em centavos, já respeitando o limite da adquirente. maxAnticipatableAmount: type: integer description: >- Teto da plataforma sobre o volume liberado, em centavos, antes do limite da adquirente. volumeInAnticipation: type: integer description: >- Recebíveis ainda em carência — o card "A liberar" —, em centavos. alreadyAnticipated: type: integer description: Volume já comprometido em antecipações, em centavos. reservedAmount: type: integer description: >- Reserva financeira retida — o card "Em retenção" —, em centavos. anticipatablePercentage: type: number description: >- Percentual do volume liberado que a empresa pode antecipar. mode: type: string enum: - automatic - pending_analysis description: >- `automatic` aprova na hora; `pending_analysis` manda para análise. releaseSchedule: type: array items: type: object properties: date: type: string description: Dia de liberação, em `YYYY-MM-DD`. amount: type: integer description: >- Valor que sai da carência nesse dia, em centavos. required: - date - amount additionalProperties: false description: Quanto sai da carência em cada dia. simulation: type: object properties: amount: type: integer description: Valor bruto simulado, em centavos. fee: type: integer description: >- Taxa da adquirente sobre a antecipação, em centavos. anticipationFee: type: integer description: >- Taxa de antecipação cobrada pela plataforma, em centavos. netAmount: type: integer description: >- Valor líquido que cairia no saldo disponível, em centavos. paymentDate: type: string nullable: true description: >- Data prevista do crédito, quando a adquirente informa. required: - amount - fee - anticipationFee - netAmount - paymentDate additionalProperties: false nullable: true description: >- Simulação do valor pedido em `amount`; `null` quando `amount` não foi informado. required: - availableToAnticipate - maxAnticipatableAmount - volumeInAnticipation - alreadyAnticipated - reservedAmount - anticipatablePercentage - mode - releaseSchedule - simulation additionalProperties: false required: - success - data additionalProperties: false description: Limites de antecipação da empresa. example: success: true data: availableToAnticipate: 840000 maxAnticipatableAmount: 840000 volumeInAnticipation: 3907100 alreadyAnticipated: 200000 reservedAmount: 152900 anticipatablePercentage: 100 mode: pending_analysis releaseSchedule: - date: '2026-09-15T00:00:00.000Z' amount: 1280000 - date: '2026-09-22T00:00:00.000Z' amount: 1315600 simulation: null '400': description: A requisição está bem formada, mas uma regra de negócio a recusou. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- A requisição está bem formada, mas uma regra de negócio a recusou. example: success: false message: >- Não foi possível concluir: uma regra de negócio recusou os dados enviados. '401': description: Token ausente, inválido, expirado ou de empresa bloqueada. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: Token ausente, inválido, expirado ou de empresa bloqueada. example: success: false message: Token inválido ou expirado '422': description: A requisição não passou na validação de schema. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: A requisição não passou na validação de schema. example: success: false message: 'name: Nome é obrigatório' '429': description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. example: success: false message: Muitas requisições. Tente novamente em breve. headers: retry-after: $ref: '#/components/headers/retry-after' x-ratelimit-limit: $ref: '#/components/headers/x-ratelimit-limit' x-ratelimit-remaining: $ref: '#/components/headers/x-ratelimit-remaining' x-ratelimit-reset: $ref: '#/components/headers/x-ratelimit-reset' '500': description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. example: success: false message: Erro interno do servidor security: - bearerAuth: [] components: headers: retry-after: description: Segundos a esperar antes de repetir a requisição. schema: type: integer x-ratelimit-limit: description: Teto de requisições na janela (1000). Presente em toda resposta. schema: type: integer x-ratelimit-remaining: description: >- Quantas requisições ainda cabem na janela atual. Presente em toda resposta. schema: type: integer x-ratelimit-reset: description: Segundos até o contador da janela zerar. Presente em toda resposta. schema: type: integer securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````