NTX Paydocs

Query transaction by PIX key and identifier

GET /api/pix/transactions/pix-key/{pixKey}/{identifier}

Returns a specific transaction associated with a PIX key, searched by the provided identifier.

Identifier resolution logic: The provided value is simultaneously compared against endToEndId (PIX e2eId), externalId, and numeric id. In practice there is no ambiguity: each type has a unique format (e2eId starts with E + 32 alphanumeric chars; id is purely numeric; externalId is any other string).

Authentication

Requires a Bearer token in the Authorization header.

Path Parameters

ParameterTypeRequiredDescription
pixKeystringYesPIX key (CPF, CNPJ, phone, email, or random EVP key)
identifierstringYesTransaction identifier: compared against endToEndId, externalId, or numeric id

Response (200)

{
  "transactionId": "12345",
  "externalId": "ext-123456",
  "status": "Confirmado",
  "operationType": "Pix in",
  "movementType": "CREDIT",
  "originalAmount": 100.00,
  "feeAmount": 1.00,
  "finalAmount": 99.00,
  "endToEndId": "E12345678901234567890123456789012",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "processedAt": "2025-01-15T10:30:05.000Z",
  "counterpart": {
    "name": "João Silva",
    "document": "***.456.789-**",
    "bank": {
      "bankISPB": "00000000",
      "bankName": "Banco do Brasil",
      "bankCode": "001",
      "accountBranch": "0001",
      "accountNumber": "123456-7"
    }
  }
}

Errors

StatusDescription
401Missing or invalid token
404Transaction not found for the provided PIX key and identifier

On this page