Payment-method icon

PayPay for API only

Add PayPay to your API-only integration.

You can add PayPay to your existing integration. The following instructions show only what you must add to your integration specifically for PayPay.

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.

Requirements

Requirement Description
Integration type Make sure that you have an existing API-only integration.
Redirect handling Make sure that your existing integration is set up to handle the redirect.
action.type: redirect.
Setup steps Before you begin, add PayPay in your Customer Area.

How it works

  1. The shopper selects PayPay as the payment method.
  2. The shopper enters their details in the payment form that you build.
  3. When you make the payment request, you include additional information about the items that the shopper intends to purchase.
  4. You fulfill the order by sending items to the shopper.

Build your payment form

You do not need to add any parameters when you make a payment.

You can download the logo for PayPay to use in your form.

Get PayPay as an available payment method

When you make the /paymentMethods to get available payment methods, specify the following so that PayPay is included in the response.

Parameter Values
countryCode JP
amount.currency JPY
amount.value The value of the payment, in minor units.

Add additional parameters to your /payments request

You do not need to add any parameters when you make a payment.

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