Saques
Visão geral
Section titled “Visão geral”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 |
Solicitar saque
Section titled “Solicitar saque”Body SolicitacaoSaqueRequest:
valor(obrigatório) — valor total em BRLobservacao— texto livredistribuicao— lista opcional de{ domicilioBancarioId, percentual }; a soma dos percentuais deve ser100. Se omitida, usa o domicílio padrão.
Via integração, a antecipação aplica taxa fixa de 5%.
Idempotência
Section titled “Idempotência”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}/saquesX-API-Key: ...Idempotency-Key: a1b2c3d4-e5f6-7890-abcd-ef1234567890Content-Type: application/json
{ "valor": 500.00, "observacao": "Repasse quinzenal"}Cancelamento
Section titled “Cancelamento”Somente solicitações ainda pendentes podem ser canceladas.
Referência
Section titled “Referência”Schemas e status: referência da API.