PayPay for API-only

Add PayPay to an existing API-only integration.

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.

Requirements

Requirement	Description
Integration type	Make sure that you have an existing API-only integration.
Setup steps	Before you begin, contact our Support Team to add PayPay to your Customer Area. You cannot accept live payments until PayPay is in your Customer Area

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:

The API response contains paymentMethod.type: paypay.

Adyen provides a logo for PayPay that you can use on your payment form. For more information, refer to Downloading logos.

You do not 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.

To complete the payment, redirect the shopper to the action.url returned in the /payments response, taking into account the following recommendations:
- When using the HTTP GET method:
  For security reasons, when showing 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.
- Redirection for mobile integrations:
  For mobile integrations, we strongly recommended that you redirect the shopper to the default browser of their device. Redirecting to the default browser ensures the best compatibility, handling of multi-factor authentication, app-to-app redirection, and error handling.
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.
In the response note the following:
- resultCode: use this to present the result to your shopper.
- pspReference: our unique identifier for the transaction.

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.