POST/recurring-payments

Recurring Payments

This API allows you to analyze a list of financial transactions and identify recurring payments based on specified criteria such as frequency, amount consistency, and regularity score.

📘 Análise

Você está interessado em uma análise de usuário mais personalizada? Fale conosco!

Significado do Montante: Montantes negativos representam débitos (despesas), e montantes positivos representam créditos (renda). Certifique-se de que os montantes das transações estão corretamente sinalizados para obter resultados precisos. Pontuação de Regularidade: A regularityScore é um valor entre 0 e 1, indicando quão consistentes os pagamentos são em termos de tempo e montante. Uma pontuação mais alta significa pagamentos mais regulares. Normalização: As descrições das transações são normalizadas convertendo para minúsculas e removendo caracteres especiais e espaços em branco extras. Ocorrências Mínimas: Um pagamento deve ocorrer pelo menos três vezes para ser considerado recorrente. Consistência de Intervalo: Os pagamentos devem ocorrer em intervalos consistentes (aproximadamente mensalmente, dentro de um intervalo de 30 ±5 dias). Variação de Montante: A variação nos montantes das transações deve ser menor ou igual a 10% para ser considerada consistente.

Aqui está um exemplo da resposta:

json
{
    "recurringPayments": [
        {
            "description": "debito aut conta agua e esgoto sabesp",
            "averageAmount": -76.78,
            "occurrences": [
                "77777777-8888-9999-0000-111111111111",
                "88888888-9999-0000-1111-222222222222",
                "99999999-0000-1111-2222-333333333333"
            ],
            "regularityScore": 0.997773784382727
        },
        {
            "description": "ebn spotify",
            "averageAmount": 21.9,
            "occurrences": [
                "aaaaaaa1-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
                "bbbbbbb1-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
                "ccccccc1-cccc-cccc-cccc-cccccccccccc",
                "ddddddd1-dddd-dddd-dddd-dddddddddddd",
                "eeeeeee1-eeee-eeee-eeee-eeeeeeeeeeee",
                "fffffff1-ffff-ffff-ffff-ffffffffffff",
                "11111111-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
                "22222222-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
                "33333333-cccc-cccc-cccc-cccccccccccc",
                "44444444-dddd-dddd-dddd-dddddddddddd",
                "55555555-eeee-eeee-eeee-eeeeeeeeeeee",
                "66666666-ffff-ffff-ffff-ffffffffffff"
            ],
            "regularityScore": 0.9344445222642911
        },
        {
            "description": "mp camisetadepre",
            "averageAmount": 8.57,
            "occurrences": [
                "99999999-cccc-cccc-cccc-cccccccccccc",
                "00000000-dddd-dddd-dddd-dddddddddddd",
                "aaaaaaa3-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
                "bbbbbbb3-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
                "ccccccc3-cccc-cccc-cccc-cccccccccccc",
                "ddddddd3-dddd-dddd-dddd-dddddddddddd"
            ],
            "regularityScore": 0.9199999999999999
        },
        {
            "description": "niazi chohfi textil",
            "averageAmount": 20.12,
            "occurrences": [
                "eeeeeee3-eeee-eeee-eeee-eeeeeeeeeeee",
                "fffffff3-ffff-ffff-ffff-ffffffffffff",
                "11111113-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
                "22222222-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
            ],
            "regularityScore": 0.9528595479208968
        }
    ]
}

Request Body

object
itemIdstring

User's item id

Example

json
{
  "itemId": "string"
}

Responses

200200
object
recurringPaymentsobject[]
itemsobject

Example response

json
{
  "recurringPayments": [
    {
      "description": "debito aut conta agua e esgoto sabesp",
      "averageAmount": -76.78,
      "occurrences": [
        "77777777-8888-9999-0000-111111111111"
      ],
      "regularityScore": 0.997773784382727
    }
  ]
}
curl -X POST \
'https://enrichment-api.pluggy.ai/recurring-payments' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY' \
-d '{}'
Resposta de exemplo
{
"recurringPayments": [
{
"description": "debito aut conta agua e esgoto sabesp",
"averageAmount": -76.78,
"occurrences": [
"77777777-8888-9999-0000-111111111111"
],
"regularityScore": 0.997773784382727
}
]
}