Transações

Objeto Transação

Toda operação — cobrança PIX ou saque PIX — é representada pelo mesmo objeto, retornado pela API e enviado nos webhooks. Os blocos pix e checkout_url variam conforme o tipo.

Campos comuns

Campo	Tipo	Obrigatório	Descrição
`id`	string	Sim	Identificador único da transação.
`external_id`	string \| null	Sim	Seu identificador, se informado.
`type`	enum	Sim	`PIX_IN` (cobrança PIX) ou `PIX_OUT` (saque PIX).
`status`	enum	Sim	Status atual — veja Status.
`amount`	number	Sim	Valor bruto em reais.
`fee`	number	Sim	Taxa cobrada em reais.
`net_amount`	number	Sim	PIX_IN: valor líquido creditado (`amount − fee`). PIX_OUT: total debitado (`amount + fee`).
`description`	string \| null	Sim	Descrição informada.
`payer`	object \| null	Sim	Pagador da cobrança (PIX_IN). null quando não informado e nos saques.
`payer.name`	string \| null	Sim	Nome.
`payer.document`	string \| null	Sim	CPF/CNPJ somente dígitos.
`payer.email`	string \| null	Sim	E-mail.
`payment_link_id`	string	Não	Presente apenas em transações criadas pelo comprador em um link de pagamento: o `id` do link. Ausente nas demais.
`failure_reason`	string \| null	Sim	Motivo da falha ou do cancelamento de um saque.
`metadata`	object \| null	Sim	Metadados enviados na criação da cobrança (PIX_IN).
`paid_at`	string \| null	Sim	Quando a cobrança foi paga (PIX_IN) ou o saque liquidado (PIX_OUT).
`refunded_at`	string \| null	Sim	Reservado para devoluções; null nas operações atuais.
`created_at`	string	Sim	Data de criação (ISO 8601, UTC).
`updated_at`	string	Sim	Última atualização.

Somente PIX_IN

Campo	Tipo	Obrigatório	Descrição
`pix`	object	Sim	Dados da cobrança PIX.
`pix.txid`	string	Sim	Identificador da cobrança no PIX.
`pix.end_to_end_id`	string \| null	Sim	ID end-to-end do pagamento (após PAID).
`pix.qr_code`	string	Sim	BR Code copia e cola.
`pix.expires_at`	string	Sim	Expiração da cobrança.
`pix.qr_code_image`	string	Não	Data URL PNG do QR Code — apenas na resposta de criação.
`checkout_url`	string	Sim	Página de pagamento hospedada.

Somente PIX_OUT

Campo	Tipo	Obrigatório	Descrição
`pix`	object	Sim	Dados do saque.
`pix.key`	string	Sim	Chave de destino normalizada.
`pix.key_type`	enum	Sim	CPF, CNPJ, EMAIL, PHONE ou EVP.
`pix.end_to_end_id`	string \| null	Sim	ID end-to-end (após COMPLETED).

Exemplos

{
  "id": "cm2r8x1qz0004lk08abcd1234",
  "external_id": "pedido-1042",
  "type": "PIX_IN",
  "status": "PAID",
  "amount": 100,
  "fee": 1.75,
  "net_amount": 98.25,
  "description": "Pedido #1042",
  "pix": {
    "txid": "K7Q2M9X4T1B8N6R3W5Z0C2V7H",
    "end_to_end_id": "E00000000202610161432K8D2LQ7ZP1M",
    "qr_code": "00020101021226580014br.gov.bcb.pix013600000000-0000-0000-0000-0000000000005204000053039865406100.005802BR5912LOJA EXEMPLO6009SAO PAULO62290525K7Q2M9X4T1B8N6R3W5Z0C2V7H63040000",
    "expires_at": "2026-10-16T15:30:00.000Z"
  },
  "checkout_url": "https://reloadbank.app/pay/cm2r8x1qz0004lk08abcd1234",
  "payer": {
    "name": "Maria Silva",
    "document": "12345678909",
    "email": "[email protected]"
  },
  "failure_reason": null,
  "metadata": {
    "order_id": 1042,
    "channel": "site"
  },
  "paid_at": "2026-10-16T14:32:11.000Z",
  "refunded_at": null,
  "created_at": "2026-10-16T14:30:00.000Z",
  "updated_at": "2026-10-16T14:32:11.000Z"
}