Payment requests

Pause collection for a payment request

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

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