Regional considerations

Integrate Terminal in Canada

Stripe supports Visa, Mastercard, American Express, Discover, and Interac payments in Canada. All transactions must be made in Canadian dollars (CAD). To accept Terminal charges in Canada, either your platform account or connected account must be in Canada.

Use locations

Create Locations for your business with addresses in Canada and associate your readers to them. This will ensure that they automatically download the configuration needed to properly process charges in Canada.

A valid address for a Location in Canada must contain the line1, city, state, postal_code, and country properties.

curl https://api.stripe.com/v1/terminal/locations \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -d "display_name"="HQ" \
  -d "address[line1]"="3040 Bur Oak Ave" \
  -d "address[city]"="Markham" \
  -d "address[state]"="ON" \
  -d "address[country]"="CA" \
  -d "address[postal_code]"="L6B 0R1" \

Reader software version

Verifone P400 readers operating in Canada must use the reader software version 3.0.1.15 or later. Read about Verifone P400 software updates for details.

Similarly, BBPOS WisePad 3 readers must use the reader software version 4.01.00.28_Prod_NA_off_v7_480001 or later. Read about BBPOS WisePad 3 software updates for details.

Translation

Language regulations require that services, including point-of-sale services, be provided in French unless English has been agreed upon by the cardholder and their card issuer. Terminal is built to help you comply with these requirements if they apply to your business.

Default reader language

The Verifone P400 interface displays text in French in addition to English if it is registered to a location with an address in Canada.

The BBPOS WisePOS E supports changing reader language in the Settings panel. Swipe right across the screen to access the Settings panel, and select your language.

The BBPOS WisePad 3 supports changing reader language directly in the reader interface. After you have registered your reader to a Location with an address in Canada, the reader installs a language pack relevant for your region if one isn’t already in place. To view available language options and to select a language, click the Power / Settings button and scroll down using the arrow keys until you reach the language selection menu. Highlight your desired language and press the green Enter key.

Transaction language

After the cardholder has presented their card, the reader determines the cardholder’s preferred language. Each screen after that point is translated according to the cardholder’s preferences.

Other translations

If you’re required to provide services in or would like to translate text into French in addition to English, ensure that any of your custom reader screens and receipts display the appropriate translations.

Interac payments

Interac is the interbank network that handles routing of debit payments in Canada. Consumer debit cards in Canada are branded with an Interac logo and may also be co-branded with another payment network’s logo. Even if the card is co-branded, however, all Interac debit transactions must be routed through Interac. To maximize card acceptance, you should build Interac support into your integration.

Create a PaymentIntent

To accept Interac transactions you need to create your payments using the interac_present payment method type. Include the card_present payment method type as well if you accept Visa, Mastercard, and American Express payments.

Client-side

Create a PaymentIntent from your client using the iOS, Android, or React Native SDK:

Server-side

The JavaScript SDK and the server-driven integration require you to create the PaymentIntent on your server. For iOS, Android, or React Native, you can create the PaymentIntent on your server if the information required to start a payment isn’t readily available in your app.

curl https://api.stripe.com/v1/payment_intents \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc: \
  -d amount=999 \
  -d currency=cad \
  -d "payment_method_types[]"=card_present \
  -d "payment_method_types[]"=interac_present \
  -d capture_method=manual

Collect and process a payment

After you process the payment, the reader determines whether to route the payment across Interac rails based on the profile of the card presented.

In cases where the Interac card is co-branded, the payment_method_details.interac_present.brand field on a PaymentIntent’s returned charge reports the co-brand. The type field on the payment_method for an Interac transaction is always interac_present.

There are further Interac requirements that Stripe handles automatically for you, without additional integration work on your side:

• Before a card is presented, on-screen prompts are in the default reader language. After the card information has been collected, the localization is based on the language preference specified by the presented card.
• The reader automatically prompts for PIN in cases where it is required.
• Interac Flash (contactless) payments are limited to 250 CAD and generally up to three consecutive transactions. Transactions higher than 100 CAD or the fourth contactless transaction in a row require the customer to insert their Interac card and enter their PIN.

Capture and reconcile

Unlike Visa, Mastercard, and American Express transactions, Interac transactions are authorized and automatically captured in a single step. Your application shouldn’t continue to capture the PaymentIntent – if you attempt to capture an interac_present payment, the Stripe API returns an error. Be careful to prevent unintended and duplicate payments in your integration; if failures or declines occur while processing Interac, you can attempt to re-use the same PaymentIntent from the original transaction to safeguard against double-charging.

Refund an Interac payment

In-person refunds are mandatory for Interac transactions in Canada. You can’t create refunds in the API or in the Dashboard for these payments. In this flow, the reader prompts the cardholder to present the card used in the original charge. After the card details are read successfully, your application processes the refund. Like online refunds, you can perform partial refunds by passing in an amount less than the transaction value.

The currency and the card used for refund processing must match those of the original charge, otherwise the request fails with an error.

As a fallback, you can offer refunds to different payment methods such as store credit or cash.

curl https://api.stripe.com/v1/terminal/readers/tmr_xxx/refund_payment \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc: \
  -d payment_intent=pi_xxx \
  -d amount=2000

{
  "id": "tmr_xxx",
  "object": "terminal.reader",
  "action": {
    "type": "refund_payment",
    "refund_payment": {
      "payment_intent": "pi_xxx"
    },
    "status": "in_progress",
    "failure_code": null,
    "failure_message": null
  },
  …
}

curl https://api.stripe.com/v1/test_helpers/terminal/readers/tmr_xxx/present_payment_method \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc: \
  -d type=interac_present