No momento, esta página não está disponível em português
Payment-method icon

Atome for API only

Add Atome to an existing API-only integration.

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.

Requirements

Requirement Description
Integration type Make sure that you have built your API-only integration.
Setup steps Before you begin, contact our Support Team to add Atome in your Customer Area.

Build your payment form for Atome

If you are using /paymentMethods to show which payment methods are available to the shopper,
specify the following combination of countryCode and amount.currency:

Country/region countryCode amount.currency
Malaysia MY MYR
Singapore SG SGD

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:

Parameter Required Description
paymentMethod -white_check_mark- Set to atome.
shopperName -white_check_mark- The shopper's full name.
shopperEmail -white_check_mark- The shopper's email address.
telephoneNumber -white_check_mark- The shopper's phone number.
billingAddress -white_check_mark- The postal address to be included on the invoice.
lineItems -white_check_mark- Price and product information about the purchased items.
returnUrl -white_check_mark- 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 billingAddress and deliveryAddress are the same.

The following example shows how to make a payment of SGD 10.

In the  /payments response, note the `action` object. This contains the information needed to redirect the shopper.

<div data-component-wrapper="code-sample">
<code-sample
    :title="'/payments response'"
    :id="''"
    :code-data="[{&quot;language&quot;:&quot;json&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;{\n   \&quot;resultCode\&quot;:\&quot;RedirectShopper\&quot;,\n   \&quot;action\&quot;:{\n      \&quot;paymentMethodType\&quot;:\&quot;atome\&quot;,\n      \&quot;method\&quot;:\&quot;GET\&quot;,\n      \&quot;url\&quot;:\&quot;https:\/\/checkoutshopper-test.adyen.com\/checkoutshopper\/checkoutPaymentRedirect?redirectData=...\&quot;,\n      \&quot;type\&quot;:\&quot;redirect\&quot;\n   }\n}&quot;}]"
    :enable-copy-link-to-code-block="true"
    :code-sample-card-size="'fullsize'"
></code-sample>

Handle the redirect

  1. To complete the payment, redirect the shopper to the action.url returned in the /payments response, taking into account the following recommendations:

    • When using the HTTP GET method:
      For security reasons, when showing the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.

    • Redirection for mobile integrations:
      For mobile integrations, we strongly recommended that you redirect the shopper to the default browser of their device. Redirecting to the default browser ensures the best compatibility, handling of multi-factor authentication, app-to-app redirection, and error handling.

  2. 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 redirectResult returned when the shopper was redirected back to your site.

  3. In the response note the following:

    • resultCode: use this to present the result to your shopper.
    • pspReference: our unique identifier for the transaction.

Present the payment result

Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.

The 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.
Pending or
Received		 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 have 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.

If the shopper failed to return to your website or app, wait for webhooks to know the outcome of the payment:

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

Partial refunds

To partially refund a payment, specify in your /payments/{paymentPspReference}/refunds request:

  • 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/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.

See also