Skip to content

Saques

Rotas sob /api/v1/integracao/produtores/{produtorId}/saques.

Método Path Uso
GET .../saques Listar (paginado)
POST .../saques Solicitar saque
POST .../saques/{saqueId}/cancelar Cancelar pendente

Body SolicitacaoSaqueRequest:

  • valor (obrigatório) — valor total em BRL
  • observacao — texto livre
  • distribuicao — lista opcional de { domicilioBancarioId, percentual }; a soma dos percentuais deve ser 100. Se omitida, usa o domicílio padrão.

Via integração, a antecipação aplica taxa fixa de 5%.

Envie o header opcional Idempotency-Key (UUID ou string única). Retentativas com a mesma chave não criam saques duplicados.

POST /api/v1/integracao/produtores/{produtorId}/saques
X-API-Key: ...
Idempotency-Key: a1b2c3d4-e5f6-7890-abcd-ef1234567890
Content-Type: application/json
{
"valor": 500.00,
"observacao": "Repasse quinzenal"
}

Somente solicitações ainda pendentes podem ser canceladas.

Schemas e status: referência da API.