Procedures

A procedure allows you to complete unique actions that assist in managing subscriptions created through the Recurring API.

Process a subscription payment

While all one-time and recurring charges for subscribers are automated and processed during object creation or on scheduled billing dates, there are situations where a payment may be declined.

The Process a subscription payment procedure will allow you to try a failed payment again and should be actioned after correcting the cause of the original failure, such as changing default banking or updating credit card details for the customer

Locating failed payments

Payments are a sub-object of the subscription that processed the payment. Subscribers with declined payments will contain a hasFailedPayments parameter with a value greater than 0.

• Use the Get subscriptions collection to retrieve all subscription objects with failed payments
• Take the id and then retrieve the individual object through Get subscription endpoint and include subObjects to retrieve the payment number
• Process the payment with the subscriptionId and the paymentNumber
• Requires a single request for each payment you are attempting to process

The recurring paymentNumber for the subscription payment that has failed can be found by retrieving the associated subscription object through the Get subscription endpoint by using the subscriptionId and passing includeSubObjects=true in the request.

Payment statuses

All payments contain a status parameter that identifies whether that payment has been processed and the outcome of that payment attempt, or whether that payment has been queued to process on a future date.

🚧

A payment with a status of approved or waiting cannot be processed through this procedure endpoint and will decline if attempted

📘

API Reference

Review the Process a subscription payment API Reference to see the required header and body parameters for requests to this endpoint.