Docs Home
Dev Essentials
PaymentsCommerceCustomersStaffMerchants
Publish
Release notes

Docs

Docs Home
Dev Essentials
Payments
Commerce
Customers
Staff
Merchants
Publish
Release notes
Overview
Build a Tip Report
Split an Online Payment
Build a Sales Report
Delayed Capture
Partial Payments
Statement Descriptions
ACH Bank Transfer Payment
Afterpay and Clearpay Payments
Cash App Payments
Cash Payments
External Payments
House Accounts
Collect Application Fees
Update Payment and Tip Amounts
Retrieve Payments
Troubleshoot
Webhooks
Refund Payments
Refund a Payment with an App Fee
Retrieve Refunds
Webhooks
Process Disputes
Test in the Sandbox
Take Payments on Hardware
Terminal API
POS Integration
Connect a Square Terminal
Take Payments
Dismiss Terminal Checkouts and Refunds
Terminal Device Monitoring
Save Card on File
Check Device Information
Print or Issue Receipts
Customize the Idle Screen
Confirmation Screen
Signature Capture Screen
Data Collection Screen
Menu Selection List Screen
QR Code Screen
Link and Dismiss Actions
International Payment Methods
Refund Interac Payments
E-Money Payments
PayPay QR Code Payments
Get Credentials
Configure the Sample Application
Take a Cash Payment
Customize the Checkout Amount
Take a Credit Card Payment
How It Works
Build on Android
Build on iOS
Connect a Contactless Reader
Charge a Card on File
Save a Card on File
Configure on iOS for Square Stand
Deauthorize Reader SDK
Capture a Transaction
Delay the Capture of Payments
Configure APK Splits
Update to New Reader SDK Version
Flutter Plugin
React Native Plugin
How It Works
Build on Android
Build on iOS
Build on Mobile Web
Find Your Android Fingerprint
Use the API in Offline Mode
Add an Alert Dialog Helper Class
Accept E-Money Payments
Accept PayPay Payments
Mobile Web Technical Reference
Payments API Integration
Take a Card Payment
Apple Pay
Google Pay
Payment Requests
ACH Bank Transfer
Afterpay
Cash App Pay
Gift Cards Overview
Take a Gift Card Payment
Walkthrough: Partial Payments with Gift Cards
Customize the Card Entry Form
Verify the Buyer
Store Card on File with SCA
Charge Card on File with SCA
Set up the Client
Deploy the Server
Install the SDK
Build on Android
Build on iOS
Apple Pay
Google Pay
Enable SRC for Android
Enable SRC for iOS
Localize an Application
Gift Card Payments
Flutter Plugin
React Native Plugin
Customize the Payment Entry Form
Connect to a Backend Service
Remove the Postal Code Requirement
Troubleshoot
How It Works
Verify Buyer
Quick Pay Checkout
Square Order Checkout
Subscription Plan Checkout
Checkout Settings
Checkout Configurations
Manage Checkout
Guidelines and Limitations
Create and Publish Invoices
Retrieve, List, or Search Invoices
Create or Delete Invoice Attachments
Update Invoices
Cancel or Delete Invoices
Pay or Refund Invoices
Invoices Walkthrough
Subscription Plans and Variations
Manage Subscriptions
Subscription Actions and Events
Pause, Resume, or Cancel Subscriptions
Subscription Billing and Invoices
Swap Subscription Plan Variations
Manage Cards
Create a Card on File from Payment ID
Create a Card on File and a Payment
Create a Shared Card on File and Make a Payment
List Payouts
Get Payout
List Payout Entries
Bank Accounts
How It Works
Build with Mobile Authorization
Get Authorization Code on Command Line
Payment Methods by Country
Payments Pricing
Strong Customer Authentication
Payment Minimums

/

Payments

/

Take Payments on Hardware

/

Terminal API

/

International Payment Methods

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:

Create terminal checkout

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.
On this page
Request a PayPay Terminal checkoutRequirements and limitations