PayPay for API-only

Accept PayPay payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Before you begin

This page assumes you have already:

• Built an API-only integration.
• Contacted our Support Team to add PayPay to your Customer Area.
  You cannot accept live payments until PayPay is in your Customer Area.

Build your payment form for PayPay

Include PayPay in the list of available payment methods.

If you are using the /paymentMethods endpoint to show available payment methods to the shopper, specify these parameters:

• countryCode: JPN
• amount.currency: JPY
• amount.value: The value of the payment, in minor units.

The API response contains paymentMethod.type: paypay.

Make a payment

You don't need to send additional fields for PayPay. See the /payments endpoint API reference for the optional fields you can send.

In the /payments response, note the action object. This contains the information needed to redirect the shopper.

Handle the redirect

1. To complete the payment, redirect the shopper to the action.url returned in the /payments response.

   When using the HTTP GET method:
   For security reasons, when displaying the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.

2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:

   • details: object that contains the URL-decoded redirectResult returned when the shopper was redirected back to your site.

3. In the response note the following:

   • resultCode: use this to present the result to your shopper.
   • pspReference: our unique identifier for the transaction.

Show the payment result

Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.

The resultCode values you can receive for PayPay are:

resultCode	Description	Action to take
Authorised	The payment was successful.	Inform the shopper that the payment has been successful, and proceed with the order. You receive the funds after the payment has been captured.
Cancelled	The shopper cancelled the payment.	Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Error	There was an error when the payment was being processed. For more information, check the refusalReason field.	Inform the shopper that there was an error processing their payment.
Refused	The payment was refused. For more information, check the refusalReason field.	Ask the shopper to try the payment again using a different payment method.

If the shopper failed to return to your website or app, wait for the AUTHORISATION webhook to receive the outcome of the payment:

eventCode	success field	Description	Action to take
AUTHORISATION	false	The transaction failed.	Cancel the order and inform the shopper that the payment failed.
AUTHORISATION	true	The shopper successfully completed the payment.	Inform the shopper that the payment has been successful, and proceed with the order.

Test and go live

To test PayPay payments:

1. Download the PayPay app for iOS or Android.
2. Sign up for a PayPay developer account and create a test user.
3. Switch the PayPay app to the sandbox app, and log in with the credentials of the test user.

You can check the status of PayPay test account transactions in your Customer Area at Transactions > Payments.

See also