📚 Exciting update! A beta version of our docs with new information architecture is now live! 🚀 Take a look!.
Setting up payment service providers
To manage payments and refunds via NewStore Associate App, NewStore
allows you to connect payment devices or terminals to NewStore Associate
App and set up a payment service provider (PSP) for use in your
stores.
Currently, NewStore supports 2 payment service providers:
Square POS: When using Square as a PSP in the store, contact the support team or
see this setup guide .
note
Each Square payment device can only be connected to 1 iPhone at a
time.
Adyen POS: When using Adyen as a PSP in the store, see this Adyen setup guide .
You can connect your Adyen payment device or payment card reader to
NewStore Associate App via either the Adyen Terminal
API or
via Adyen Classic POS Library.
Adyen Terminal API is the modern, cloud-based method to integrate Adyen
payment devices or terminals with NewStore Associate App or other POS
applications.
Important
From January 1, 2022, all payment devices being installed in new stores
via NewStore can only be set up by integrating with the Adyen Terminal
API.
Assign the payment device to your merchant account in Adyen.
note
Payment devices for your business should arrive pre-assigned to your
Adyen merchant account. Validate that the assignment is correct
within the Assign Terminals Area in Adyen and proceed.
Connect the payment device to the internet and verify that it is on a network that allows Associate App to work as well.
For more information, see Adyen's connectivity requirements.
Board the payment terminal for the specific store and configuration
in the Adyen Customer Area. Boarding connects the terminal to the
store and the Adyen server. For more information, see Boarding terminals.
Ensure that your Adyen API credentials has been assigned the
POS Terminal Management API role. For instructions on adding a
role, see the guide on Adyen's API credentials page.
Ensure that the Terminal API and Adyen WebSockets are enabled for
your store and payment terminal. For more information, follow the
instructions in Adyen's setup guide within the
Adyen Customer Area. To set this up, contact the support team and Team Mobile
Apps.
Check that the
icon appears
next to the Wi-Fi icon in the payment device. This indicates that
the terminal is now connected to Adyen and is successfully boarded.
Ensure that your payment device supports the Adyen Terminal API.
Some examples include e285 and e285p.
Important
e355does not support the Terminal API integration.
NewStore Associate App is configured for stores in your business. Ensure
that all terminals in the store support the Terminal API. If you use
payment terminals such as the e355 that do not support the Terminal
API, set up the store and such payment devices using the Adyen Classic
configuration.
Viewing payment devices in NewStore Associate App​
After you have successfully boarded the Adyen payment terminal for the
store and connected to the in-store network, the terminal appears in
NewStore Associate App.
To view a list of terminals in NewStore Associate App, tap
> Credit Card Terminal. All the
payment terminals that have been boarded in your store appear in this
list. You can validate the payment terminals boarded in NewStore
Associate App by checking the terminal ID in the Adyen Customer Area.
Connecting to an Adyen payment terminal during checkout​
To set up a payment device or terminal from the list of terminals
boarded in NewStore Associate App:
Select the Adyen payment terminal, after selecting Credit Card
from the list of payment methods when checking out a cart.
To connect NewStore Associate App to the terminal, select the
terminal from the list and tap Connect to Terminal.
(Optional) You can also connect to a terminal via a QR code. To
connect to the terminal:
On the payment terminal, press 5 +
.
Information about the payment terminal and a QR code is
displayed on the screen of the terminal.
note
You may have to tap the QR code to enlarge it before scanning.
In NewStore Associate App, tap
and scan the QR code of the
payment terminal.
The payment terminal is connected to NewStore Associate App.
The payment terminal can now be used to complete the checkout process in
NewStore Associate App.
NewStore does not support adding payment terminals to new stores via
Adyen Classic after January 2022.
Ensure that you only use Adyen Classic to make changes to existing
Adyen configurations with e355 terminals. To integrate any new Adyen
payment devices, use the Adyen Terminal API.
Assign the payment device to your merchant account in Adyen.
note
Payment devices for your business should arrive pre-assigned to your
Adyen merchant account. Validate that the assignment is correct
within the Assign Terminals Area in Adyen and proceed.
Connect the payment device to the internet and verify that it is on a network that allows Associate App to work as well.
WiFi network as NewStore Associate App. For more information, see
Adyen's connectivity requirements.
Board the payment terminal for the specific store and configuration
in the Adyen Customer Area. Boarding connects the terminal to the
store and the Adyen server. For more information, see Boarding terminals.
Know the IP address of the payment device.
To find the IP address of the assigned to your Adyen payment
terminal, access the device information on the terminal. Follow the
instructions provided in the Adyen Quick Start guide for the
specific device you are trying to board.
Connecting to a payment terminal during checkout​
Important
If this is the first time a payment terminal is being used in the store,
follow instructions from the Adyen boarding guide
to board it. Boarding allows the device to be recognized by NewStore
Associate App for all associates in your store.
After you have boarded a terminal, you can connect it to NewStore
Associate App.
note
Adyen payment terminals connected to NewStore Associate App are saved on
the associate's iPhone, and not account ID. Ensure that each iPhone that
runs the app is connected to the payment terminals being used in the
store. This allows associates to use any of the payment terminals during
a checkout in NewStore Associate App.
To set up a payment device or terminal from the list of terminals
boarded in NewStore Associate App:
Select the Adyen payment terminal, after selecting Credit Card
from the list of payment methods when checking out a cart.
On the payment device, press 5 +
. Information about
the device and a QR code is displayed.
On NewStore Associate App, tap
and scan the QR code on the payment terminal.
note
You may have to tap the QR code to enlarge it before scanning.
The payment terminal is connected to NewStore Associate App.
(Optional) If you cannot scan the QR code on the payment terminal,
add the terminal using the IP address of the device:
In NewStore Associate App, tap
> Configure Card Reader.
Tap Add Card Reader.
Type the IP address of the device.
The payment terminal is connected to NewStore Associate App.
You can access payment terminals that have already been connected to
NewStore Associate App from the Recently Used section.
You may have to contact your IT support team or the NewStore support team for
help with troubleshooting.
When using NewStore Associate App in iOS 13, some Verifone e355 devices may return an error with
this text: The certificate for this server is invalid.
To fix the error, contact Adyen support and request them to set the
device property webService.useLegacyCertificate to false.