{"title":"Rakuten Pay for API only","category":"default","creationDate":1778836689,"content":"

You can add Rakuten Pay to your existing integration. The following instructions show only what you must add to your integration specifically for Rakuten Pay.<\/p>\n

If an instruction on this page corresponds with a step in the main integration guide, it includes a link to corresponding step of the main integration guide.<\/p>\n

Requirements<\/h2>\n\n\n\n\n\n\n\n
Requirement<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Integration type<\/strong><\/td>\nMake sure that you have an existing API-only integration<\/a>.<\/td>\n <\/td>\n<\/tr>\n
Redirect handling<\/strong><\/td>\nMake sure that your existing integration is set up to handle the redirect<\/a>.
action.type<\/code>: redirect<\/strong>.<\/td>\n		<\/td>\n<\/tr>\n
Setup steps<\/strong><\/td>\n Before you begin, add Rakuten Pay in your Customer Area<\/a>. <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

How it works<\/h2>\n
    \n
  1. The shopper selects Rakuten Pay as the payment method.<\/li>\n
  2. The shopper enters their details in the payment form that you build<\/a>.<\/li>\n
  3. When you make the payment request, you include additional information about the items that the shopper intends to purchase<\/a>.<\/li>\n
  4. Your existing integration setup will handle the redirect<\/a>.<\/li>\n<\/ol>\n

    Build your payment form<\/h2>\n

    Include Rakuten Pay in the list of available payment methods. There are no additional fields that you have to include in your form.<\/p>\n

    \n

    You can download the logo for Rakuten Pay<\/a> to use in your form.<\/p>\n<\/div>\n

    Get Rakuten Pay as an available payment method<\/h2>\n

    When you make the \/paymentMethods<\/a> to get available payment methods<\/a>, specify the following so that Rakuten Pay is included in the response.<\/p>\n\n\n\n\n\n\n
    Parameter<\/th>\nValues<\/th>\n<\/tr>\n<\/thead>\n
    countryCode<\/a><\/td>\nJP<\/strong><\/td>\n<\/tr>\n
    amount.currency<\/a><\/td>\nJPY<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    \n <\/code-sample>\n<\/div>\n
    \n <\/code-sample>\n<\/div>\n

    Add additional parameters to your \/payments request<\/h2>\n

    You do not need to add any additional parameters when you make a payment<\/a>.<\/p>\n

    Recurring<\/h2>\n

    If you have a business model based on subscription<\/a> and unscheduled card-on-file<\/a> payments, Rakuten Pay permits one-off card-on-file<\/a> transactions after a review process. If you do not have a periodic charging cadence, Rakuten Pay prohibits you from initiating the Recurring Processing Model for card-on-file, which is primarily allowed for the Food & Beverage business category. You must apply for every Recurring Processing Model when you request Rakuten Pay.<\/p>\n

    Refer to Create tokens<\/a> to integrate with our tokenization feature.<\/p>\n

    \n

    We strongly recommend that you ask explicit permission from the shopper if you intend to make future recurring payments. Being transparent about the payment schedule and the charged amount reduces the risk of chargebacks.<\/p>\n<\/div>\n

    Test and go live<\/h2>\n

    To test Rakuten Pay payments, use the acquirer account DGFT_AcquirerAccount_RakutenPay_closedLoop<\/code> in the TEST environment.<\/p>\n

    You will be redirected you to a DGFT simulator tool to complete the transaction. You do not need the Rakuten Pay app.<\/p>\n

    You can check the status of Rakuten Pay test account transactions in your Customer Area at Transactions<\/strong> > Payments<\/strong>.<\/p>\n

    See also<\/h2>\n