Learn how to set up Japan's PayPay payment method to accept QR code payments using the Terminal API.
Terminal API

PayPay QR Code Payments

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

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:

Create Terminal Checkout
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
curl https://connect.squareup.com/v2/terminals/checkouts \
  -X POST \
  -H 'Square-Version: 2022-09-21' \
  -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"
  }'

  • 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.

If you need more assistance, contact Developer Support or ask for help in the Developer Forums.