OnnixPay

Pagamentos

O objeto Payout

Um pagamento (payout) representa uma transferência de saída a partir do saldo do Merchant, por PIX (instantâneo) ou TED (SPB). O dinheiro é reservado na criação e o status final chega por webhook.

Atributos

idstringopcional
Identificador único do pagamento (UUID).
objectstringopcional
Sempre "payout".
methodenumopcional
Trilho do pagamento: pix ou ted.
statusenumopcional
Um de pending, processing, completed, failed, reversed.
amountintegeropcional
Valor em centavos (R$ 50,00 = 5000).
currencystringopcional
Sempre "BRL" no MVP.
end_to_end_idstring | nullopcional
Identificador da transação na rede (E2E / SPB). Preenchido quando confirmada.
recipientobjectopcional
Dados do recebedor: name, document, bank_ispb, branch, account e pix_key (quando enviado por chave).
descriptionstring | nullopcional
Descrição exibível do pagamento.
referencestring | nullopcional
Seu identificador livre. Eco do que você enviou.
failure_reasonstring | nullopcional
Motivo da falha quando status = failed.
created_atstringopcional
Data/hora ISO 8601 de criação.
completed_atstring | nullopcional
Data/hora ISO 8601 da confirmação.
failed_atstring | nullopcional
Data/hora ISO 8601 da falha.

O saldo é debitado na criação

Ao criar um payout, o valor é reservado do saldo disponível imediatamente. Se a transferência falhar na rede, a reserva é devolvida e o status vira failed.
O objeto
{
  "id": "019e9045-8a9b-7f76-9017-297fcf4fd5cf",
  "object": "payout",
  "method": "pix",
  "status": "processing",
  "amount": 5000,
  "currency": "BRL",
  "end_to_end_id": null,
  "recipient": {
    "name": "Maria Souza",
    "document": "12345678909",
    "bank_ispb": "60701190",
    "branch": "0001",
    "account": "123456",
    "pix_key": "maria@exemplo.com"
  },
  "description": "Repasse de comissão",
  "reference": "saque-7781",
  "failure_reason": null,
  "created_at": "2026-06-04T01:35:37.115Z",
  "completed_at": null,
  "failed_at": null
}
AnteriorListar cobrançasPróximo Criar pagamento