Accept Atome payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.
Before you begin
These instructions explain how to add Atome to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.
Before starting your integration:
- Make sure that you have set up your back end implementation.
- Contact our Support Team to add Atome in your test Customer Area.
Build your payment form for Atome
We provide an Atome logo which you can use on your payment form. For more information, refer to Downloading logos.
To perform risk checks, Atome requires you to collect the following shopper details:
- Shopper's full name
- Email address
- Phone number
- Billing address and delivery address
Make a payment
Make a /payments request from your server, specifying:
||Set to atome.|
|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.|
|returnUrl||The URL where the shopper is redirected back to after completing the payment.|
|deliveryAddress||The postal address where the goods will be shipped. Optional if
Here's an example of how you would make a payment of SGD 10.
The /payments response contains an
action object with the information needed to redirect the shopper.
Handle the redirect
- To complete the payment, redirect the shopper to the
action.urlreturned in the /payments response.
After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
details: Object that contains the URL-decoded
redirectResultreturned when the shopper was redirected back to your site.
You receive a response containing:
resultCode: Use this to present the result to your shopper.
pspReference: Our unique identifier for the transaction.
Present the payment result
resultCode that you received in the /payments/details response to present the payment result to your shopper.
resultCode values you can receive for Atome are:
|resultCode||Description||Action to take|
|Authorised||The payment was successful.||Inform the shopper that the payment was successful.|
|Cancelled||The shopper cancelled the payment.||Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.|
|The shopper has completed the payment but the final result is not yet known. It may take minutes or hours to confirm this.||Inform the shopper that you've received their order, and are waiting for the payment to be completed.
To know the final result of the payment, wait for the AUTHORISATION webhook.
|Refused||The payment was refused by Atome.||Ask the shopper to try the payment again using a different payment method.|
|eventCode||success field||Description||Action to take|
|AUTHORISATION||false||The transaction failed.||Cancel the order and inform the shopper that the payment failed.|
|AUTHORISATION||true||The shopper successfully completed the payment.||Inform the shopper that the payment has been successful and proceed with the order.|
Refunds and cancellations
- amount: The amount to be refunded to the shopper.
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, use a different test account for each country.
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.