The Redsys plugin takes card payments at J2Commerce checkout through the Redsys (TPV Virtual) gateway. Card details are entered in a Redsys inSite iframe on the checkout page.
It supports saved cards, refunds and voids from the order screen, and subscription renewals. It is for stores that have a Redsys account with an acquiring bank.
Requirements
- J2Commerce 6.6.4 or later.
- Joomla 6.0.0 or later.
- A Redsys Virtual POS account with a merchant code (FUC), a terminal number and a signing key from your acquiring bank.
Installation
- Go to System -> Install -> Extensions and upload the plugin package.
- Go to J2Commerce -> Setup -> Payment Methods.
- Open Redsys (TPV Virtual) and set Status to Enabled.
- Enter your credentials and save.
Settings
| Setting | What It Does | Default | Options |
|---|---|---|---|
| Display Name | Name shown to customers at checkout. | Credit / Debit Card | Text |
| Display Image | Image shown next to the payment method. | None | Media file |
| Sandbox Mode | Uses the test credentials instead of the live ones. | No | Yes, No |
| Merchant Code (FUC) | Live FUC number from your acquiring bank. Shown when Sandbox Mode is No. | Empty | Text |
| Terminal Number | Live terminal number from your acquiring bank. | 001 | Text |
| Merchant Signing Key | HMAC SHA-512 signing key from the Virtual POS Administration Portal. Keep it secret. | Empty | Password |
| Sandbox Merchant Code (FUC) | Test FUC. Shown when Sandbox Mode is Yes. | Empty | Text |
| Sandbox Terminal Number | Test terminal number. | 001 | Text |
| Sandbox Signing Key | Test signing key. | Empty | Password |
| Allow Saved Cards | Lets customers save cards for 1-click checkout and subscription renewals. | Yes | Yes, No |
| Payment Confirmed Order Status | Order status set when a payment is authorized. | Order status with ID 1 | Any order status |
| Change Order Status on Void | Updates the order status after a void. | No | Yes, No |
| Void Order Status | Status set after a successful void. Shown when the previous option is Yes. | Empty | Any order status |
| Change Order Status on Refund | Updates the order status after a refund. | No | Yes, No |
| Refund Order Status | Status set after a successful refund. Shown when the previous option is Yes. | Empty | Any order status |
| Surcharge Name, Surcharge Percent, Surcharge Fixed, Surcharge Tax Class | Adds a fee for paying with this method and sets its tax class. | Empty | Text, percent, amount, tax profile |
| Geozone Restriction | Limits the method to customers in a geozone. | Empty | Any geozone |
| Minimum Subtotal, Maximum Subtotal | Shows the method only when the cart subtotal is within the range. | Empty | Amount |
| Thank You Message | Article shown after a successful payment. | None | Joomla article |
| On Selection, On Before Payment, On After Payment, On Error Payment, On Cancel Payment | Text or messages shown at each stage of checkout. | Empty | Text |
| Show Dashboard Icon, Dashboard Icon Label | Adds a dashboard icon for this plugin, with an optional label. | No | Yes, No; text |
| Subtemplate | Selects the checkout layout set. | Default | Available subtemplates |
| Debug Mode | Writes gateway requests and responses to the Joomla log file payment_redsys.php. Turn it off in production. | No | Yes, No |
How Checkout Works
The card form loads in an iframe on the checkout page, so card numbers do not pass through your server. Cards that need 3D Secure are sent to authentication before the order completes.
With Allow Saved Cards on, customers see a Save this card for future purchases option. Saved cards appear in My Account, where customers can remove them. A card linked to an active subscription cannot be removed.
Refunds and Voids
Open a paid Redsys order in the admin area and use Refund for a full or partial refund, or Cancel (Void) to cancel the transaction. A refund cannot exceed the maximum refundable amount shown.
Warning
A void cannot be undone and is only possible within 48 hours of the payment. After that, use a refund.
Common Setups
Testing Before Going Live
- Set Sandbox Mode to Yes.
- Enter the sandbox merchant code, terminal and signing key.
- Place a test order.
- Set Sandbox Mode to No and enter the live credentials.
Troubleshooting
- Card data not received from payment iframe. Make sure JavaScript is enabled, then try again.
- Payment declined (code: ...). The bank refused the card. Ask the customer to use a different card.
- Your 3D Secure session has expired. The customer must start checkout again.
- Void failed. The 48-hour cancellation window may have passed. Use a refund instead.
- Refund failed. Check the Redsys portal for the code shown.
- Other gateway errors: turn on Debug Mode and read the payment_redsys.php log.
Uninstalling
Uninstalling the plugin deletes its saved card and pending payment tables. Customers' saved cards are lost.
