Skip to content

Links de pagamento

Rotas sob /api/v1/integracao/produtores/{produtorId}/links-pagamento.

Método Path Uso
POST .../links-pagamento Criar link
GET .../links-pagamento Listar (paginado)
GET .../links-pagamento/{linkId} Detalhar (inclui URL pública)

Body PaymentLinkCreateRequest:

  • amount / description — valor e texto exibidos ao pagador
  • chargeConvenienceFeeToClient — se a taxa de conveniência entra no total do cliente
  • mode — modo de uso (UNICO / MULTIPLO). Na integração, se omitido no fluxo efetivo, assume MULTIPLO
  • paymentDeadlineMinutes — prazo (1–360) para concluir o pagamento após abrir o link
  • maxUses — limite de usos no modo múltiplo (omitir = ilimitado até expirar)
  • expiresAt — expiração ISO-8601 (opcional)

A resposta inclui token, url pública, taxas, usos e status.

A listagem usa os mesmos parâmetros de paginação (page, size, sort). O detalhe devolve a URL completa para compartilhar com o pagador.

Valores recebidos via link entram no saldo conforme as regras de liberação do produtor.

Contrato completo: referência da API.