ADadfin
Payment requests

Pause collection for a payment request

Changed on

Stops collection of this payment request by the named methods, leaving the customer's other payment requests alone. The pause overrides whatever the customer-level state is, so a payment request can be held back while the rest of the customer keeps being collected. Methods that are not named keep collecting, and a method that is already paused stays as it is.

put/payment_requests/{paymentRequestId}:pause_collection

Request

  • Base URL
    https://api.adfin.com/api
  • URL
    https://api.adfin.com/api/payment_requests/{paymentRequestId}:pause_collection
  • 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

paymentRequestIdstring uuid required

The identifier of the payment request.

Request body

collectionMethodsstring[] required

The collection methods to pause. At least one method is required.

Response

Collection is paused for the named methods.

Changes

  • cbec1c02c8cfRevision changes
    • breaking

      the request property's minItems was increased to 1

  • 15c1340dcb72Revision changes
    • info

      the endpoint scheme security Biller Access Token (Production) was added to the API

    • info

      the endpoint scheme security Biller Access Token (Staging) was added to the API