Recurring payment
Recurring payment
Workflow description
The WEBPAY system has two methods for processing payments without the Cardholder's participation:
- Recurring Payments — payments made at specific intervals without the Cardholder's participation, initiated by the Merchant upon certain events or on a regular basis. The Merchant's request is a specially formatted query sent to the payment service resource.
- Credential on File (CoF) — payments made using a bound card, where debits do not follow a strict periodicity. The initiator of such debits can be:
- The Merchant,
- The Cardholder.
Before processing recurring (CoF) payments, an initial payment must be made, serving as a contract, with the Cardholder's participation and entry of all card details following the standard scenario. Subsequent recurring (CoF) payments are processed without the Cardholder's participation and without transmitting CVV/CVC. The initial payment supports 3D-Secure (3DS). Recurring (CoF) payments cannot support 3DS.
The amount of a recurring (CoF) payment may differ from the amount of the initial payment. Transaction type settings are configured on the WEBPAY side based on the Merchant's business process.
Recurring (CoF) payment usage scenario
The Cardholder is redirected from the Merchant's resource via a POST request to the payment service resource. The Cardholder is then prompted to enter bank payment card details and additional parameters. Next, the standard payment processing scenario is followed, including 3DS authentication if required.
Upon successful payment completion, the service binds the card to the Merchant's Cardholder, identified by the method described below.
After payment completion, redirection to the Merchant's resource to one of the URLs specified by the Merchant is possible (for both successful (wsb_return_url parameter) and unsuccessful (wsb_cancel_return_url parameter) payment outcomes). Additionally, a notification is sent to another URL (wsb_notify_url parameter). The notification message containing the result of the initial payment includes the user identifier, masked card number, and the expiration date of the subscription to the recurring (CoF) payment mechanism.
Upon a successful initial payment, the Merchant can process recurring (CoF) payments.
Cardholder identification number, card binding parameters
The Cardholder must be registered on the Merchant's resource. The Merchant assigns them a unique identifier, transmitted in payment requests as the wsb_customer_id parameter. The card will be bound to this identifier for this specific Merchant (wsb_storeid).
Payment form fields for recurring payments
The WEBPAY system provides two methods for generating payment orders:
To specify the use of recurring (CoF) payments in the authorization request, the following additional fields must be used:
Please Note
All text fields must be in UTF-8 encoding.
| Field Name | Required | Description | Notes |
|---|---|---|---|
wsb_customer_id | yes | Unique user identifier in the Merchant system | Maximum field length is 64 characters. Field is case-insensitive |
wsb_operation_type | yes | Specifies the request type | Allowed values:
|
wsb_recurring_token | yes | Unique token binding the card to the user identifier in the Merchant system (wsb_customer_id) | The value of this field corresponds to the value of the recurring_token field passed in the notification after card binding |
Payment service addresses for request processing
To process recurring (CoF) requests in test mode, use the address https://securesandbox.webpay.by. For processing real payments, use https://payment.webpay.by.