Skip to main content
Use Pix Out when your platform sends money to suppliers, sellers, or other payout recipients.

​
Public operations

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

​
Operating model

  1. Create the transfer from your backend.
  2. Persist your payout reference, Pagou transfer ID, and requestId.
  3. Treat webhook delivery as the primary state update path.
  4. Reconcile with GET /v2/transfers/{id} when the state is uncertain.
  5. Allow cancellation only from states your operators can safely stop.

​
Status vocabulary

Use API resource status for payout state and webhook event names for transitions.
  • Resource statuses: pending, scheduled, in_analysis, processing, paid, rejected, cancelled, error, unknown
  • Webhook events: payout.created, payout.in_analysis, payout.processing, payout.transferred, payout.failed, payout.rejected, payout.canceled
rejected means the banking partner cancelled the payout after submission, and the funds are not returned to your balance automatically. cancelled means the payout was stopped before execution or reversed afterwards; a stopped payout returns the funds, a reversal may not. Check your balance before re-sending or closing a payout.

​
Runnable examples

See working, testable code for this flow in the Transfers examples — runnable in seven languages against the sandbox.