For shoppers with visual impairments, you can turn on accessibility mode through the payment request from your POS app. The payment terminal then provides audio instructions during the payment. The payment request needs to include an encoded object to turn on accessibility mode.
Requirements
Before you begin, take into account the following requirements, limitations, and preparations.
| Requirement | Description |
|---|---|
| Integration type | A Terminal API integration with payment terminals. |
| Hardware | Accessibility mode is supported on Android terminal models:
|
| Limitations | Accessibility mode is not compatible with:
|
| Setup steps | Contact our Support Team:
|
How it works
-
You make a payment request with a Base64-encoded
Operationobject to turn on accessibility mode. -
The terminal reads out the text shown on the terminal screen, and instructs the shopper on how to present their payment card.
The timeout period is extended to give the shopper time to listen to the audio instructions. -
The shopper presents their card to complete the payment.
-
Accessibility mode turns off automatically.
Make an accessible payment from the POS app
After accessibility mode is enabled by our Support Team, you are ready to make a payment request with a Base64-encoded Operation object to turn on accessibility mode for a specific payment.
-
Create an
OperationJSON object with theOperation.Type: Payment andOperation.Variant: EnableAccessibilityMode: -
Encode the
OperationJSON object to Base64. You will pass the resulting string inSaleData.SaleToPOIData. -
Make a payment request, specifying:
-
The standard
SaleToPOIRequest.MessageHeaderobject, withMessageClassset to Service andMessageCategoryset to Payment.Parameter Required Description ProtocolVersion
3.0 MessageClass
Service MessageCategory
Payment MessageType
Request ServiceID
Your unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal ( POIID) being used.SaleID
Your unique ID for the POS system component to send this request from. POIID
The unique ID of the terminal to send this request to. Format: [device model]-[serial number]. -
The PaymentRequest object with:
Parameter Description SaleData.SaleTransactionIDAn object with: TransactionID: your reference to identify a payment. We recommend using a unique value per payment. In your Customer Area and Adyen reports, this will show as the merchant reference for the transaction.TimeStamp: date and time of the request in UTC format.
SaleData.SaleToPOIDataThe Base64-encoded Operationobject.PaymentTransaction.AmountsReqAn object with: Currency: the transaction currency.RequestedAmount: the purchase amount, with decimals.
The payment response is the same as with a regular payment. The terminal exits the accessibility mode after a successful or canceled payment.
-