PayPay QR Code Payments

Use the Terminal API to take payments with PayPay, the QR code-based payment method in Japan.

Link to section

Request a PayPay Terminal checkout

The Terminal API supports PayPay QR code payments by providing the payment_type field in the TerminalCheckout object and the CheckoutOptionsPaymentType enumeration. When a payment_type has the PAYPAY enumerator value specified in the checkout request, the Terminal displays the PayPay QR code for the buyer to scan.

The following example shows a Terminal checkout request with the PayPay payment_type:

curl https://connect.squareup.com/v2/terminals/checkouts \
  -X POST \
  -H 'Square-Version: 2023-05-17' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "idempotency_key": "5f2e1vb9-c86a-6431-88d2-c0b49a84df66",
    "checkout": {
      "amount": 100,
      "currency": "JPY"
    },
    "device_options": {
      "device_id": "R5WNWB5BKNG9R"
    },
    "payment_type": "PAYPAY"
  }'

Link to section

Requirements and limitations

• Square Terminal must be running App Version 5.95 or later to accept a PayPay QR code payment.

• Square Terminal must be activated and located in Japan.

• The seller must be approved to accept PayPay QR code payments in Japan. For more information, see Apply for PayPay, which can be viewed in English or Japanese.