This page explains how to add Atome to your existing Web Components integration.
Requirements
Select the server-side flow that your integration uses:
Requirement | Description |
---|---|
Integration type | Make sure that you have built a Sessions flow Web Components integration. |
Setup steps | Before you begin, contact our Support Team to add Atome in your Customer Area. |
Import resources for v6
If you are using Web Components v6, import the Component that you need for Atome:
import { AdyenCheckout, Atome } from '@adyen/adyen-web'
API reference
Select which endpoint you are using:
This is the default with Components v5.0.0 or later.
When making an Atome payment, you need to:
- Collect shopper details, and specify these in your payment request. Atome uses these for risk checks.
- Provide information about the purchased items.
-
Make sure that you use a supported combination of country/region and currency:
Country/region countryCode
amount.currency
Malaysia MY MYR Singapore SG SGD
Parameter | Required | Description |
---|---|---|
shopperName | The shopper's full name. | |
shopperEmail | The shopper's email address. | |
telephoneNumber | The shopper's phone number. | |
billingAddress | The postal address to be included on the invoice. | |
lineItems | Price and product information about the purchased items. | |
deliveryAddress | The postal address where the goods will be shipped. Optional if billingAddress and deliveryAddress are the same. |
curl https://checkout-test.adyen.com/v69/sessions \ -H 'x-api-key: ADYEN_API_KEY' \ -H 'content-type: application/json' \ -d '{ "amount":{ "value":1000, "currency":"SGD" }, "shopperName":{ "firstName":"Simon", "lastName":"Hopper" }, "shopperEmail":"s.hopper@example.com", "shopperReference":"", "reference":"YOUR_ORDER_REFERENCE", "merchantAccount":"YOUR_MERCHANT_ACCOUNT", "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy..", "countryCode":"SG", "telephoneNumber":"6512345678", "billingAddress":{ "city":"Singapore", "country":"SG", "houseNumberOrName":"109", "postalCode":"179097", "stateOrProvince":"Singapore", "street":"North Bridge Road" }, "deliveryAddress":{ "city":"Singapore", "country":"SG", "houseNumberOrName":"109", "postalCode":"179097", "stateOrProvince":"Singapore", "street":"North Bridge Road" }, "lineItems":[ { "description":"Shoes", "quantity":"1", "amountIncludingTax":"400", "amountExcludingTax": "331", "taxAmount": "69", "id":"Item #1" }, { "description":"Socks", "quantity":"2", "amountIncludingTax":"300", "amountExcludingTax": "248", "taxAmount": "52", "id":"Item #2" } ] }'
Component configuration
Step 1: Create a DOM element
Create a DOM element on your checkout page, placing it where you want the payment method form to be rendered:
<div id="atome-container"></div>
Step 2: Create an instance of the Component
v6.0.0 or later
Create an instance of the Component, passing:
- Your instance of
AdyenCheckout
.
const atome = new Atome(checkout).mount('#atome-container');
Test and go live
To test Atome payments, you need a test shopper account in the Atome sandbox environment. To request a test account, reach out to your Adyen contact. If you are testing in multiple countries/regions, use a different test account for each location.
To test the QR code flow, download one of the following test apps:
For Malaysia (MY)
For Singapore (SG)
You can check the status of test payments in your Customer Area > Transactions > Payments.
To accept live Atome payments, you must contact our Support Team to add Atome in your live Customer Area.