Alipay Drop-in integration

Our iOS Drop-in renders Alipay in your payment form, and redirects the shopper to complete the payment. As with other redirect payment methods, you need to handle the redirect result after the shopper returns to your app.

Before you begin

This page explains how to add Alipay to your existing iOS Drop-in integration. The iOS Drop-in integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Drop-in integration guide.

Before starting your Alipay integration:

1. Make sure that you have set up your back end implementation, and added Drop-in to your payment form.
2. Add Alipay in your test Customer Area.

Show Alipay in your payment form

Drop-in uses the countryCode and the amount.currency from your /paymentMethods request to show the available payment methods to your shopper.

To show Alipay in your payment form, specify in your /paymentMethods request:

• countryCode: The country where the shopper is, in this case a supported country outside of China, for example NL.
• amount.currency: Any supported currency. For example, EUR. See Processing currencies for ecommerce for more information.

After the shopper selects Alipay, Drop-in invokes the didSubmit method which contains data.paymentMethod. Pass data.paymentMethod to your server and make a payment request.

Make a payment

When the shopper proceeds to pay, Drop-in invokes the didSubmit method which contains data.paymentMethod.

1. Pass data.paymentMethod to your server.

2. From your server, make a /payments request, specifying:

   • paymentMethod: The data.paymentMethod from the didSubmit event from your client app.
   curl Ruby Java PHP Python C# NodeJS Go

   curl Ruby Java PHP Python C# NodeJS Go

   curl https://checkout-test.adyen.com/v68/payments \
   -H "x-API-key: YOUR_X-API-KEY" \
   -H "content-type: application/json" \
   -d '{
     "amount":{
       "currency":"CNY",
       "value":1000
     },
     "reference":"YOUR_ORDER_NUMBER",
     "paymentMethod":{hint:paymentMethod field of an object passed from the front end or client app}STATE_DATA{/hint},
     "returnUrl":"my-app://",
     "merchantAccount":"YOUR_MERCHANT_ACCOUNT"
   }'

   require 'adyen-ruby-api-library'
   
   # Set your X-API-KEY with the API key from the Customer Area.
   adyen = Adyen::Client.new
   adyen.env = :test
   adyen.api_key = "YOUR_X-API-KEY"
   
   # STATE_DATA is the paymentMethod field of an object passed from the front end or client app, deserialized from JSON to a data structure.
   paymentMethod = STATE_DATA
   
   response = adyen.checkout.payments({ 
       :paymentMethod => paymentMethod,
       :amount => {
           :currency => 'CNY',
           :value => 1000
       },
       :reference => 'YOUR_ORDER_NUMBER',
       :returnUrl => 'my-app://',
       :merchantAccount => 'YOUR_MERCHANT_ACCOUNT'
   })
   
   # Check if further action is needed.
   if response.body.has_key(:action)
      # Pass the action object to your front end
      # response.body[:action]
   else
      # No further action needed, pass the resultCode object to your front end
      # response.body[:resultCode]

   // Set your X-API-KEY with the API key from the Customer Area.
   String xApiKey = "YOUR_X-API-KEY";
   Client client = new Client(xApiKey,Environment.TEST);
   Checkout checkout = new Checkout(client);
   PaymentsRequest paymentsRequest = new PaymentsRequest();
   paymentsRequest.setMerchantAccount("YOUR_MERCHANT_ACCOUNT");
   // STATE_DATA is the paymentMethod field of an object passed from the front end or client app, deserialized from JSON to a data structure.
   paymentsRequest.setPaymentMethod(STATE_DATA)
   Amount amount = new Amount();
   amount.setCurrency("CNY");
   amount.setValue(1000L);
   paymentsRequest.setAmount(amount);
   paymentsRequest.setReference("YOUR_ORDER_NUMBER");
   paymentsRequest.setReturnUrl("my-app://");
   PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);

   // Set your X-API-KEY with the API key from the Customer Area.
   $client = new \Adyen\Client();
   $client->setEnvironment(\Adyen\Environment::TEST);
   $client->setXApiKey("YOUR_X-API-KEY");
   $service = new \Adyen\Service\Checkout($client);
   
   // STATE_DATA is the paymentMethod field of an object passed from the front end or client app, deserialized from JSON to a data structure.
   $paymentMethod = STATE_DATA;;
   
   $params = array(
       "paymentMethod" => $paymentMethod,
       "amount" => array(
           "currency" => "CNY",
           "value" => 1000
       ),
       "reference" => "YOUR_ORDER_NUMBER",
       "returnUrl" => "my-app://",
       "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
   );
   $result = $service->payments($params);
   
   // Check if further action is needed
   if (array_key_exists("action", $result)){
      // Pass the action object to your front end
      // $result["action"]
   }
   else {
      // No further action needed, pass the resultCode to your front end
      // $result['resultCode']
   }

   # Set your X-API-KEY with the API key from the Customer Area.
   adyen = Adyen.Adyen()
   adyen.payment.client.platform = "test"
   adyen.client.xapikey = 'YOUR_X-API-KEY'
   
   # STATE_DATA is the paymentMethod field of an object passed from the front end or client app, deserialized from JSON to a data structure.
   paymentMethod = STATE_DATA
   
   result = adyen.checkout.payments({
       'paymentMethod': paymentMethod,
       'amount': {
           'value': 1000,
           'currency': 'CNY'
       },
       'reference': 'YOUR_ORDER_NUMBER',
       'returnUrl': 'my-app://',
       'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
   })
   
   # Check if further action is needed
   if 'action' in result.message:
      # Pass the action object to your front end
      # result.message['action']
   else:
      # No further action needed, pass the resultCode to your front end
      # result.message['resultCode']

   // Set your X-API-KEY with the API key from the Customer Area.
   string apiKey = "YOUR_X-API-KEY";
   var client = new Client (apiKey, Environment.Test);
   var checkout = new Checkout(client);
   var amount = new Adyen.Model.Checkout.Amount("CNY", 1000);
   var paymentRequest = new Adyen.Model.Checkout.PaymentRequest
   { 
   // STATE_DATA is the paymentMethod field of an object passed from the front end or client app, deserialized from JSON to a data structure.
       PaymentMethod = STATE_DATA,
       Amount = amount,
       Reference = "YOUR_ORDER_NUMBER",
       ReturnUrl = @"my-app://",
   };
   var paymentResponse = checkout.Payment(paymentRequest);

   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 = '[YOUR_X-API-KEY]';
   config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
   const client = new Client({ config });
   client.setEnvironment("TEST");
   const checkout = new CheckoutAPI(client);
   checkout.payments({
       merchantAccount: config.merchantAccount,
   // STATE_DATA is the paymentMethod field of an object passed from the front end or client app, deserialized from JSON to a data structure.
       paymentMethod: STATE_DATA,
       amount: { currency: "CNY", value: 1000, },
       reference: "YOUR_ORDER_NUMBER",
       returnUrl: "my-app://"
   }).then(res => res);

   import (
       "github.com/adyen/adyen-go-api-library/v5/src/checkout"
       "github.com/adyen/adyen-go-api-library/v5/src/common"
       "github.com/adyen/adyen-go-api-library/v5/src/adyen"
   )
   // Set your X-API-KEY with the API key from the Customer Area.
   client := adyen.NewClient(&common.Config{
       Environment: common.TestEnv,
       ApiKey:      "[YOUR_X-API-KEY]",
   })
   // STATE_DATA is the paymentMethod field of an object passed from the front end or client app, deserialized from JSON to a data structure.
   paymentMethod := STATE_DATA
   res, httpRes, err := client.Checkout.Payments(&checkout.PaymentRequest{
       PaymentMethod: paymentMethod,
       Amount: checkout.Amount{
           Value:    1000,
           Currency: "EUR",
       },
       Reference: "YOUR_ORDER_NUMBER",
       ReturnUrl: "my-app://",
       MerchantAccount: "[YOUR_MERCHANT_ACCOUNT]",
   })

   https://docs.adyen.com/pt/pt/payment-methods/alipay/ios-drop-in#payments-request-component

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

   /payments response

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

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

3. Pass the action object to your client app. Drop-in needs this to redirect the shopper to Alipay.

Handle the redirect result

Drop-in redirects the shopper to the Alipay app or website where they complete the payment.  

1. To inform Drop-in when the shopper returns to your app, implement the following in your UIApplicationDelegate:

func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey: Any] = [:]) -> Bool {
    RedirectComponent.applicationDidOpen(from: url)
    return true
}

After Drop-in completes the action, it invokes the didProvide method.

2. From your server, make a POST /payments/details request providing the data from the didProvide method from your client app.

  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=="
     }
  }'

You receive a response containing:

• resultCode: Use this to present the result to your shopper.
• pspReference: Our unique identifier for the transaction.
  /payments/details response

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

  https://docs.adyen.com/pt/pt/payment-methods/clearpay/ios-drop-in#-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 Alipay are:

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

Test and go live

Use the following credentials to test Alipay:

Check the status of Alipay test payments in your Customer Area > Transactions > Payments.

Before you can accept live Alipay payments, you need to submit a request for Alipay in your live Customer Area.

See also