Introducing the Chargebee CLI

Rakuten Pay via Adyen

This feature is a Private Beta release. Contact Chargebee Support to enable Rakuten Pay via Adyen for your live and test sites.

Rakuten Pay is a digital wallet in Japan. Chargebee supports Rakuten Pay as a payment method through the Adyen payment gateway, for one-time payments and, if Rakuten approves your business, recurring payments.

When customers select Rakuten Pay at checkout, they're redirected to Rakuten Pay to log in and confirm the payment. Payment status is confirmed through Adyen webhooks.

Supported countries and currencies

Rakuten Pay via Adyen supports the following country and currency. Refer to the Adyen Rakuten Pay documentation for the latest details.

CountryCurrency
JapanJPY (Japanese Yen)

Payment features

The following features are available for Rakuten Pay via Adyen:

FeatureDescriptionSupportedDefault stateConfiguration or behavior
Integration sync modeDefines how payment requests are processed and statuses are communicated between Chargebee and Adyen.Yes (asynchronous)AsynchronousAdyen processes Rakuten Pay payments asynchronously. Chargebee receives the final payment status through Adyen webhooks. Webhook configuration is mandatory and is used to receive AUTHORISATION updates for payments and REFUND / CANCEL_OR_REFUND updates for refunds.
Capture settingsPayment processing involves two stages: authorization and capture. Capture settings determine when funds are collected after authorization.YesAuto captureAuto capture is the default and only supported capture setting for Rakuten Pay via Adyen. No additional configuration is required.
Verification modesDefines how payment methods are verified before processing.YesEnabledThe customer logs in to Rakuten Pay and confirms the payment. No separate verification configuration is required in Chargebee.
Regulatory requirementsRules set by the payment scheme or local regulation.YesRequired for recurring paymentsRakuten must approve your business for recurring payments before you can collect renewals with Rakuten Pay. Rakuten primarily allows the card-on-file recurring processing model for the food and beverage business category. Other businesses can apply for a review.
Statement descriptorDisplays the business name on the customer's bank or wallet statement, helping them recognize charges and reducing disputes.YesDisabledConfigure this under Settings > Configure Chargebee > Transaction Descriptor.
Chargeback managementHandles chargeback events and applies configured actions on invoices and subscriptions.NoNot applicableChargebee doesn't manage disputes for Rakuten Pay via Adyen.
Fraud managementUses gateway fraud signals to identify and flag high-risk transactions.NoNot applicableNo Rakuten Pay-specific fraud configuration is available in Chargebee.
Transaction initiation typeIdentifies whether a transaction is customer-initiated (CIT) or merchant-initiated (MIT).YesSupportedThe first Rakuten Pay payment is customer-initiated through the Rakuten Pay redirect. Renewal payments are Merchant Initiated Transactions (MIT) collected through the saved Adyen token.
Error intelligenceProvides standardized categorization of payment failures.YesEnabledAvailable through Adyen payment and refusal responses. No configuration is required.
Gateway transaction detailsProvides access to raw gateway responses for transactions.YesEnabledAvailable on the transaction page under Error details. No configuration is required.
Adding payment methods in the Chargebee dashboardAllows a payment method to be added in Chargebee when details are collected outside checkout.NoNot applicableCustomers must complete the Rakuten Pay checkout flow. Rakuten Pay can't be added from the Chargebee dashboard.

Prerequisites

Before you set up Rakuten Pay via Adyen in Chargebee, make sure that:

  • The Adyen payment gateway is configured in your Chargebee site, including webhook notifications.
  • Rakuten Pay is added as a payment method for your merchant account in the Adyen Customer Area. Learn more
  • To collect renewal payments, you've applied for the recurring processing model when requesting Rakuten Pay from Adyen, and Rakuten has approved it for your business.
  • Refunds are enabled for your merchant account. Rakuten Pay refund support depends on your merchant configuration and Rakuten's approval, so confirm it with Adyen.
  • JPY (Japanese Yen) is enabled as a currency in your Chargebee site.

Integration options

You can integrate Rakuten Pay via Adyen using the following methods:

Integration methodDescription
Chargebee Hosted PagesAccept Rakuten Pay payments using Chargebee's hosted checkout pages with minimal integration effort.
Chargebee.jsEmbed Rakuten Pay as a payment method in your custom checkout using Chargebee.js.
API (Payment Intent)Process Rakuten Pay payments using Chargebee APIs for a fully custom checkout and payment flow.

Supported token formats

This section is relevant if you're building a custom checkout or migrating payment methods from another provider to Adyen.

Token typeDescriptionSupportedToken fieldToken format
Chargebee Payment IntentRecommended token format when building a custom checkout using Chargebee.js.Yespayment_intent[id]payment_intent_id
Chargebee tokenLegacy token format supported for selected payment methods and gateways with Chargebee.js. Not recommended for new implementations.Notoken_idNot applicable
Gateway permanent tokenPermanent reference provided by Adyen and used for renewal Rakuten Pay payments.Yespayment_method[reference_id]shopper_reference_id/recurring_detail_reference_id
Gateway temporary tokenShort-lived token format that can be converted to a permanent token.NoNot applicableNot applicable

Configure in Chargebee

Follow these steps to enable Rakuten Pay via Adyen in your Chargebee site:

  1. Log in to the Chargebee app.
  2. Go to Settings > Configure Chargebee > Payment Gateways.
  3. Select the relevant Adyen instance from the list.
  4. On the Configure Adyen page, turn on Rakuten Pay under the supported payment methods.
  5. Click Apply to save your changes.

Configure Smart Routing

When you turn on Rakuten Pay for an Adyen instance, Smart Routing for Rakuten Pay payments in JPY is set to that instance automatically. If another gateway already handles Rakuten Pay payments in JPY, update the rule manually:

  1. Log in to the Chargebee app.
  2. Go to Settings > Configure Chargebee > Payment Gateways.
  3. Click Manage Rules under Smart Routing.
  4. Go to the Rakuten Pay section and click Add a Gateway for JPY. If a payment gateway is already assigned, click Edit.
  5. From the Choose a payment gateway dropdown, select the Adyen instance with Rakuten Pay turned on.
  6. Click Save.

Configure webhook notifications

Chargebee relies on Adyen webhooks to receive the status of Rakuten Pay payments and refunds. Configure the Standard webhook as described in Configure webhook notifications for Adyen. Chargebee uses the following events for Rakuten Pay:

  • AUTHORISATION: The payment was authorized or refused.
  • CAPTURE: The payment was captured. Adyen doesn't send this event for payments captured automatically at authorization, so you might not receive it.
  • RECURRING_CONTRACT: Adyen saved the Rakuten Pay wallet for renewal payments. If this event isn't enabled on your Adyen account, contact Adyen support to enable it.
  • REFUND and CANCEL_OR_REFUND: Adyen accepted the refund. Chargebee marks the refund as successful.
  • REFUND_FAILED: A refund that Adyen accepted failed later. Chargebee changes the refund status to failed.

Checkout flow

Your customer completes the following steps at checkout when paying with Rakuten Pay via Adyen:

  1. The customer proceeds to the payment step of the checkout, selects Rakuten Pay, and clicks Pay & Subscribe.
  2. The customer is redirected to Rakuten Pay and logs in to their Rakuten account.
  3. The customer reviews the order on Rakuten Pay and confirms the payment.
  4. The customer is redirected back to Chargebee, and the order confirmation page appears once the payment is processed.

The checkout screenshots are from Adyen's test environment and include the Rakuten Pay simulator.

Recurring payments

After the first payment, Adyen saves the customer's Rakuten Pay wallet as a token. Chargebee uses the token to collect renewal payments as Merchant Initiated Transactions (MIT), without the customer approving each payment.

Rakuten controls who can collect recurring payments:

  • You must apply for each recurring processing model when you request Rakuten Pay from Adyen.
  • Rakuten primarily allows the card-on-file recurring processing model for the food and beverage business category. Other businesses, including subscription businesses, can apply for a separate review.
  • Rakuten can refuse the recurring model if your business doesn't charge on a regular schedule.
  • Adyen recommends getting the customer's explicit permission for future recurring charges to reduce the risk of chargebacks.

If Rakuten hasn't approved your business for recurring payments, don't offer Rakuten Pay for subscriptions that renew automatically.

For renewal invoices, dunning follows the settings under Settings > Configure Chargebee > Dunning for Online Payments. Because Adyen processes payments asynchronously, dunning starts only after the transaction reaches a failed status. See Dunning.

Test in sandbox

Use your Adyen test merchant account with Rakuten Pay added, and a Chargebee test site with the Adyen test instance configured.

  • The Adyen test environment redirects to a Rakuten Pay simulator with two steps: a login page and an order confirmation page. Complete both to finish the test payment.
  • Make sure webhooks are configured to receive AUTHORISATION updates for payments and REFUND / CANCEL_OR_REFUND updates for refunds.
  • Refunds in the test environment don't confirm that refunds are enabled for your live merchant account.

Refer to Adyen's Rakuten Pay documentation for more test scenarios.

Test in production

Before you go live:

  • Make sure Rakuten Pay is added for your live Adyen merchant account, and that Rakuten has approved the recurring processing model if you collect renewals.
  • Confirm with Adyen that refunds and partial refunds are enabled for your live merchant account.
  • Verify that webhook configuration is complete for the live merchant account.
  • Run an end-to-end test with a real Rakuten account.

Reconcile transactions

For financial reconciliation between Chargebee and Adyen, use the Chargebee transaction field id_at_gateway, which maps to the Adyen pspReference.

  1. Retrieve the id_at_gateway value from the Chargebee transaction details.
  2. Locate the corresponding pspReference in your Adyen reports for Rakuten Pay transactions.
  3. Match the transactions using this reference.

Error codes and troubleshooting

Adyen returns refusal reasons for failed Rakuten Pay payments, and Chargebee shows them on the transaction page under Error details. For gateway error handling in Chargebee, see Payment errors.

Frequently Asked Questions (FAQs)

Can I refund a Rakuten Pay payment?

Chargebee supports full and partial refunds for Rakuten Pay via Adyen. Whether your merchant account can process them depends on your merchant configuration and Rakuten's approval, so confirm it with Adyen. Refunds are asynchronous: the refund stays in progress until Adyen confirms it through a webhook.

Can I use Rakuten Pay for subscriptions?

Yes, if Rakuten has approved your business for the recurring processing model. Without that approval, use Rakuten Pay only for payments that the customer approves at checkout.

Limitations and important points

  • Rakuten Pay via Adyen is available only for JPY (Japanese Yen) transactions.
  • Recurring payments with Rakuten Pay are subject to Rakuten's conditions and approval. For details, see Adyen's Rakuten Pay documentation.
  • Refund support depends on your merchant configuration and Rakuten's approval.
  • The first payment requires the customer to log in and confirm it on Rakuten Pay. Renewal payments are processed as merchant-initiated transactions without customer action.