Sign in

v1

latestOpenAPI 3.1.02026-07-13385987.3 KB
Account Holder

Identify existing recurring payments for an account holder's transaction history.

Given the history of transactions of an account holder, determines existing recurring payments and related properties such as the type (subscription or bill), amount, periodicity, etc...

post/v2/account-holder/{account_holder_id}/recurring-payments

Path parameters

account_holder_idstring required

Response

Result containing existing RecurringPaymentsGroups for an account holder.

recurrence_group_idstring required
periodicity'daily' | 'weekly' | 'bi-weekly' | 'monthly' | 'bi-monthly' | 'quarterly' | 'semi-yearly' | 'yearly' | 'other'
latest_payment_amountnumber required
total_amountnumber required
merchantstring nullable
merchant_idstring nullable
logostring nullable
websitestring nullable
labelsstring[] nullable
first_payment_datestring required
latest_payment_datestring required
transaction_idsstring[] required
is_activeboolean required
next_expected_payment_datestring nullable
latest_payment_descriptionstring required
typestring required
is_essentialboolean required
iso_currency_codestring required
entry_typestring required
periodicity_in_daysinteger nullable
average_amountinteger nullable