Aprovações
Um pagamento pedido pela API pode esperar duas aprovações antes de sair: a da sua empresa, se ela tiver regra de aprovação, e a análise da plataforma. A API mostra em que etapa ele está; aprovar e recusar acontecem no painel.
As duas etapas
| Etapa | Quando | Status |
|---|---|---|
| Regra da empresa | Valor igual ou acima do teto que a empresa definiu para a moeda. | PENDING_APPROVAL |
| Análise da plataforma | Pagamento em BRL acima do teto de análise da plataforma. Acima de um segundo teto, dois operadores aprovam. | IN_REVIEW |
Quando as duas valem, a regra da empresa vem primeiro: aprovado, o pagamento passa para IN_REVIEW. Sem nenhuma, ele nasce QUEUED e segue para o envio.
A regra da empresa
- Fica no painel, em Pagar › Aprovações, uma por moeda: "pedir aprovação a partir de" um valor. Só o Proprietário muda, com o código do app autenticador.
- Quem aprova ou recusa: Proprietário, Administrador ou Financeiro, no painel, com o código do app autenticador.
- Quem pediu o pagamento nunca aprova o próprio pedido. Pedido pela API não tem pessoa: qualquer pessoa com acesso de aprovação decide.
A API não aprova nem recusa pagamentos. Se a sua operação precisa de aprovação, ela acontece no painel, por uma pessoa.
O que acontece com o saldo
Valor e tarifa saem do disponível quando o pedido é aceito, já em PENDING_APPROVAL ou IN_REVIEW: assim o mesmo saldo não paga duas vezes. Recusado, o pagamento fica REJECTED e valor e tarifa voltam ao disponível na hora.
Acompanhar pela API
Eventos
payout.createdsai no pedido, já com o status (PENDING_APPROVAL,IN_REVIEWouQUEUED).- Aprovar gera payout.approved com o status novo: IN_REVIEW (segue para a análise da plataforma) ou QUEUED (vai para o envio). Na análise com dois operadores, o evento sai na segunda aprovação.
- Recusar gera
payout.failedcomdata.statusREJECTEDe o motivo emdata.statusReason.
Consulta e cancelamento
GET /v1/payouts?status=PENDING_APPROVAL lista o que espera a empresa. Enquanto espera, quem pediu pode desistir com POST /v1/payouts/:id/cancel: o pagamento fica CANCELED e o saldo volta. Mais em Criar pagamento PIX.