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 be presented with the reference number and instructions to complete the payment.

Handling the payment result

REDIRECT

1. After the consumer completes the payment, they are redirected to the returnUrl specified in the payment charge creation request.
2. Upon redirect back to your site, retrieve the latest payment status by performing a GET /v1/payment-charges/{paymentChargeId}. Use the returned status field to determine and display the final payment outcome to the consumer.
3. Additionally, webhooks are triggered to notify you of the payment result. This ensures you receive the outcome even if the consumer closes their browser or fails to return to your website.