Atenção, esta página não se encontra disponível em Português

TWINT Drop-in integration

Add TWINT to an existing Drop-in integration.

Our Web Drop-in renders TWINT in your payment form, and redirects the shopper to the TWINT webpage where they finalize the purchase. As with other redirect payment methods, you need to handle the redirect result after the shopper returns to your website.

Before you begin

These instructions explain how to add TWINT to your existing Web Drop-in integration. The Web 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 TWINT integration:

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

Show TWINT in your payment form

To have Drop-in show TWINT in the list of available payment methods, specify in your POST /paymentMethods request:

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

When the shopper selects the payment method, Drop-in calls the onSubmit event, which contains a state.data object. If your integration is set up correctly, the state.data is passed on to your server to make the payment request.

Make a payment

When a shopper chooses to pay with TWINT, Drop-in redirects them to the TWINT app. 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.

When the shopper selects to pay, Drop-in calls the onSubmit event, which contains a state.data.

Pass the state.data to your server.

From your server, make a /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.

The following code sample is a /payments request for a TWINT payment.

https://docs.adyen.com/pt/pt/payment-methods/twint/web-drop-in#twint-payments

curl https://checkout-test.adyen.com/v67/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:

resultCode: RedirectShopper
action: The object you need to pass to your front end to redirect the shopper to the TWINT webpage.

https://docs.adyen.com/pt/pt/payment-methods/twint/web-drop-in#-payments-response

/payments response

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

Pass the action object to your front end. Drop-in needs the action object to redirect the shopper to the TWINT webpage.

Handle the redirect result

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

Drop-in uses dropin.handleAction(action) to redirect the shopper to TWINT. After the shopper is redirected back to your website:

URL-decode the redirectResult that was appended to your returnUrl when the shopper was redirected back to your site, and pass it to your back end.
Check the payment result by making a POST /payments/details request, specifying:
- details: Object that contains the URL-decoded redirectResult.
https://docs.adyen.com/pt/pt/payment-methods/twint/web-drop-in#-payments-details-request
/payments/details request
{ "details":{ "redirectResult": "X6XtfGC3!Y..." } }
The /payments/details response contains:
- resultCode: Use this to present the payment result to your shopper.
- pspReference: Our unique identifier for the transaction.
https://docs.adyen.com/pt/pt/payment-methods/twint/web-drop-in#-payments-details-response
/payments/details response
{ "resultCode": "Authorised", "pspReference": "88154795347618C" }

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:

resultCode	Description	Action to take
Authorised	The shopper completed their payment, and it has been sent to the bank for processing. In most cases, this means that you will receive the funds. If you are using manual capture, you also need to capture the payment.	Inform the shopper that the payment has been successful.
Cancelled	The shopper cancelled the payment while on their bank's website.	Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Error	There was an error when the payment was being processed.	Inform the shopper that there was an error processing their payment. The response contains a `refusalReason`, indicating the cause of the error.
Pending or Received	The shopper has completed the payment but the final result is not yet known.	Inform the shopper that you've received their order, and are waiting for the payment to be completed. You will receive the final result of the payment in an AUTHORISATION notification.
Refused	The payment was refused by the shopper's bank.	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 notification webhooks to know the outcome of the payment. The notification webhooks you can receive for TWINT are:

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.

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 the Capture Delay setting is set to Manual, then you need to manually capture the payment.

Partial capture

To partially capture a TWINT payment, specify in your /capture request:

modificationAmount: The amount that the shopper should pay.

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

https://docs.adyen.com/pt/pt/payment-methods/twint/api-only#-capture-request

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

TWINT doesn't support multiple partial captures.

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.