ADadfin
Recurring payment requests

Get the collection preferences for a recurring payment request

Changed on

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.

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
    • 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.

Response

The collection method and preferences in force.

collectionMethod'AUTO_COLLECT' | 'ON_DEMAND' required

The collection method in force.

Changes