Comprovante Cash Out

Obtém o comprovante de uma transação PIX em formato estruturado, com dados formatados para exibição ao usuário final.

Endpoint

GET /api/v2/external/transactions/{id}/receipt

Headers

Header	Tipo	Obrigatório	Descrição
Authorization	String	Sim	Bearer {access_token}

Path Parameters

Parâmetro	Tipo	Obrigatório	Descrição
id	String	Sim	ID da transação (transaction_id)

Disponibilidade

O comprovante só está disponível para transações com status completed. Transações em processamento ou com falha retornam erro 422.

Exemplo

curl -X GET https://api.owem.com.br/api/v2/external/transactions/PIXOUT20260309a1b2c3d4e5f6/receipt \
  -H "Authorization: Bearer $TOKEN"

Resposta de Sucesso — 200

{
  "worked": true,
  "receipt": {
    "transaction_id": "PIXOUT20260309a1b2c3d4e5f6",
    "end_to_end_id": "E37839059202603091530abcdef01",
    "authentication_code": "A3B7C9D1E5F2",
    "type": "pix",
    "direction": "outbound",
    "status": "completed",
    "amount": 10000,
    "amount_formatted": "R$ 100,00",
    "fee": 0,
    "fee_formatted": "R$ 0,00",
    "description": "Pagamento fornecedor",
    "payer_name": "Empresa Exemplo LTDA",
    "payer_document": "12.345.678/0001-99",
    "payer_ispb": "37839059",
    "payer_institution": "Owem Pay",
    "payee_name": "Joao Silva",
    "payee_document": "***456789**",
    "payee_ispb": "00000000",
    "payee_institution": "Banco Destino",
    "date_formatted": "09/03/2026 15:30:02",
    "institution": {
      "name": "Owem Pay",
      "cnpj": "37.839.059/0001-88",
      "ispb": "37839059"
    }
  }
}

Campos do Comprovante

Campo	Tipo	Descrição
receipt.transaction_id	String	Identificador único da transação
receipt.end_to_end_id	String	Identificador End-to-End no SPI/BACEN
receipt.authentication_code	String	Código de autenticação do comprovante
receipt.type	String	Tipo da transação (pix)
receipt.direction	String	Direção: outbound (cash-out)
receipt.status	String	Status: completed
receipt.amount	Integer	Valor em centavos
receipt.amount_formatted	String	Valor formatado em reais (BRL)
receipt.fee	Integer	Tarifa em centavos
receipt.fee_formatted	String	Tarifa formatada em reais (BRL)
receipt.description	String	Descrição da transferência
receipt.payer_name	String	Nome do pagador
receipt.payer_document	String	CPF/CNPJ do pagador (formatado)
receipt.payer_ispb	String	ISPB da instituição do pagador
receipt.payer_institution	String	Nome da instituição do pagador
receipt.payee_name	String	Nome do recebedor
receipt.payee_document	String	CPF/CNPJ do recebedor (mascarado)
receipt.payee_ispb	String	ISPB da instituição do recebedor
receipt.payee_institution	String	Nome da instituição do recebedor
receipt.date_formatted	String	Data/hora da liquidação (DD/MM/YYYY HH:mm:ss)
receipt.institution	Object	Dados da instituição emissora
receipt.institution.name	String	Nome da instituição
receipt.institution.cnpj	String	CNPJ formatado
receipt.institution.ispb	String	Código ISPB no BACEN

Resposta de Erro — 404

{
  "worked": false,
  "detail": "Transacao nao encontrada"
}

Resposta de Erro — 422

{
  "worked": false,
  "detail": "Comprovante disponivel apenas para transacoes concluidas"
}