Sign in
Subscriptions

Pay manual subscription

Use this method to manually collect a payment linked to a subscription. You can manually collect a payment only if the merchant chose not to let our gateway automatically collect each payment.

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

Path parameters

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

subscriptionIdstring required

Unique identifier that the merchant assigned to the subscription.

Headers

Authorizationstring required

Bearer authentication

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

No recorded changes to this endpoint across all 1 revision of this API.