ADadfin
Recurring payment requests

Change the collection preferences for a recurring payment request

Changed on

Changes how collection is set up for the payment requests this recurring payment request raises. 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.

patch/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
    • OAuth 2
      Client credentials
      Token URL: https://api.staging.adfin.com/api/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: https://api.adfin.com/api/oauth2/token

Path parameters

recurringPaymentRequestIdstring uuid required

The identifier of the recurring payment request.

Request body

collectionMethod'AUTO_COLLECT' | 'ON_DEMAND'

The collection method to use.

Response

The change was applied.

Changes

  • ba2d7a1f310eRevision changes
    • info

      added the new optional request property /

  • cbec1c02c8cfRevision changes
    • warning

      the // request property's exclusiveMinimum was set to 0.00

    • warning

      the // request property's min was set to 0.00

    • warning

      the // request property's min was set to 0.00