Launched in 2018, PayPay has become Japan's leading mobile payment app, with over 65 million users. With widespread acceptance, PayPay has achieved a payment ratio exceeding 45%, surpassing other digital wallets in Japan. Learn more about PayPay.

Payment Method Properties

Make a PayPay Payment

One-time PayPay payments follow our standardized REDIRECT payment flow. However, we recommend including all relevant settings for any authentication methods you support.

To create a PayPay payment, you'll need to provide the following data at minimum when calling our /v1/payment-charges API:

Request

POST /v1/payment-charges

{
  "paymentMethod": "PAYPAY",
  "paymentDescriptor": "Order description",
  "amount": {
    "value": 10,
    "currency": "JPY"
  },
  "consumer": {
    "name": "John Smith",
    "country": "JP"
  },
  "authenticationSettings": [
    {
      "type": "REDIRECT",
      "settings": {
        "returnUrl": "https://www.webshop.com/order-results-page"
      }
    }
  ]
}

Response

You'll receive one of our standard payment charge responses (see potential responses in the API Reference)

{
  "id": "charge_X0O78tadFHrZCbGhkycPk",
  "status": "AUTHENTICATION_PENDING",
  
  // ...
  
  "authenticationMethods": [
    {
      "type": "REDIRECT",
      "details": {
        "requestUrl": "https://redirection-target.com",
        "requestMethod": "GET"
      }
    }
  ]
}

Pick the desired authentication method

REDIRECT

1. Redirect your consumer to the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestUrl.
   For example, with the value of https://redirection-target.ppro.com/ using the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestMethod HTTP method.
2. The consumer will finalize the payment process on the redirected page.

Handling the payment result

REDIRECT

1. Once the consumer has confirmed the payment, they are redirected to the returnUrl provided in the initial payment charge creation request.
2. After the consumer is redirected back to your site, check the payment status by making a GET /v1/payment-charges/{paymentChargeId}. Use the Status that you received to display the payment outcome to the consumer.
3. Webhooks are also sent to inform you of the payment outcome. If the shopper closes the browser and doesn't return to your website, you can rely on webhooks to receive the payment result.