Subscriptions

Pay manual subscription

Changed on

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

post/processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/pay

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/pay
  • Auth
    HTTP bearer

Path parameters

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

subscriptionIdstring required

Unique identifier that the merchant assigned to the subscription.

Headers

Idempotency-Keystring uuid required

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

operatorstring

Operator who initiated the request.

Response

Successful request. We have processed the payment for the subscription.

subscriptionIdstring required

Unique identifier that the merchant assigned to the subscription.

processingTerminalIdstring required

Unique identifier of the terminal that the subscription is linked to.

Changes

    • breaking

      the // response property's maxLength was increased from 100 to 255 for the response status

    • info

      the // request property's maxLength was increased from 100 to 255

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API