Pular para o conteúdo principal
Use Pix Out quando sua plataforma envia dinheiro para fornecedores, sellers ou recipientes internos de payout.

​
Operações públicas

  • POST /v2/transfers
  • GET /v2/transfers
  • GET /v2/transfers/{id}
  • POST /v2/transfers/{id}/cancel

​
Modelo operacional

  1. Crie a transferência pelo seu back-end.
  2. Persista sua referência de payout, o ID da transferência na Pagou e o requestId.
  3. Trate a entrega de webhook como caminho principal de atualização de estado.
  4. Reconcilie com GET /v2/transfers/{id} quando o estado estiver incerto.
  5. Permita cancelamento apenas em estados que sua operação possa interromper com segurança.

​
Vocabulário de status

Use o status do recurso da API para estado de payout e nomes de evento de webhook para transições.
  • Status do recurso: pending, scheduled, in_analysis, processing, paid, rejected, cancelled, error, unknown
  • Eventos de webhook: payout.created, payout.in_analysis, payout.processing, payout.transferred, payout.failed, payout.rejected, payout.canceled

​
Leia a seguir