SchemaPaymentsSubscriptions

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.

Path parameters

processingTerminalIdstringRequired>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.
subscriptionIdstringRequired>=1 character<=48 characters
Unique identifier that the merchant assigned to the subscription.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Idempotency-KeystringRequired

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

This endpoint expects an object.
orderobjectRequired
Object that contains information about the payment.
operatorstringOptional>=0 characters<=50 characters
Operator who initiated the request.
customFieldslist of objectsOptional
Array of customField objects.

Response

Successful request. We have processed the payment for the subscription.
subscriptionIdstring
Unique identifier that the merchant assigned to the subscription.
processingTerminalIdstring
Unique identifier of the terminal that the subscription is linked to.
paymentobject
Object that contains information about a payment.
secureTokenobject
Object that contains information about the secure token.
currentStateobject
A snapshot of the subscription's current state.
customFieldslist of objects or null
Array of customField objects.

Errors