Use Cases and Flows

This section describes the different use cases and transaction flows for recurring payments. These flows cover both user-initiated payments and merchant-initiated payments while handling scenarios such as first-time payments, returning users, and subscription billing.

Key Scenarios

1. First-Time Payment & Saving a Payment Method: A new shopper completes a payment and opts to save their details.

2. Merchant-Initiated Recurring Payment: The merchant charges a saved payment method automatically for subscriptions.

3. Shopper Removes a Saved Payment Method: A shopper removes a stored payment method from their account.

First-Time Payment & Saving a Payment Method

Description

A new shopper completes a payment and is given the option to save their payment method for future transactions.

Flow Details

1. The merchant initiates a payment request via /v2/Payment/init, passing shopper info, transaction details, and savePaymentMethod: true

2. The shopper is redirected to the hosted payment page

3. The shopper enters payment details and selects the option to save the payment method

4. The payment is processed, undergoing authentication and fraud checks (e.g., SCA)

5. Upon success:

   • A shopper profile is created (if it doesn't exist)

   • A payment method token is generated and stored

   • The merchant receives a notification confirming the saved method

6. The merchant receives the payment success response along with the shopper ID and the tokenized payment method

You can refer to the Hosted Payment Page Integration: Initiate a Payment Request and Saving Card Details references for more details on each APIs.

Merchant-Initiated Recurring Payment

Description

The merchant charges a shopper automatically without their presence (off-session), using a previously saved payment method.

Flow Details

1. The merchant initiates a recurring charge via /v2/Payment/init, passing:

   • userInitiated: false (indicating the shopper is not present).

   • displaySavedPaymentMethods: false (no UI shown).

   • token of the saved payment method.

2. The system processes the payment using the stored payment method token.

3. The transaction undergoes standard authentication, fraud checks, and processing.

4. The merchant receives a payment success response.

You can refer to the Hosted Payment Page Integration: Initiate a Payment Request and Saving Card Details references for more details on each APIs.