Skip to content

Cash Out Receipt

Retrieves the receipt for a PIX transaction in structured format, with data formatted for display to end users.

Endpoint

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

Headers

HeaderTypeRequiredDescription
AuthorizationStringYesApiKey {client_id}:{client_secret}

Path Parameters

ParameterTypeRequiredDescription
idStringYesTransaction ID (transaction_id)

Availability

The receipt is only available for transactions with status completed. Transactions in processing or failed state return error 422.

Example

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

Success Response -- 200

json
{
  "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": "Supplier payment",
    "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"
    }
  }
}

Receipt Fields

FieldTypeDescription
receipt.transaction_idStringUnique transaction identifier
receipt.end_to_end_idStringEnd-to-End identifier in SPI/BACEN
receipt.external_idStringYour system identifier. null if not provided
receipt.typeStringTransaction type (pix)
receipt.directionStringoutbound (cash-out) or inbound (cash-in)
receipt.statusStringStatus: completed
receipt.amountIntegerValue in base units (/ 10,000 for BRL). 300000 = R$ 30.00
receipt.amount_formattedStringFormatted amount in BRL (R$ 30,00)
receipt.fee_amountIntegerFee in base units
receipt.fee_formattedStringFormatted fee in BRL
receipt.net_amountIntegerNet value in base units
receipt.descriptionStringTransfer description
receipt.counterparty_nameStringCounterparty name
receipt.recipient_keyStringRecipient PIX key (outbound only)
receipt.created_atStringCreation date (ISO 8601)
receipt.completed_atStringCompletion date (ISO 8601)
receipt.institutionObjectIssuing institution data
receipt.institution.nameStringInstitution name
receipt.institution.cnpjStringFormatted CNPJ
receipt.institution.ispbStringBACEN ISPB code

Formatted fields

The receipt includes _formatted fields with values already converted to BRL (e.g., R$ 30,00). Use these for display. Use the numeric fields (amount, fee_amount, net_amount) for calculations.

Error Response -- 404

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

Error Response -- 422

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

Owem Pay Instituição de Pagamento — ISPB 37839059