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

# Consultar um cartão

> Devolve os dados de um cartão salvo no cofre, incluindo a situação dele.

Esta rota devolve os detalhes de um cartão salvo: número mascarado, bandeira, validade e `status`. O `status` desta rota pode mostrar duas coisas diferentes, conforme o cartão: o cadastro do cartão na adquirente ou a situação dele no cofre (detalhes abaixo).

> [!WARNING]
>
> Hoje esta consulta pode mostrar `active` para um cartão já excluído ou vencido. Para decidir se um cartão pode ser usado em [`POST /v1/charges`](https://docs.fastpaybrasil.com/referencia/cobrancas/criar), use [Listar cartões](https://docs.fastpaybrasil.com/referencia/cartoes/listar.md) com `customerId`: a cobrança recusa cartão `revoked` ou `expired`, e a listagem mostra essa situação corretamente.

## Quando usar

| Situação | Como usar esta rota |
| - | - |
| Mostrar ao cliente qual cartão está cadastrado | Use `maskedNumber`, `brand`, `expirationMonth` e `expirationYear` |
| Saber se o cartão ficou sem assinatura | `status` `inactive` indica que a assinatura que usava o cartão foi cancelada e nenhuma outra o usa |
| Conferir se o cartão pode ser cobrado | Use [Listar cartões](https://docs.fastpaybrasil.com/referencia/cartoes/listar.md) com `customerId` (veja o aviso acima) |
| Ver todos os cartões de um cliente | Use [Listar cartões](https://docs.fastpaybrasil.com/referencia/cartoes/listar.md) com `customerId` |

## Antes de chamar

* Tenha uma chave secreta (`sk_`) da conta que registrou o cartão ([Credenciais e ambientes](https://docs.fastpaybrasil.com/primeiros-passos/credenciais-e-ambientes.md)).
* Tenha o `id` do cartão (devolvido por [Registrar cartão](https://docs.fastpaybrasil.com/referencia/cartoes/registrar.md)).

## Parâmetros de caminho

**id** `string` *required*

Identificador único do cartão. Ex.: `2RhQg9M7ZCg3X3nMb9W1kX8Q`.

## Respostas

**id** `string`

ID do token do cartão. Ex.: `2RhQg9M7ZCg3X3nMb9W1kX8Q`.

**token** `string`

Token do cartão. Ex.: `tok_abc123xyz`.

**maskedNumber** `string | null`

Número mascarado do cartão. Ex.: `****1111`.

**brand** `string`

Bandeira do cartão. Ex.: `visa`.

**expirationMonth** `string`

Mês de validade. Ex.: `12`.

**expirationYear** `string`

Ano de validade. Ex.: `2028`.

**status** `string`

Situação do cartão: `active`, `inactive`, `pending_validation`, `expired` ou `revoked`. Quando o cartão tem cadastro na adquirente, o valor mostra esse cadastro (`active`, `inactive` ou `pending_validation`). Só quando não há esse cadastro a rota mostra a situação no cofre (`active`, `expired` ou `revoked`).

**createdAt** `string`

Data e hora de criação (formato `date-time`). Ex.: `2024-01-15T10:30:00.000Z`.

| `status` | O que significa |
| - | - |
| `active` | Cartão ativo |
| `inactive` | A assinatura que usava o cartão foi cancelada e nenhuma outra o usa. Volta a `active` se o cliente assinar de novo com esse cartão |
| `pending_validation` | Aparece só em cartões antigos, registrados com o processador anterior |
| `expired` | Validade vencida (situação no cofre) |
| `revoked` | Cartão excluído com [`DELETE /v1/cards/{id}`](https://docs.fastpaybrasil.com/referencia/cartoes/excluir) (situação no cofre) |

| HTTP | Significado | Corpo |
| - | - | - |
| `200` | Cartão encontrado | Dados do cartão |
| `401` | Credencial inválida | `{"statusCode": 401, "message": "Unauthorized"}` |
| `404` | Cartão não encontrado | `{"statusCode": 404, "message": "Card not found"}` |

> [!NOTE]
>
> **Para o negócio:** quando o cartão de um assinante vence ou é recusado na renovação, não existe troca de cartão na assinatura. O caminho é registrar o cartão novo, cancelar a assinatura e criar outra. Consultar o `status` ajuda o atendimento a explicar ao cliente o que aconteceu.

## Erros comuns

| Sintoma | Causa | Como resolver |
| - | - | - |
| `404` com `Card not found` | `id` incorreto ou cartão registrado por outra conta | Confira o `id` e use a chave da conta que registrou o cartão |
| Cobrança com cartão salvo falha, mas a consulta mostra `active` | A consulta pode mostrar `active` para cartão excluído ou vencido | Confira o cartão em [Listar cartões](https://docs.fastpaybrasil.com/referencia/cartoes/listar.md) com `customerId` e peça outro cartão se ele estiver `expired` ou `revoked` |
| `401 Unauthorized` | Chave ausente, inválida ou mal codificada | Codifique em Base64 a chave seguida de `:` |

```http REST (JSON) theme={null}
GET /v1/cards/2RhQg9M7ZCg3X3nMb9W1kX8Q HTTP/1.1
Host: api-global.fastpaybrasil.com
Authorization: Basic <base64 de "SUA_CHAVE_SECRETA:">
```

```bash cURL theme={null}
curl -X GET "https://api-global.fastpaybrasil.com/v1/cards/2RhQg9M7ZCg3X3nMb9W1kX8Q" \
  -u "$FINVIA_API_KEY:"
```

```javascript Node.js theme={null}
const credentials = Buffer.from(`${process.env.FINVIA_API_KEY}:`).toString('base64');

const response = await fetch(
  'https://api-global.fastpaybrasil.com/v1/cards/2RhQg9M7ZCg3X3nMb9W1kX8Q',
  { headers: { Authorization: `Basic ${credentials}` } },
);

const card = await response.json();
console.log(`${card.brand} final ${card.maskedNumber?.slice(-4)}, validade ${card.expirationMonth}/${card.expirationYear}`);
```

```python Python theme={null}
import os

import requests

response = requests.request(
    "GET",
    "https://api-global.fastpaybrasil.com/v1/cards/2RhQg9M7ZCg3X3nMb9W1kX8Q",
    auth=(os.environ["FINVIA_API_KEY"], ""),
    timeout=30,
)

print(response.status_code)
if response.content:
    print(response.json())
```

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

$ch = curl_init('https://api-global.fastpaybrasil.com/v1/cards/2RhQg9M7ZCg3X3nMb9W1kX8Q');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD => getenv('FINVIA_API_KEY') . ':',
]);

$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL;
print_r(json_decode($body, true));
```

```java Java theme={null}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;

public class Exemplo {
    public static void main(String[] args) throws Exception {
        String credentials = Base64.getEncoder()
            .encodeToString((System.getenv("FINVIA_API_KEY") + ":").getBytes());

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api-global.fastpaybrasil.com/v1/cards/2RhQg9M7ZCg3X3nMb9W1kX8Q"))
            .header("Authorization", "Basic " + credentials)
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}
```

```csharp C# theme={null}
using System.Net.Http.Headers;
using System.Text;

var apiKey = Environment.GetEnvironmentVariable("FINVIA_API_KEY");
var credentials = Convert.ToBase64String(Encoding.UTF8.GetBytes($"{apiKey}:"));

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", credentials);

var request = new HttpRequestMessage(HttpMethod.Get, "https://api-global.fastpaybrasil.com/v1/cards/2RhQg9M7ZCg3X3nMb9W1kX8Q");

var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

```go Go theme={null}
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("GET", "https://api-global.fastpaybrasil.com/v1/cards/2RhQg9M7ZCg3X3nMb9W1kX8Q", nil)
	if err != nil {
		panic(err)
	}
	req.SetBasicAuth(os.Getenv("FINVIA_API_KEY"), "")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	body, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode)
	fmt.Println(string(body))
}
```

```ruby Ruby theme={null}
require "net/http"
require "uri"

uri = URI("https://api-global.fastpaybrasil.com/v1/cards/2RhQg9M7ZCg3X3nMb9W1kX8Q")
request = Net::HTTP::Get.new(uri)
request.basic_auth(ENV.fetch("FINVIA_API_KEY"), "")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts response.code
puts response.body
```

```json 200 theme={null}
{
  "id": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
  "token": "tok_abc123xyz",
  "maskedNumber": "****1111",
  "brand": "visa",
  "expirationMonth": "12",
  "expirationYear": "2028",
  "status": "active",
  "createdAt": "2024-01-15T10:30:00.000Z"
}
```

```json 404 theme={null}
{
  "statusCode": 404,
  "message": "Card not found"
}
```

## Veja também

> [card] [Cofre de cartões](https://docs.fastpaybrasil.com/guias/cofre-de-cartoes.md)
>
> Ciclo de vida do cartão salvo.

> [card] [Cobrança com cartão salvo](https://docs.fastpaybrasil.com/guias/cobrancas/cartao-salvo.md)
>
> Recompra com `cardTokenId`.

> [card] [Ciclo de vida da assinatura](https://docs.fastpaybrasil.com/guias/assinaturas/ciclo-de-vida.md)
>
> Falha de renovação e troca de cartão.

> [card] [Listar cartões](https://docs.fastpaybrasil.com/referencia/cartoes/listar.md)
>
> Todos os cartões de um cliente.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.