Terminal API

E-Money Payments

Use the Square Terminal API to take e-money payments in regions where e-money is available.

E-money card types Permalink Get a link to this section

The Terminal API supports the three e-money brands: iD, QUICPay, and Transportation Group (such as Suica, PASMO, and ICOCA).

Request an e-money Terminal checkout Permalink Get a link to this section

The Terminal API supports e-money by providing the payment_type field in the TerminalCheckout object and the TerminalCheckoutPaymentType enumeration. When a payment_type has any of the four FELICA enumerator values specified in the checkout request, the Terminal accepts the corresponding e-money card types.

The current supported options for payment_type are enumerated by TerminalCheckoutPaymentType and include:

  • CARD_PRESENT. The default option that is automatically set when payment_type is left blank. This option is used to accept credit card or debit card payments using tap, dip, or swipe.

  • FELICA_ALL. Launches a checkout screen on the Square Terminal that allows the buyer to select a specific brand or select the check balance screen. This option is recommended for scenarios where the seller selects the FeliCa brand on the Terminal, before presenting it to the buyer.

  • FELICA_QUICPAY. Launches the QUICPay checkout screen for the buyer to complete. This option is recommended for scenarios where the buyer or seller selects the FeliCa brand on the custom point-of-sale system.

  • FELICA_ID. Launches the iD checkout screen for the buyer to complete. This option is recommended for scenarios where the buyer or seller selects the FeliCa brand on the custom point-of-sale system.

  • FELICA_TRANSPORTATION_GROUP. Launches the Transportation Group checkout screen for the buyer to complete. This option is recommended for scenarios where the buyer or seller selects the FeliCa brand on the custom point-of-sale system.

Requirements and limitations Permalink Get a link to this section

  • Square Terminal must be running version 4.11 or later to accept a FeliCa e-money payment.

  • Square Terminal must be activated and located in Japan.

  • The Square account location must be signed up for e-money in the Square Seller Dashboard.

  • Check Balance must be selected by the buyer on the Terminal device when you provide the FELICA_ALL option and is only supported for Transportation Group cards.