> ## 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. # Solicitar antecipação > Antecipa recebíveis de cartão ainda em carência, transformando-os em saldo disponível mediante taxa. A `idempotencyKey` é obrigatória: reenviar a mesma chave devolve a antecipação já criada em vez de antecipar duas vezes e cobrar duas taxas — é o que protege você ao repetir a chamada depois de um 429, de um 5xx ou de um timeout de rede. Responde 400 quando o valor passa do limite antecipável da empresa, quando a adquirente configurada não oferece antecipação, ou quando a chave já foi usada com outro valor. Conforme a configuração da conta, a antecipação pode nascer aguardando análise. ## OpenAPI ````yaml /openapi.yaml post /v1/anticipations 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: post: tags: - Financeiro summary: Solicitar antecipação description: >- Antecipa recebíveis de cartão ainda em carência, transformando-os em saldo disponível mediante taxa. A `idempotencyKey` é obrigatória: reenviar a mesma chave devolve a antecipação já criada em vez de antecipar duas vezes e cobrar duas taxas — é o que protege você ao repetir a chamada depois de um 429, de um 5xx ou de um timeout de rede. Responde 400 quando o valor passa do limite antecipável da empresa, quando a adquirente configurada não oferece antecipação, ou quando a chave já foi usada com outro valor. Conforme a configuração da conta, a antecipação pode nascer aguardando análise. operationId: requestAnticipation requestBody: required: true content: application/json: schema: type: object properties: amount: type: integer exclusiveMinimum: true minimum: 0 description: Valor bruto a antecipar, em centavos (R$ 2.000,00 = 200000). idempotencyKey: type: string minLength: 1 maxLength: 255 description: >- Chave única desta solicitação. Um reenvio com a mesma chave devolve a antecipação já criada, sem antecipar nem cobrar taxa de novo. automaticTransfer: type: boolean default: true description: >- `true` credita o líquido no saldo assim que a adquirente liquidar. required: - amount - idempotencyKey additionalProperties: false example: amount: 200000 idempotencyKey: antecipacao-2026-09-12-001 automaticTransfer: true responses: '201': description: Antecipação solicitada. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: object properties: id: type: string description: Identificador da antecipação criada. externalId: type: string nullable: true description: Identificador da antecipação na adquirente. amount: type: integer description: Valor bruto antecipado, em centavos. fee: type: integer description: Taxa descontada do crédito, em centavos. status: type: string description: Situação inicial da antecipação. pendingApproval: type: boolean description: >- `true` quando a antecipação ficou aguardando análise da plataforma. required: - id - externalId - amount - fee - status - pendingApproval additionalProperties: false required: - success - data additionalProperties: false description: Antecipação solicitada. example: success: true data: id: clx9m4r8v0003qz0a2b3c4d5e externalId: ancp_9182736455 amount: 200000 fee: 7200 status: pending_approval pendingApproval: true '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 ````