Eventos · Transferências

Transferências

Envios PIX de saída (transfer out) iniciados pela conta. Use para conciliação, contabilidade e status de pagamento a terceiros.

Eventos disponíveis para inscrição na API de webhooks. O objeto segue o mesmo envelope v2; a chave PIX chega mascarada por segurança.

Eventos

EventoQuandoUso
transfer.createdTransferência criada / enfileiradaRegistrar no ERP
transfer.paidLiquidada no gatewayConfirmar pagamento ao destinatário
transfer.failedFalha no processamentoRetry / alerta

Objeto transfer

CampoTipoDescrição
idstringUUID
codestringCódigo tr_…
statusstringpending | paid | failed
amount_centsnumberValor em centavos
kindstringpix_out, …
destination_pix_key_maskedstring | nullChave mascarada
destination_pix_key_typestring | nullCPF, EMAIL, PHONE…
failure_reasonstring | nullMotivo se failed
end_to_end_idstring | nullID end-to-end PIX

Exemplo de payload

{
  "id": "evt_…",
  "type": "transfer.paid",
  "api_version": "v2",
  "created": 1710000000,
  "created_at": "2026-03-09T12:00:00.000Z",
  "livemode": true,
  "data": {
    "object": {
      "id": "uuid-transferencia",
      "code": "tr_…",
      "status": "paid",
      "amount_cents": 15000,
      "amount_label": "R$ 150,00",
      "currency": "BRL",
      "kind": "pix_out",
      "destination_pix_key_masked": "ab…1234",
      "destination_pix_key_type": "EMAIL",
      "failure_reason": null,
      "created_at": "…",
      "paid_at": "…",
      "end_to_end_id": "E…"
    }
  },
  "source": "hyzepay"
}

Diferença vs saque

Transferência = envio para um destinatário (PIX out genérico). Saque (withdrawal.*) = liquidação do saldo do merchant para a chave PIX cadastrada na conta. Veja a aba Saques.