# Get the collection preferences for a recurring payment request

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.

Endpoint: GET /schedules/payment_requests/{recurringPaymentRequestId}/collection_preferences
Version: 1.0.0
Security: Biller Access Token (Staging), Biller Access Token (Production)

## Path parameters:

  - `recurringPaymentRequestId` (string, required)
    The identifier of the recurring payment request.

## Response 200 fields (application/json):

  - `collectionMethod` (string, required)
    The collection method in force.
    Enum: "AUTO_COLLECT", "ON_DEMAND"

  - `preferences` (object, required)
    The preferences in force.

  - `preferences.paymentReminders` (object)
    Reminders sent about an outstanding payment.

  - `preferences.paymentReminders.enabled` (boolean, required)
    Whether the agent applies this preference.

  - `preferences.mandateReminders` (object)
    Reminders sent to set up a direct debit mandate.

  - `preferences.cardReminders` (object)
    Reminders sent to save a card for future payments.

  - `preferences.directDebitEncouragement` (object)
    Prompts encouraging the customer to pay by direct debit.

  - `preferences.statements` (object)
    Periodic statements of everything outstanding.

  - `preferences.lateFees` (object)
    Fees charged once a payment is overdue.

  - `preferences.lateFees.enabled` (boolean, required)
    Whether the agent charges late fees.

  - `preferences.lateFees.gracePeriodDays` (integer)
    Days after the due date before a late fee becomes chargeable.

  - `preferences.partialPayments` (object)
    Whether the customer may pay in parts.

  - `preferences.partialPayments.enabled` (boolean, required)
    Whether the agent accepts part payments.

  - `preferences.partialPayments.minimumAmount` (number)
    Smallest part payment accepted, as a fixed amount. 0 accepts any amount.

  - `preferences.partialPayments.minimumPercentage` (number)
    Smallest part payment accepted, as a percentage of the total.

  - `preferences.surcharging` (object)
    Whether a card surcharge is added.

## Response 400 fields (application/json):

  - `type` (string)

  - `title` (string)

  - `status` (integer)

  - `detail` (string)

  - `instance` (string)

  - `properties` (object)

  - `errors` (array)

  - `errors.message` (string)

## Response 404 fields (application/json):

  - `type` (string)

  - `title` (string)

  - `status` (integer)

  - `detail` (string)

  - `instance` (string)

  - `properties` (object)

  - `errors` (array)

  - `errors.message` (string)


## Response 204 fields

## Response 401 fields

## Response 403 fields

## Response 500 fields