# Change the collection preferences for a payment request

A field left out of the body is unchanged. partialPayments takes at most one of minimumAmount or minimumPercentage. statements, mandateReminders, cardReminders and directDebitEncouragement can only be set on the customer.

Endpoint: PATCH /payment_requests/{paymentRequestId}/collection_preferences
Version: 1.0.0
Security: Biller Access Token (Staging), Biller Access Token (Production)

## Path parameters:

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

## Request fields (application/json):

  - `collectionMethod` (string)
    The collection method to use.
    Enum: "AUTO_COLLECT", "ON_DEMAND"

  - `preferences` (object)
    The preferences to change.

  - `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 422 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