Comprovante Cash Out

Obtem o comprovante de uma transacao PIX em formato estruturado, com dados formatados para exibicao ao usuario final.

Endpoint

GET /api/external/transactions/:id/receipt

Headers

Header	Tipo	Obrigatorio	Descricao
Authorization	String	Sim	ApiKey {client_id}:{client_secret}

Path Parameters

Parametro	Tipo	Obrigatorio	Descricao
id	String	Sim	ID da transacao (transaction_id)

Disponibilidade

O comprovante so esta disponivel para transacoes com status completed. Transacoes em processamento ou com falha retornam erro 422.

Exemplo

curl -X GET https://api.owem.com.br/api/external/transactions/PIXOUT20260309a1b2c3d4e5f6/receipt \
  -H "Authorization: ApiKey $CLIENT_ID:$CLIENT_SECRET"

Resposta de Sucesso -- 200

{
  "worked": true,
  "receipt": {
    "transaction_id": "PIXOUT20260309a1b2c3d4e5f6",
    "end_to_end_id": "E37839059202603091530abcdef01",
    "external_id": "order-9876",
    "type": "pix",
    "direction": "outbound",
    "status": "completed",
    "amount": 300000,
    "amount_formatted": "R$ 30,00",
    "fee_amount": 350,
    "fee_formatted": "R$ 0,035",
    "net_amount": 300350,
    "description": "Pagamento fornecedor",
    "counterparty_name": "Joao Silva",
    "recipient_key": "12345678901",
    "created_at": "2026-03-09T15:30:00Z",
    "completed_at": "2026-03-09T15:30:02Z",
    "institution": {
      "name": "Owem Pay",
      "cnpj": "37.839.059/0001-88",
      "ispb": "37839059"
    }
  }
}

Campos do Comprovante

Campo	Tipo	Descricao
receipt.transaction_id	String	Identificador unico da transacao
receipt.end_to_end_id	String	Identificador End-to-End no SPI/BACEN
receipt.external_id	String	Identificador do seu sistema. null se nao informado
receipt.type	String	Tipo da transacao (pix)
receipt.direction	String	outbound (cash-out) ou inbound (cash-in)
receipt.status	String	Status: completed
receipt.amount	Integer	Valor em unidades base (÷ 10.000 para reais). 300000 = R$ 30,00
receipt.amount_formatted	String	Valor formatado em reais (R$ 30,00)
receipt.fee_amount	Integer	Tarifa em unidades base
receipt.fee_formatted	String	Tarifa formatada em reais
receipt.net_amount	Integer	Valor liquido em unidades base
receipt.description	String	Descricao da transferencia
receipt.counterparty_name	String	Nome da contraparte
receipt.recipient_key	String	Chave PIX do destinatario (apenas saidas)
receipt.created_at	String	Data de criacao (ISO 8601)
receipt.completed_at	String	Data de conclusao (ISO 8601)
receipt.institution	Object	Dados da instituicao emissora
receipt.institution.name	String	Nome da instituicao
receipt.institution.cnpj	String	CNPJ formatado
receipt.institution.ispb	String	Codigo ISPB no BACEN

Campos formatados

O comprovante inclui campos _formatted com valores ja convertidos para reais (ex: R$ 30,00). Use estes campos para exibicao ao usuario. Use os campos numericos (amount, fee_amount, net_amount) para calculos.

Resposta de Erro -- 404

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

Resposta de Erro -- 422

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