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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Analysis

Are you interested in a more custom user analysis? Talk to us!

Amount Significance: Negative amounts represent debits (expenses), and positive amounts represent credits (income). Ensure that transaction amounts are correctly signed to get accurate results.
Regularity Score: The regularityScore is a value between 0 and 1, indicating how consistent the payments are in terms of timing and amount. A higher score means more regular payments.
Normalization: Transaction descriptions are normalized by converting to lowercase and removing special characters and extra whitespace.
Minimum Occurrences: A payment must occur at least three times to be considered recurring.
Interval Consistency: Payments must occur at consistent intervals (approximately monthly, within a 30 ±5 day range).
Amount Variance: The variance in transaction amounts must be less than or equal to 10% to be considered consistent.

Here is an example of the response:

{
    "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
        }
    ]
}
Body Params
string

User's item id

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json