Skip to content

Consulter Cash Out par ID

Consulte les details et le statut d'une transaction PIX par le transaction_id.

Endpoint

GET /api/external/transactions/:id

En-tetes

En-teteTypeObligatoireDescription
AuthorizationStringOuiApiKey {client_id}:{client_secret}

Path Parameters

ParametreTypeObligatoireDescription
idStringOuiID de la transaction (transaction_id)

Exemple

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

Reponse de Succes -- 200

json
{
  "worked": true,
  "data": {
    "id": "c7f3a8b1-2d4e-4f6a-9c1b-3e5f7a9b1d3e",
    "transaction_id": "PIXOUT20260309a1b2c3d4e5f6",
    "end_to_end_id": "E37839059202603091530abcdef01",
    "external_id": "order-9876",
    "type": "pix",
    "direction": "outbound",
    "status": "completed",
    "amount": 300000,
    "fee_amount": 350,
    "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"
  }
}

Champs de la Reponse

ChampTypeDescription
data.idStringUUID interne de la transaction
data.transaction_idStringIdentifiant unique de la transaction
data.end_to_end_idStringIdentifiant End-to-End dans le SPI/BACEN
data.external_idStringIdentifiant de votre systeme. null si non renseigne
data.typeStringType de la transaction (pix)
data.directionStringoutbound (cash-out) ou inbound (cash-in)
data.statusStringStatut actuel (voir tableau ci-dessous)
data.amountIntegerMontant en unites de base (/ 10 000 pour reais). 300000 = R$ 30,00
data.fee_amountIntegerFrais factures en unites de base
data.net_amountIntegerMontant net en unites de base
data.descriptionStringDescription renseignee lors de la creation
data.counterparty_nameStringNom de la contrepartie (payeur ou beneficiaire)
data.recipient_keyStringCle PIX du destinataire (uniquement pour les envois)
data.created_atStringDate de creation (ISO 8601)
data.completed_atStringDate de conclusion (ISO 8601), null si en attente

Statut de la Transaction

StatutDescription
pending_approvalEn attente d'approbation (flux creer + approuver)
processingEnvoyee au SPI, en attente de liquidation
completedLiquidee avec succes
failedRejetee par le SPI ou erreur de traitement
refundedRemboursee (totalement ou partiellement)

Reponse d'Erreur -- 404

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

Owem Pay Instituição de Pagamento — ISPB 37839059