---
title: "Retorna uma lista de transações de recuperação de inadimplência."
method: GET
path: "/v1/transactions/recoveries"
tags: ["transactions"]
---

# Retorna uma lista de transações de recuperação de inadimplência.

`GET /v1/transactions/recoveries`

## Request

- Base URL: `//app.vindi.com.br/api` (relative, and the document’s source URL is not known)
- URL: `//app.vindi.com.br/api/v1/transactions/recoveries`
- Auth: HTTP basic

Retorna uma lista de transações com recuperação de inadimplencia de um merchant
dentro de um período específico

## Query parameters

- `start_on` string, required
- `end_on` string, required
- `name` string, required

## Response `200`

Consulta realizada com sucesso.

- Transaction[]
  - `id` integer, required: ID da transação
  - `transaction_type` 'charge' | 'refund' | 'authorization' | 'capture' | 'verify' | 'register' | 'void' | 'renew_payment_profile' | 'pre_authorization' | 'update', required: Tipo da transação
  - `status` 'processing' | 'success' | 'rejected' | 'failure' | 'timeout' | 'waiting' | 'canceled' | 'fraud_review', required: Status da transação
  - `amount` number, required: Valor da transação
  - `installments` integer, required: Número de parcelas
  - `gateway_message` string, required: Mensagem de resposta do gateway
  - `gateway_response_code` string, required: Código de resposta do gateway
  - `gateway_authorization` string, required: Código da autorização usado no estorno ou captura. Varia de acordo com o adquirente
  - `gateway_transaction_id` string, required: Código externo de referência do gateway. Para boletos, representa o "nosso número"
  - `gateway_response_fields` string: Atributos de resposta específicos do gateway
  - `fallback_type` string, required: Tipo de Retentativa
  - `fraud_detector_score` number: Pontuação da análise antifraude entre 0.00 e 1.00. Quanto maior a pontuação, maior o risco de fraude
  - `fraud_detector_status` 'automatic_success' | 'manual_success' | 'automatic_rejected' | 'manual_rejected' | 'review' | 'failure': Status da análise antifraude
  - `fraud_detector_id` string: ID da análise antifraude
  - `created_at` string, required: Data e hora da transação
  - `updated_at` string, required: Data e hora da última atualização da transação
  - `gateway` GatewaySummary, required
    - `id` integer, required: ID do gateway
    - `connector` string, required: Conector utilizado no gateway
  - `payment_profile` PaymentProfileSummary, required
    - `id` integer, required: ID do perfil de pagamento
    - `holder_name` string: Nome do titular/portador do perfil de pagamento
    - `registry_code` string: CPF ou CNPJ do titular/portador
    - `bank_branch` string: Agência da conta bancária
    - `bank_account` string: Número da conta bancária
    - `card_expiration` string: Validade do cartão de crédito no formato MM/AA
    - `allow_as_fallback` string: Permite utilizar o perfil de pagamento em retentativas de cobranças não pagas.
    - `card_number_first_six` string: Primeiros 6 dígitos do cartão de crédito (BIN/IIN)
    - `card_number_last_four` string: Últimos 4 dígitos do cartão de crédito
    - `renewed_card` object
      - `card_number_last_four` string: Últimos quatro dígitos do cartão de crédito renovado
      - `card_expiration` string: Nova validade do cartão de crédito renovado
    - `card_renewed_at` string: Data da renovação do cartão de crédito renovado
    - `token` string, required: Token interno para referência do perfil de pagamento
    - `created_at` string, required: Data e hora do cadastro do perfil de pagamento
    - `payment_company` PaymentCompany, required
      - `id` integer, required: ID da bandeira ou banco
      - `name` string, required: Nome da bandeira ou banco
      - `code` string, required: Código para referência via API
  - `charge` ChargeSummary, required
    - `id` integer, required: ID da cobrança
  - `customer` CustomerSummary, required
    - `id` integer, required: ID do cliente
    - `name` string, required: Nome do cliente
    - `email` string: E-mail do cliente
    - `code` string: Código opcional para referência via API
  - `payment_method` PaymentMethodSummary, required
    - `id` integer, required: ID do método de pagamento
    - `public_name` string, required: Nome público do método de pagamento
    - `name` string, required: Nome interno do método de pagamento
    - `code` string, required: Código externo para referência via API
    - `type` string, required: Tipo do método de pagamento

## Other responses

- `400`: Erro de sintaxe JSON no corpo do request.
- `422`: Parâmetros inválidos. Verificar erro na resposta.

---

[API](https://skmtc.dev/vindi/apis/api-vindi.md) - [All operations](https://skmtc.dev/vindi/apis/api-vindi/llms.txt) - [OpenAPI document](https://skmtc.dev/vindi/apis/api-vindi/revisions/3e857e1cdd03?raw)