Initiating payments

Payments may be initiated at any time, as long as the RecurringPaymentConsentRequest is in a GRANTED state. The only required inputs are the ID of the consent request as the token, a nonce to enforce uniqueness and an amount.

Handling transaction states

The status of the transaction is available at state.__typename.

PENDING

Transactions wait in a PENDING state if a user interaction is required. More detail about this interaction can be accessed via the reason property. For card payments, this will be 3D-secure interaction. Note that 3D-secure is typically disabled for recurring payments.

In this case, the user must visit the interactionUrl after a redirect_uri has been attached. The building of this redirect_uri parameter follows the same process used when performing a once-off payment.

This URL will guide the user through the interaction, after which the transaction will resume. On completion, a transaction webhook will be sent.

FAILURE

There are many ways for a transaction to fail, most commonly relating to the issuer rejecting the authorization. More detail about the failure reason can be accessed via the reason property.

SUCCESS

The transaction has cleared successfully. No additional steps are required.