Pay manual subscription
Changed onUse this method to manually collect a payment for a subscription.
You can manually collect a payment only if the subscription type is manual and only when the payment is due. The frequency you set when you created the payment plan determines how often a payment is due, for example, weekly or monthly. If you've already collected the payment for the current period, our gateway rejects the request.
To manually collect a payment, you need the subscriptionId of the subscription that's linked to the payment. You sent the subscriptionId in the request of the Create Subscription method.
Note: If you don't have the subscriptionId, use our List Subscriptions method to search for the subscription.
The request includes an order object that contains information about the amount that you want to collect.
In the response, our gateway returns information about the payment and a paymentId. You can use the paymentId in follow-on actions with the Payments endpoints or Bank Transfer Payments endpoints.
Request
- Base URLhttps://api.payroc.com/v1
- URLhttps://api.payroc.com/v1/processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/pay
- AuthHTTP bearer
Path parameters
Unique identifier that we assigned to the terminal.
Unique identifier that the merchant assigned to the subscription.
Headers
Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.
Request body
Response
Successful request. We have processed the payment for the subscription.
Changes
- breaking
the
//response property's maxLength was increased from100to255for the response status - info
the
//request property's maxLength was increased from100to255
- breaking
- warning
deleted the
headerrequest parameterAuthorization - info
the endpoint scheme security
Bearerwas added to the API
- warning