Configure the app

Configure the Stripe app for Aptos One

After you install the Stripe app for Aptos One, complete the following two steps to configure the integration:

1. Configure the Aptos Solution Builder to register the Stripe app for Aptos One (Payment Sidecar app) as a payment device.
2. Complete the in-app setup to add your Stripe API keys and connect a Terminal reader.

Configure Aptos Solution Builder

You must register the Stripe app for Aptos One in the Aptos One Solution Builder before the app can communicate with the Aptos One SSA.

Create a Payment Application Device

1. In the Aptos One Solution Builder, navigate to Peripherals > Payment Application Device .
2. Create a new device with the following settings:

Configure the URL scheme

Within the same device configuration, set the urlScheme vendor configuration setting to the following value: aptos-payment-sidecar-payment-stripe.

This URL scheme launches and communicates with the Stripe Payment Sidecar app. If you haven’t configured this value, the system defaults to aptos-payment-sidecar.

Configure Interac (Canada only)

If you process Interac payments in Canada, add a custom card type mapping in the vendor configuration:

1. In the device configuration, go to vendorConfiguration > Custom card type to payment method mapping .
2. Add the following mapping:

Configure Stripe API keys

When you first launch the Stripe Payment Sidecar app, it automatically guides you through the following setup steps.

Set up your Stripe account

Before configuring the app, make sure your Stripe account has Terminal enabled:

1. Log in to your Stripe Dashboard .
2. Navigate to Terminal in the main menu.
3. Follow the setup wizard to enable Terminal for your account.
4. Verify that you have administrator permissions to access API keys.

Configure your publishable key

On the Publishable Key screen, enter your Stripe publishable key:

• Use a key beginning with pk _ test _ for test mode.
• Use a key beginning with pk _ live _ for live mode.

Tap Save to continue. The app validates the key format before saving.

To find your publishable key, go to your Stripe Dashboard > Settings > Developers > Manage API keys > API keys.

Configure your restricted key

After saving the publishable key, the app automatically moves to the Restricted Key screen:

• Use a key beginning with rk _ test _ for test mode.
• Use a key beginning with rk _ live _ for live mode.

The app automatically tests the connection to the Stripe API before saving. Tap Save after successful validation. If the key is invalid, you receive an error message and you can enter the key again.

To find your restricted key, go to your Stripe Dashboard > Settings > Developers > Manage API keys > Restricted keys.

Configure your Terminal reader

After you save both keys, the app automatically opens the Terminal Setup screen.

To use a physical reader:

1. Register your reader in the Stripe Dashboard . See Order and return readers for instructions.
2. After registration, make a note of the Terminal ID and Location ID from the Dashboard.
3. On the Terminal Setup screen, enter your Terminal ID and Location ID .
4. Tap Save to complete the setup.

To use simulated mode (for testing):

1. Enable the Simulated mode toggle on the Terminal Setup screen.
2. Tap Save to proceed.

Complete setup

When all configuration steps are complete, the app displays the main status screen showing:

• Stripe API key configuration status
• Terminal connection status
• Current terminal mode (physical or simulated)

Note

The app saves your configuration automatically. On subsequent launches, if everything is properly configured, the app goes directly to the main screen. To reconfigure your settings at any time, use the Reset Keys option in Settings or the Terminal menu option. See App settings and navigation for details.

See also

• App settings and navigation