GET/credit-cards/{creditCard}/recurrings

Recorrências do Cartão

Lista assinaturas e cobranças recorrentes detectadas nas transações do cartão (sem parcelas).

Observações

  • Derivado localmente após o sync de transações — não é um recurso Open Finance da instituição.
  • Detecção determinística: agrupa por merchant normalizado (remove gateways tipo "Ifd*"), clusteriza valores por moeda (assinaturas internacionais usam o valor original, imune ao câmbio) e valida cadência mensal com no mínimo 3 meses cobrados.
  • Exclui parcelamentos (charge_number > 1 ou payment_type A_PRAZO), tarifas/IOF, estornos e créditos.
  • MCCs de consumo avulso (mercado, posto, estacionamento) exigem valor idêntico e cadência perfeita para evitar falsos positivos.

Query Parameters

FieldTypeDescription
cursorstringCursor de paginação (cursor-based). Use o next_cursor da resposta anterior para avançar. 50 itens por página.

Response Fields

FieldTypeDescription
descriptionstringNome normalizado da recorrência (ex.: netflix).
averageAmountnumberValor médio em BRL das ocorrências. Débito é negativo.
currencystringMoeda original da cobrança (ISO 4217). Assinaturas internacionais mantêm a moeda de origem (ex.: USD) mesmo com averageAmount em BRL.
periodMonthsinteger | nullPeríodo detectado em meses (1 = mensal, 2, 3, 6 ou 12).
expectedDayinteger | nullDia do mês esperado para a cobrança (mediana das ocorrências).
firstOccurrenceAtstring | nullData (Y-m-d) da primeira ocorrência conhecida.
lastOccurrenceAtstring | nullData (Y-m-d) da última ocorrência conhecida.
nextExpectedAtstring | nullData (Y-m-d) prevista para a próxima cobrança (última + periodMonths).
occurrencesstring[]IDs das transações do cartão que formam a recorrência.
regularityScorenumberScore de regularidade entre 0 e 1 (confiança da detecção).