HEhellosunset
Recurring Payments

List recurring payments

List all recurring payments and deposits for a bank account.

get/cases/{case_id}/bank-accounts/{account_id}/recurring-payments

Request

  • Base URL
    https://api.example.com/v1
  • Auth
    none declared

Query parameters

pageinteger

Page number for pagination.

per_pageinteger

Number of items per page.

status'active' | 'cancelled' | 'paused' | 'transferred'
type'direct_deposit' | 'autopay' | 'subscription' | 'loan_payment' | 'insurance_premium' | 'utility' | 'pension' | 'social_security' | 'annuity'

Response

List of recurring payments.

Example response

{
  "data": [
    {
      "id": "01K6RP04DJ2T99HRYE78AN7YZA",
      "payee_name": "Springfield Electric Co.",
      "type": "utility",
      "amount": 150,
      "frequency": "monthly",
      "next_payment_date": "2025-10-15",
      "last_payment_date": "2025-09-15",
      "status": "active"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6,
    "next_cursor": "eyJpZCI6IjAxSzVXRjA2TUo2VDk5SFJZRTQ4QU43WE04In0=",
    "has_more": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.