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

Atome Redirect Component

Add Atome to an existing Components integration.

You can use our Redirect Component to handle the redirect to Atome.

When adding Atome to your existing Components integration, you also need to:

Show Atome in your payment form.
Collect shopper details, and specify these in your payment request.
Atome uses these for risk checks.
Provide information about the purchased items in your payment request.
Handle the redirect result when the shopper returns to your website.

Before you begin

This page explains how to add Atome to your existing Android Components integration. The Android Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your Atome integration:

Make sure that you have set up your back end implementation for making API requests.
Contact our Support Team to add Atome in your test Customer Area.

Show Atome in your payment form

Include Atome in the list of available payment methods, and collect the required shopper details:

Specify in your /paymentMethods request one of the following combinations of countryCode and amount.currency:

Country countryCode amount.currency
Malaysia MY MYR
Singapore SG SGD

The response contains paymentMethod.type: atome.
Collect the following shopper details:
- Full name
- Email address
- Billing address and delivery address.
Atome uses these information for risk checks.

We provide an Atome logo which you can use on your payment form. For more information, refer to Downloading logos.

Make a payment

When the shopper proceeds to pay, make a /payments request from your server, specifying:

Parameter	Required	Description
`paymentMethod`		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 `billingAddress` and `deliveryAddress` are the same.

curl https://checkout-test.adyen.com/v68/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "paymentMethod":{
    "type":"atome"
  },
  "amount":{
     "value":1000,
     "currency":"SGD"
  },
  "shopperName":{
     "firstName":"Simon",
     "lastName":"Hopper"
  },
  "shopperEmail":"s.hopper@example.com",
  "shopperReference":"YOUR_UNIQUE_SHOPPER_ID",
  "reference":"YOUR_ORDER_REFERENCE",
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "returnUrl":"adyencheckout://your.package.name",
  "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"
     }
  ]
}'

# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT",
  :reference => "YOUR_ORDER_NUMBER",
  :amount => {
    :currency => "SGD",
    :value => 1000
  },
  :paymentMethod => {
    :type => "atome"
  },
  :returnUrl => "adyencheckout://your.package.name",
  :countryCode => "SG",
  :shopperName => [
    :firstName => "Simon",
    :lastName => "Hopper"
  ],
  :shopperEmail => "s.hopper@example.com",
  :shopperReference => "YOUR_UNIQUE_SHOPPER_ID",
  :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"
    }
  ]
})

// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
Checkout checkout = new Checkout(client);

PaymentsRequest paymentsRequest = new PaymentsRequest();

String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
paymentsRequest.setMerchantAccount(merchantAccount);

Amount amount = new Amount();
amount.setCurrency("SGD");
amount.setValue(1000L);
paymentsRequest.setAmount(amount);

DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
paymentMethodDetails.setType("atome");
paymentsRequest.setPaymentMethod(paymentMethodDetails);

paymentsRequest.setReference("YOUR_ORDER_NUMBER");
paymentsRequest.setReturnUrl("adyencheckout://your.package.name");

Name shopperDetails = new Name();
shopperDetails.setFirstName("Simon");
shopperDetails.setLastName("Hopper");

paymentsRequest.setShopperName(shopperDetails);
paymentsRequest.setShopperReference("YOUR_UNIQUE_SHOPPER_ID");
paymentsRequest.setCountryCode("SG");
paymentsRequest.setTelephoneNumber("6512345678");
paymentsRequest.setShopperEmail("s.hopper@example.com");

BillingAddress billingAddress = new BillingAddress();
billingAddress.setCountry("SG");
billingAddress.setCity("Singapore");
billingAddress.setHouseNumberOrName("109");
billingAddress.setStreet("North Bridge Road");
billingAddress.setPostalCode("179097");
billingAddress.setStateOrProvince("Singapore");

paymentsRequest.setBillingAddress(billingAddress);

DeliveryAddress deliveryAddress = new DeliveryAddress();
deliveryAddress.setCountry("SG");
deliveryAddress.setCity("Singapore");
deliveryAddress.setHouseNumberOrName("109");
deliveryAddress.setStreet("North Bridge Road");
deliveryAddress.setPostalCode("179097");
deliveryAddress.setStateOrProvince("Singapore");

paymentsRequest.setDeliveryAddress(deliveryAddress);

List<LineItem> lineItems = new ArrayList<>();
lineItems.add(
        new LineItem()
                .quantity(1L)
                .description("Shoes")
                .id("Item #1")
                .amountIncludingTax(400L)
                .amountExcludingTax(331L)
                .taxAmount(69L)
);
lineItems.add(
        new LineItem()
            .quantity(2L)
            .description("Socks")
            .id("Item #2")
            .amountIncludingTax(300L)
            .amountExcludingTax(248L)
            .taxAmount(52L)
);

paymentsRequest.setLineItems(lineItems);

PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);

// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = [
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT",
  "reference" => "YOUR_ORDER_NUMBER",
  "amount" => [
    "currency" => "SGD",
    "value" => 1000
  ],
  "paymentMethod" => [
    "type" => "atome"
  ],
  "returnUrl" => "adyencheckout://your.package.name",
  "countryCode" => "SG",
  "shopperName" => [
       "firstName" => "Simon",
       "lastName" => "Hopper"
  ],
  "shopperEmail" => "s.hopper@example.com",
  "shopperReference" => "YOUR_UNIQUE_SHOPPER_ID",
  "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"
     ]
    ]
];
$result = $service->payments($params);

#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
   "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
   "reference": "YOUR_ORDER_NUMBER",
   "amount": {
      "value": 1000,
      "currency": "SGD"
   },
   "paymentMethod": {
      "type": "atome"
   },
   "returnUrl": "adyencheckout://your.package.name",
   "countryCode":"SG",
   "shopperName": {
      "firstName":"Simon",
      "lastName":"Hopper"
   },
   "shopperEmail":"s.hopper@example.com",
   "shopperReference":"YOUR_UNIQUE_SHOPPER_ID",
   "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"
      }
   ]
})

// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);

var paymentsRequest = new Adyen.Model.Checkout.PaymentRequest
{
   MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
   Reference = "YOUR_ORDER_REFERENCE",
   PaymentMethod = new DefaultPaymentMethodDetails { Type = "atome" },
   Amount = new Adyen.Model.Checkout.Amount(currency: "SGD", value: 1000),
   CountryCode = "SG",
   TelephoneNumber = "6512345678",
   ShopperEmail = "s.hopper@example.com",
   ShopperName = new Adyen.Model.Checkout.Name
   {
       FirstName = "Simon",
       LastName = "Hopper"
   },
   ShopperReference = "YOUR_UNIQUE_SHOPPER_ID",
   BillingAddress = new Adyen.Model.Checkout.Address
   {
       City = "Singapore",
       Country = "SG",
       HouseNumberOrName = "109",
       PostalCode = "179097",
       StateOrProvince = "Singapore",
       Street = "North Bridge Road"
   },
   DeliveryAddress = new Adyen.Model.Checkout.Address
   {
       City = "Singapore",
       Country = "SG",
       HouseNumberOrName = "109",
       PostalCode = "179097",
       StateOrProvince = "Singapore",
       Street = "North Bridge Road"
   },
   ReturnUrl = "adyencheckout://your.package.name",
   LineItems = new List<LineItem>
   {
     new LineItem(quantity:1, description: "Shoes", id: "Item #1", amountIncludingTax: 400, amountExcludingTax: 331, taxAmount: 69),
     new LineItem(quantity:2, description: "Socks", id: "Item #2", amountIncludingTax: 300, amountExcludingTax: 248, taxAmount: 52)
   }
};

// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: {
       currency: "SGD",
       value: 1000
    },
    paymentMethod: {
        type: 'atome'
    },
    reference: "YOUR_ORDER_NUMBER",
    shopperReference: "YOUR_UNIQUE_SHOPPER_ID",
    merchantAccount: config.merchantAccount,
    returnUrl: "adyencheckout://your.package.name",
    countryCode: "SG",
    shopperName: {
        firstName: "Simon",
        lastName: "Hopper"
    },
    shopperEmail: "s.hopper@example.com",
    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"
       }
    ]
}).then(res => res);

https://docs.adyen.com/pt/pt/payment-methods/atome/android-component#payments

The /payments response contains an action object with the information needed to redirect the shopper.

{
   "resultCode":"RedirectShopper",
   "action":{
      "paymentMethodType":"atome",
      "method":"GET",
      "url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=...",
      "type":"redirect"
   }
}

https://docs.adyen.com/pt/pt/payment-methods/online-banking-thailand/api-only#-payments-response

Pass the action object to your client app. You need this to initialize the Redirect Component.

Handle the redirect

Use the Redirect Component to redirect the shopper to Atome.
After the shopper returns to your app, make a POST /payments/details request from your server, providing:
- details: The actionComponentData.details object from the Redirect Component.
/payments/details request
curl https://checkout-test.adyen.com/v68/payments/details \ -H "x-API-key: YOUR_X-API-KEY" \ -H "content-type: application/json" \ -d '{ "details": { "redirectResult": "eyJ0cmFuc1N0YXR1cyI6IlkifQ==" } }'
https://docs.adyen.com/pt/pt/payment-methods/online-banking-thailand/android-component#-payments-details-request

You receive a response containing:

resultCode: Use this to present the payment result to your shopper.
pspReference: Our unique identifier for the transaction.

{
      "resultCode": "Authorised",
      "pspReference": "PPKFQ89R6QRXGN82"
}

https://docs.adyen.com/pt/pt/payment-methods/online-banking-thailand/android-component#-payments-details-response

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'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.

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, 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.