> ## Documentation Index
> Fetch the complete documentation index at: https://docs-finance.superpagamentos.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar transferência

> Consulte o status e os dados de uma transferência pela chave de idempotência.

<Info>
  Essa rota utiliza os certificados e o Bearer Token de **Cash Out**.
</Info>

## Certificados

Esta rota usa autenticação mútua (mTLS). Envie o certificado de **Cash Out**, a chave e a senha na requisição:

<ParamField path="--cert" type="file" required>
  Certificado de Cash Out do cliente (`client.crt`).
</ParamField>

<ParamField path="--key" type="file" required>
  Chave privada do cliente (`client.key`).
</ParamField>

<ParamField path="--pass" type="string" required>
  Senha para descriptografar a chave `.key`, enviada por e-mail junto com os certificados.
</ParamField>

## Headers

<ParamField header="Authorization" type="string" required>
  Bearer Token de Cash Out. Formato: `Bearer {access_token}`.
</ParamField>

## Path

<ParamField path="idempotencyKey" type="string" required>
  Chave de idempotência usada ao criar a transferência.
</ParamField>

## Resposta

<ResponseField name="id" type="string">
  Identificador da transferência na Super Finance.
</ResponseField>

<ResponseField name="status" type="string">
  Status da transferência. Exemplos: `PROCESSING`, `SETTLED`, `REJECTED`.
</ResponseField>

<ResponseField name="priority" type="string">
  Prioridade aplicada (`HIGH` ou `NORM`).
</ResponseField>

<ResponseField name="paymentFlow" type="string">
  Fluxo aplicado (`INSTANT` ou `APPROVAL_REQUIRED`).
</ResponseField>

<ResponseField name="payment" type="object">
  Valor da transferência (`currency`, `amount`).
</ResponseField>

<ResponseField name="pixKey" type="string">
  Chave Pix da conta de destino.
</ResponseField>

<ResponseField name="pixKeyType" type="string">
  Tipo da chave Pix (ex.: `CPF`, `CNPJ`, `PHONE`, `EMAIL`, `EVP`).
</ResponseField>

<ResponseField name="description" type="string">
  Descrição da transferência.
</ResponseField>

<ResponseField name="idempotencyKey" type="string">
  Chave de idempotência usada na requisição.
</ResponseField>

<ResponseField name="endToEndId" type="string">
  Identificador end-to-end do Pix.
</ResponseField>

<ResponseField name="createdAt" type="string">
  Data e hora de criação (ISO 8601).
</ResponseField>

<ResponseField name="settledAt" type="string">
  Data e hora da liquidação (ISO 8601). Presente quando a transferência é concluída.
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://pagamentos.basspago.com.br/api/v2/pix/payments/idempotencyKey/6a1f2e3d-4c5b-6a7f-8e9d-0a1b2c3d4e5f" \
    --cert ./client.crt \
    --key ./client.key \
    --pass "SUA_SENHA_DO_CERTIFICADO" \
    -H "Authorization: Bearer {access_token}"
  ```

  ```php PHP theme={null}
  <?php

  $idempotencyKey = '6a1f2e3d-4c5b-6a7f-8e9d-0a1b2c3d4e5f';
  $ch = curl_init("https://pagamentos.basspago.com.br/api/v2/pix/payments/idempotencyKey/{$idempotencyKey}");

  curl_setopt_array($ch, [
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_SSLCERT => './client.crt',
      CURLOPT_SSLKEY => './client.key',
      CURLOPT_KEYPASSWD => 'SUA_SENHA_DO_CERTIFICADO',
      CURLOPT_HTTPHEADER => ['Authorization: Bearer {access_token}'],
  ]);

  $response = curl_exec($ch);
  curl_close($ch);

  echo $response;
  ```

  ```javascript Node.js theme={null}
  import fs from "node:fs";
  import https from "node:https";
  import axios from "axios";

  const agent = new https.Agent({
    cert: fs.readFileSync("./client.crt"),
    key: fs.readFileSync("./client.key"),
    passphrase: "SUA_SENHA_DO_CERTIFICADO",
  });

  const idempotencyKey = "6a1f2e3d-4c5b-6a7f-8e9d-0a1b2c3d4e5f";

  const { data } = await axios.get(
    `https://pagamentos.basspago.com.br/api/v2/pix/payments/idempotencyKey/${idempotencyKey}`,
    {
      httpsAgent: agent,
      headers: { Authorization: "Bearer {access_token}" },
    }
  );

  console.log(data);
  ```
</RequestExample>

<ResponseExample>
  ```json 200 - OK theme={null}
  {
    "id": "pay_9f8e7d6c5b4a",
    "status": "SETTLED",
    "priority": "HIGH",
    "paymentFlow": "INSTANT",
    "payment": {
      "currency": "BRL",
      "amount": 150.00
    },
    "pixKey": "22255588896",
    "pixKeyType": "CPF",
    "description": "Pagamento ao fornecedor",
    "idempotencyKey": "6a1f2e3d-4c5b-6a7f-8e9d-0a1b2c3d4e5f",
    "endToEndId": "E87654321202607211440a1b2c3d4e5f",
    "createdAt": "2026-07-21T14:40:00Z",
    "settledAt": "2026-07-21T14:40:05Z"
  }
  ```
</ResponseExample>