TWINT Component

Our TWINT Component renders TWINT in your payment form. When making a TWINT payment, you additionally need to use createFromAction to redirect the shopper to Twint.

Before you begin

This page explains how to add TWINT to your existing Web Components integration. The Web 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 TWINT integration:

1. Make sure that you have set up your back end implementation, and created an instance of AdyenCheckout.
2. Add TWINT in your Customer Area.
   

Show TWINT in your payment form

To present the TWINT Component in your payment form:

1. From your server, make a POST /paymentMethods request specifying:

   • countryCode: CH.
   • amount.currency: CHF.
   • amount.value: The value of the payment, in minor units.

2. Pass the full response from the /paymentMethods call as the paymentMethodsResponse object when creating an instance of the AdyenCheckout.

3. Add the TWINT Component:
   a. Create a DOM element for TWINT, placing it where you want the form to be rendered:

   <div id="twint-container"></div>

   b. Create and mount an instance of the TWINT Component using its component name, twint. This renders a button on your payment form.

   function handleOnSubmit(state, component) {
       // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
       state.isValid // True or false. Specifies if all the information that the shopper provided is valid.
       state.data // Provides the data that you need to pass in the `/payments` call.
       component // Provides the active component instance that called this event.
   }
   const twintComponent =  checkout.create('twint', {
       onSubmit: handleOnSubmit // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
   }).mount('#twint-container');

   When the shopper selects the payment method, the Component calls the onSubmit event, which contains a state.data object including the shopper's selected payment method. If your integration is set up correctly, the state.data is passed on to your server.

Make a payment

When a shopper chooses to pay with TWINT, the Component redirects them to the TWINT webpage. Depending on how they are accessing your site:

• For shoppers on mobile, the TWINT webpage offers to open the TWINT app or copy the short code.
• For shoppers on desktop or laptop, the TWINT webpage offers to scan the QR code with their TWINT app or copy the short code.

1. Make a POST /payments request, specifying:
   • paymentMethod: The state.data.paymentMethod from the onSubmit event from your front end.
   • returnUrl: The URL where the shopper will be redirected back to after completing the payment. Make sure that the returnUrl uses HTTPS.

Here is how you would make a payment request for TWINT for 10 CHF.

curl https://checkout-test.adyen.com/v68/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
    "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
    "reference": "YOUR_ORDER_NUMBER",
    "amount": {
        "currency": "CHF",
        "value": 1000
    },
    "countryCode": "CH",
    "returnUrl": "https://your-company.com/checkout?shopperOrder=12xy..",
    "paymentMethod": {
        "type": "twint"
    }
}'

# 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({
  :amount => {
    :currency => "CHF",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "twint"
  },
  :countryCode => "CH",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT",
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy.."
})

// 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("CHF");
    amount.setValue(1000L);
    paymentsRequest.setAmount(amount);

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

    paymentsRequest.setReference("YOUR_ORDER_NUMBER");
    paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");
    paymentsRequest.setCountryCode("CH");

    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 = array(
  "amount" => array(
    "currency" => "CHF",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "type" => "twint"
  ),
  "countryCode" => "CH",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT",
  "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy.."
);
$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({
   'amount': {
      'value': 1000,
      'currency': 'CHF'
   },
   'reference': 'YOUR_ORDER_NUMBER',
   'paymentMethod': {
      'type': 'twint'
   },
   'countryCode': 'CH',
   'merchantAccount': 'YOUR_MERCHANT_ACCOUNT',
   'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..'
})

// 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 amount = new Model.Checkout.Amount("CHF", 1000);
var details = new Model.Checkout.DefaultPaymentMethodDetails{
  Type = "twint"
};
var paymentRequest = new Adyen.Model.Checkout.PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  Amount = amount,
  CountryCode = "CH",
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  PaymentMethod = details,
  ReturnUrl = "https://your-company.com/checkout?shopperOrder=12xy.."
};

var paymentResponse = checkout.Payments(paymentsRequest);

// 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: "CHF", value: 1000 },
    paymentMethod: {
        type: 'twint'
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    countryCode: "CH",
    returnUrl: "https://your-company.com/checkout?shopperOrder=12xy.."
}).then(res => res);

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

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

If your integration is set up correctly, the action object is passed from your server to the client.

Handle the redirect result

Handling the redirect works the same way for all redirect payment methods:

1. Call createFromAction, passing the action object from the previous step. This will return a new Component that you need to mount:

   checkout.createFromAction(action).mount('#my-container');

   The Component redirects the shopper to complete the payment.
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.
   /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/twint/web-component#-payments-details-request
   The /payments/details response contains:
   • resultCode: Use this to present the payment result to your shopper.
   • pspReference: Our unique identifier for the transaction.
   /payments/details response

   {
       "resultCode": "Authorised",
       "pspReference": "88154795347618C"
   }

   https://docs.adyen.com/pt/pt/payment-methods/twint/web-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.

You will also receive the outcome of the payment asynchronously in a notification webhook.

The resultCode values you can receive for TWINT are:

If the shopper failed to return to your website or app, wait for notification webhooks to know the outcome of the payment. The notification webhooks you can receive for TWINT are:

Capture the payment

By default, TWINT payments are captured automatically. This means that the Capture Delay setting in your Customer Area is set to Immediate or 1–7 days.
In case Capture Delay is set to Manual, then you need to manually capture the payment. The authorization for TWINT payments expires after 7 days, so make sure you capture the payment before then.

Partial capture

To partially capture a TWINT payment, specify in your /payments/{paymentPspReference}/captures request:

• modificationAmount: The amount that the shopper should pay.

The following example shows how to make a partial capture request:

{
   "originalReference":"PSP_REFERENCE",
   "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
   "modificationAmount":{
      "currency":"CHF",
      "value":"700"
   },
   "reference":"YOUR_CAPTURE_REFERENCE"
}

Any unclaimed amount that is left over after partially capturing a payment is automatically cancelled.

Test and go live

Check the status of TWINT test payments in your Customer Area > Transactions > Payments.
Before you can accept live TWINT payments, you need to submit a request for TWINT in your live Customer Area.

See also