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

TWINT for API only

Add TWINT to an existing API-only integration.

Accept TWINT payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

These instructions explain how to add TWINT to your existing API-only integration.

Requirements

Requirement Description
Integration type Make sure that you have an existing API-only integration.
Setup steps Before you begin, add TWINT in your test Customer Area.

Build your payment form for TWINT

Show TWINT as an available payment method in your payment form. You do not need to collect any information from the shopper in your payment form.

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

You can also submit a /paymentMethods request specifying:

  • countryCode: CH
  • amount.currency: CHF.

In the response, you receive paymentMethod.type: twint.

Make a payment

When a shopper chooses to pay with TWINT, you need to redirect 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.

From your server, make a /payments request, providing:

  • paymentMethod.type: twint.
  • 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.

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

Handle the redirect

  1. To complete the payment, redirect the shopper to the action.url returned in the /payments response.

    When using the HTTP GET method:
    For security reasons, when displaying 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.

  2. URL-decode the redirectResult that was appended to your returnUrl when the shopper was redirected back to your website, and pass it to your back end.

  3. Check the payment result by making a POST /payments/details request, specifying:

    • details.redirectResult: Object that contains the URL-decoded redirectResult.

    You receive a response containing:

    • 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.
You will also receive the outcome of the payment asynchronously in a 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 have received their order, and are waiting for the payment to be completed.
You will receive the final result of the payment in an AUTHORISATION webhook.
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 webhooks to know the outcome of the payment. The 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 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

TWINT supports partial capture, but not multiple partial captures. 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:

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

Recurring payments

To make recurring payments for TWINT, you need to:

  1. Create a shopper token.
  2. Use the token to make future payments for the shopper.

Create a token

To create a token, include in your /payments request:

  • storePaymentMethod: true
  • shopperReference: Your unique identifier for the shopper (minimum length three characters).

When the payment details have been stored, you receive a webhook containing:

  • eventCode: RECURRING_CONTRACT
  • originalReference: The pspReference of the initial payment.
  • pspReference: This is the token you need to make recurring payments for this shopper.

Make sure that your server is able to receive RECURRING_CONTRACT as part of your standard webhooks. If you have not requested this additional configuration yet, contact our Support Team.

Make a payment with a token

To make a payment with the token, include in your /payments request:

  • paymentMethod.storedPaymentMethodId: The pspReference from the RECURRING_CONTRACT webhook.

    You can also get this value using the /listRecurringDetails endpoint.

  • shopperReference: The unique shopper identifier that you specified when creating the token (minimum length three characters).

  • shopperInteraction: ContAuth.

  • recurringProcessingModel: Subscription or UnscheduledCardOnFile.

For more information about the shopperInteraction and recurringProcessingModel fields, refer to Tokenization.

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