---
title: "Get the collection preferences for a recurring payment request"
method: GET
path: "/schedules/payment_requests/{recurringPaymentRequestId}/collection_preferences"
tags: ["Recurring payment requests"]
---

# Get the collection preferences for a recurring payment request

`GET /schedules/payment_requests/{recurringPaymentRequestId}/collection_preferences`

## Request

- Base URL: `https://api.adfin.com/api`
- URL: `https://api.adfin.com/api/schedules/payment_requests/{recurringPaymentRequestId}/collection_preferences`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.staging.adfin.com/api/oauth2/token`
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.adfin.com/api/oauth2/token`

Returns how collection is set up for the payment requests this recurring payment request raises. The values in force, after the agent's settings and every override are resolved.

## Path parameters

- `recurringPaymentRequestId` string, uuid, required

## Response `200`

The collection method and preferences in force.

- CollectionPreferencesResponse: The collection method and preferences in force for an entity.
  - `collectionMethod` 'AUTO_COLLECT' | 'ON_DEMAND', required: The collection method in force.
  - `preferences` CollectionPreferences, required: The collection preferences that can be set for an entity.
    - `paymentReminders` PreferenceToggle: A preference the agent either applies or does not.
      - `enabled` boolean, required: Whether the agent applies this preference.
    - `paymentDistribution` PreferenceToggle: A preference the agent either applies or does not.
      - `enabled` boolean, required: Whether the agent applies this preference.
    - `mandateReminders` PreferenceToggle: A preference the agent either applies or does not.
      - `enabled` boolean, required: Whether the agent applies this preference.
    - `cardReminders` PreferenceToggle: A preference the agent either applies or does not.
      - `enabled` boolean, required: Whether the agent applies this preference.
    - `directDebitEncouragement` PreferenceToggle: A preference the agent either applies or does not.
      - `enabled` boolean, required: Whether the agent applies this preference.
    - `statements` PreferenceToggle: A preference the agent either applies or does not.
      - `enabled` boolean, required: Whether the agent applies this preference.
    - `lateFees` LateFeesPreference: Whether late fees are charged, and when they become chargeable.
      - `enabled` boolean, required: Whether the agent charges late fees.
      - `gracePeriodDays` integer: Days after the due date before a late fee becomes chargeable.
    - `partialPayments` PartialPaymentsPreference: Whether the customer may pay in parts, and the smallest part accepted.
      - `enabled` boolean, required: Whether the agent accepts part payments.
      - `minimumAmount` number: Smallest part payment accepted, as a fixed amount. `0` accepts any amount.
      - `minimumPercentage` number: Smallest part payment accepted, as a percentage of the total.
    - `surcharging` PreferenceToggle: A preference the agent either applies or does not.
      - `enabled` boolean, required: Whether the agent applies this preference.

## Other responses

- `204`: Adfin is not collecting from this customer: no agent assigned, or collection set to none.
- `400`: The identifier in the path is not a valid UUID.
- `401`: The request carried no valid access token.
- `403`: The access token does not grant reading schedules.
- `404`: There is no recurring payment request with that identifier.
- `500`: The server could not process the request.

## Changes

- **2026-10-19** `ba2d7a1f310e`: 1 info
  - added the optional property `preferences/paymentDistribution` to the response with the `200` status
- **2026-09-10** `538c9ec3d4d4`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/adfin/apis/adfin-api/changes/schedules/payment_requests/:recurringPaymentRequestId/collection_preferences/get.md)

---

[API](https://skmtc.dev/adfin/apis/adfin-api.md) - [All operations](https://skmtc.dev/adfin/apis/adfin-api/llms.txt) - [OpenAPI document](https://skmtc.dev/adfin/apis/adfin-api/revisions/3bcc12f59ff0?raw)