Retornar Cartão

Use essa rota para retornar um objeto com os dados de um cartão previamente criado. Apenas o card_id passado no PATH do endpoint é necessário.

GETv3/cards/:card_id

Request Variável Path

Atributo	Tipo	Descrição
card_id	string	ID do cartão salvo anteriormente.

Response Object

Propriedade	Tipo	Descrição
card_id	string	Hash identificador do cartão.
date_created	dateTime	Data de criação do cartão no formato ISODateTime.
date_updated	dateTime	Data de atualização do cartão no formato ISODateTime.
card_holder_name	string	Nome do portador do cartão.
card_brand	string	Bandeira do cartão. Valores possíveis: visa, mastercard, amex, hipercard e elo.
card_first_digits	string	Primeiros 6 dígitos do cartão.
card_last_digits	string	Últimos 4 dígitos do cartão.
card_expiration_date	string	Data de validade do cartão. Somente números no formato MMAA.
valid	boolean	Propriedade para verificar a validade do cartão, ou seja, caso true, é possível cobrar o cartão em condições normais, para false, não pode ser utilizado.

Exemplo de Response

{
  "card_id": "card_princess12leia45organa678",
  "date_created": "2025-01-01T00:00:00.000Z",
  "date_updated": "2025-01-01T00:00:00.000Z",
  "card_holder_name": "Leia S O Solo",
  "card_brand": "mastercard",
  "card_first_digits": "444455",
  "card_last_digits": "443333",
  "card_expiration_date": "0504",
  "valid": true
}

Error Object

Atributo	Tipo	Descrição
api_reference	string	Url para a documentação.
errors	array	Array com todos os erros encontrados ao processar a requisição.
errors[][type]	string	Tipo de erro ocorrido.
errors[][message]	string	Mensagem detalhada do erro ocorrido.

Exemplo de erro

{
  "api_reference": "https://docs.api.marlim.co/cards/read",
  "errors": [
    {
      "type": "parameter",
      "message": "The parameter [ card_cvv ] is missing."
    }
  ]
}

Exemplos

Cartão Encontrado

Request

curl -X GET -G "https://api.marlim.co/v3/cards/card_princess12leia45organa678" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \

Response200

{
  "card_id": "card_princess12leia45organa678",
  "date_created": "2025-11-04T18:29:37.449Z",
  "date_updated": "2025-11-04T18:29:37.449Z",
  "card_holder_name": "Leia S O Solo",
  "card_brand": "mastercard",
  "card_first_digits": "444455",
  "card_last_digits": "443333",
  "card_expiration_date": "0504",
  "valid": true
}

Cartão Não Encontrado

Request

curl -X GET -G "https://api.marlim.co/v3/cards/card_wookiee123chewbacca456789" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \

Response400

{
  "api_reference": "https://docs.api.marlim.co/cards/read",
  "errors": [
    {
      "type": "not_found",
      "message": "Card with ID 'card_wookiee123chewbacca456789' was not found."
    }
  ]
}