Difference between revisions of "Token payment 3D Secure"

From Barion Documentation
Jump to navigation Jump to search
Line 64: Line 64:
'''Liability''': describes the entity who is liable for the payment in case of fraud
'''Liability''': describes the entity who is liable for the payment in case of fraud
To help you decide on a suitable scenario, please use the decision graph below:
== Prerequisites ==
== Prerequisites ==

Revision as of 15:08, 25 November 2020

Token Payment with 3D Secure

This article is incomplete. It may change significantly without any notice, so don't rely on any content you find here yet. Please check back later.

This payment scenario allows the integrator shop to register a token for a customer (and a funding source) in the Barion system and then, later on, using this token, charge the customer without redirecting her to the Barion Smart Gateway UI. The user may be present at the site of the merchant or she can be off-session as well, so the merchant can charge her e.g. for subscriptions. This means that the customer authorizes the shop to charge her card or Barion balance without typing in the card information or Barion login again.

Premium feature
This scenario is not allowed automatically for every approved shop and should be requested from Barion!

Token payment scenarios

Token payment can be used in three use cases:

  • Customer Initiated Payments: when the user is present on the website of the merchant and she decides to pay :
    • OneClick payment: the user is charged upon her request initiated on the website of the merchant. Subsequent payments are subject to PSD2 SCA and as the user is present, she has to go through the authentication process.
  • Merchant Initiated Payments: when the merchant initiates the payment without the user being present. It has two subtypes:
    • Recurring payment: the user is charged with the same amount on a regular basis, typically in case of subscriptions. Subsequent payments are exempted from PSD2 SCA, but liability still shifts to the card issuer.
    • MIT (merchant initiated transaction): the user is charged on an irregular basis and/or with a different amount. Subsequent payments of this type are excluded from PSD2 SCA, the liability is on the merchant.

Here is a comparison that includes the regular, non-tokenized payment scenario as well:

Scenario Initial payment Subsequent payments
Customer present Customer at Barion Smart GW Customer present Customer at Barion Smart GW
Non token (regular) payment YES YES YES YES
OneClick payment YES YES/NO1 YES NO
Recurring payment YES YES/NO1 NO NO

1 Token payment scenarios can be initiated with already registered RecurrenceId.

These scenarios have different requirements, this table below summarizes the key differences.

Scenario Amount Frequency Liability
OneClick payment Various Various Card issuer
Recurring payment Fixed maximum1 Minimum defined2 Card issuer
Merchant initiated payment Various Various Merchant

1 The amount of the subsequent payments can not be more than the first initial payment's.
2 The minium days must be specified during the initial payment
Liability: describes the entity who is liable for the payment in case of fraud

To help you decide on a suitable scenario, please use the decision graph below:



To be able to integrate your webshop with the Barion Payment Gateway:

  • You must register a Barion wallet at the Barion website or in the Sandbox environment. Learn more about the Sandbox environment here.
  • For this wallet you have to create a shop which should be approved by Barion.
  • For every currency you plan to conduct payments in you have to make sure there is an account created in your Barion wallet. This means that if you plan to have USD payments then there should be a USD account created in your wallet.
  • To make sure every corner case scenario works for your webshop it is best to top up that account with a small amount (approx. 5-10EUR or your choice of currency around the same value).
  • For the technical communication guide please read this: Calling the API

The payment process

The process is divided into two major steps:

  1. Creating the token that represents one of the customer's funding sources (credit card or e-money wallet)
  2. Using the registered token to charge the customer

Creating the token

To be able to use a token payment scenario first we have to register the token with Barion. The token registration is basically a normal payment with three extra properties in the Payment/Start request. This means that the mercahnt has to make sure that the customer is well aware of the fact that they are giving consent to a tokenized payment. The Barion Smart Gateway UI does not indicate in any way that the payment is a token payment.

By default the token is registered to the shop and not to the Barion account. So if the Barion account has multiple shops, the registered tokens can not be shared among them even if the customer is the same. If you want to use tokens in multiple shops, please contact Barion in the Customer center.

InitiateRecurrence, RecurrenceId and RecurrenceType

Let's start with the InitiateRecurrence property. This is a bool property, if you set it to true then the payment gateway will consider the request as a token registration. This happens even if the customer is already has a registered token, so you are able to re-register a customer.

The other required property for a token registration is the token itself. This is generated by the shop and has to be unique for every registration. The token should be specified in the RecurrenceId property of the Payment/Start request. This token should be stored in the webshop database. Make sure that multiple tokens can belong to a single customer because the token is only unique for a specific shop, customer, funding source combination.

The appropriate Recurrence Type property has to be specified. In case of Recurring Payment PurchaseInformation.RecurringExpiry and PurchaseInformation.RecurringFrequency must also be set.

An already used RecurrenceId can be used for re-registration, in this case, the new funding source will be registered for the token.

Token payment 1.png

Example JSON request

 1 {
 2     "POSKey": "E31EC263-01DC-40BD-BDF1-38FC7A332434",
 3     "PaymentType": "Immediate",
 4     "PaymentRequestId": "EXMPLSHOP-PM-001",
 5     "InitiateRecurrence": true,
 6     "RecurrenceId": "SHOP-XMLP-TOKEN-ABC-123",
 7     "FundingSources": ["All"],
 8     "Currency": "EUR",
 9     "Transactions": [
10         {
11             "POSTransactionId": "EXMPLSHOP-PM-001/TR001",
12             "Payee": "[email protected]",
13             "Total": 25.2,
14             "Comment": "Subsription fee for the first month",
15             "Items": [
16                 {
17                     "Name": "Website subscription",
18                     "Description": "Website subscription for one month",
19                     "Quantity": 1,
20                     "Unit": "month",
21                     "UnitPrice": 25.2,
22                     "ItemTotal": 25.2,
23                     "SKU": "EXMPLSHOP/SKU/PHC-01"
24                 }
25             ]
26         }
27     ]
28 }

Customer selects funding source

After the proper payment preparation, the customer is redirected to the secure Barion Smart Gateway to choose a funding source. The funding source the customer selects will be registered to the token. The funding source can either be a Barion e-money balance or a bank card. This means that even though the customer may own multiple cards only the one that was registered to the token can be used for future token payments. To change the funding source attached to the token a new registration should be requested.

Processing the response

The response is almost the same as to a basic Immediate scenario. The only difference is that there is the RecurrenceResult property that tells the result of the token registration. This could be either

  • Successful: the token is registered and live, can be used for payment
  • Failed: the token registration was not successful, the token can not be used
  • None: this could only happen if no token payment was requested


In case of Recurring payment or Merchant initiated payment the GetPaymentState response returns an additional field called TraceId. The value of this property is generated by the card issuer. You have to save it and submit is in all subsequent Recurring or Merchant initiated payments of the same type, or otherwise the payments can be declined by the issuer. The TraceID represents the first, customer-present payment and helps the issuer to connect subsequent payments to this initial payment.

Displaying the funding source in a GUI

We strongly advise to save the complete response for future reference. The FundingSource field tells if the funding source is a Barion balance or a card. If it is a card, it is useful to save FundingInformation for displaying it for the user, when requesting future payments. The usual way to display funding sources is to show the last 4 digits of the card, with the rest represented by stars, eg: **** **** **** 1234. The card used can be obtained from FundingInformation's BankCard field. The CardType field can be used to display the appropriate card logo. You can even show, if the card is expired, and offer to register another one.

Possible error responses

Error code Description
RecurringPaymentNotAllowed The token payment is not allowed for the shop identified by the POSKey. Contact Barion to request this feature.

Using the token

Depending on the type of the subsequent payment, 3DSecure authentication might be required for subsequent payments. 3DS authentication is not required in the following cases:

  • the token was requested before 3DS came into effect,
  • the original payment was not initialized by bank card,
  • the subsequent payment is a merchant initiated payment.


To be able to use a token, the initial payment must be in a successful state.

Token payment 2.png

OneClick payment

Step 1 : Initialize oneClick

You have to include the following css and javascript files in the code of your site. These files include all the necessary javascript code and styling to handle the 3DS authentication and display the challenge if necessary.

<link href="https://secure.barion.com/static/barion.offsitegw.min.css" rel="stylesheet">
<script src="https://secure.barion.com/static/barion.offsitegw.min.js"></script>

Then you have to initialize the Barion javascript client:

const configuration = {
    onAuthenticationSucceeded: function () {
        // handle successful authentication by calling the Barion API via merchant's backend
        // Call the v2/payment/complete endpoint
    onAuthenticationFailed: function () {
        // Handle unsuccessful authentication result, no charge was made.
        // The payment might be still valid only the authentication failed

const gw= new Barion.OffsiteGw(configuration);

Step 2 : Make a payment

To use an already registered token for a payment, you have to call the same /Payment/Start API endpoint but the InitiateRecurrence should be set to false and the appropriate Recurrence Type should be sent. This tells the Barion API to use the token for payment instead of only registering it. The token should be specified in the RecurrenceId property along with the TraceId.

Example Payment/Start json request
 1 {
 2     "POSKey": "E31EC263-01DC-40BD-BDF1-38FC7A332434",
 3     "PaymentType" : "Immediate",
 4     "PaymentRequestId": "EXMPLSHOP-PM-002",
 5     "InitiateRecurrence" : false,
 6     "RecurrenceType" : "OneClickPayment",
 7     "RecurrenceId" : "SHOP-XMLP-TOKEN-ABC-123",
 8     "TraceId" : "SHOP-XMLP-TRACEID-123",
 9     "FundingSources": ["All"],
10     "Currency": "EUR",
11     "Transactions": [
12         {
13             "POSTransactionId": "EXMPLSHOP-PM-002/TR002",
14             "Payee": "[email protected]",
15             "Total": 25.2,
16             "Comment": "Subsription fee for the second month",
17             "Items": [
18                 {
19                     "Name": "Website subscription",
20                     "Description": "Website subscription for one month",
21                     "Quantity": 1,
22                     "Unit": "month",
23                     "UnitPrice": 25.2,
24                     "ItemTotal": 25.2,
25                     "SKU": "EXMPLSHOP/SKU/PHC-01"
26                 }
27             ]
28         }
29     ]
30 }
Processing the Payment/Start response

To this request, the Barion API sends back the required data for the 3DS authentication for the specified paymentId.

Field name Description
PaymentId Payment Identifier of the purchase in Barion
ThreeDSAuthClientData basae64 encoded 3DS client data
Example Payment/Start response
1 {
2     "PaymentId" : "dce46843-6266-4c1f-b82a-387e0fee9073",
4 }

Step 3: 3DS authentication & challenge

This data then should be passed onto the authenticate() method of the offsite gw manager, which will do all the magic to authenticate and display the challenge (if needed).

 1         // call Barion API via merchant's backend
 2         // once the result is returned continue with authentication
 3         $.ajax({
 4             url: "Url/Of/Your/Payment/Start",
 5             method: "POST",
 6             data: data,
 7             success: function (threeDsClientData) {
 8                // the threeDsClientData will be in the response of payment/start	
 9                gw.authenticate(threeDsClientData);
10             }
11          });

When the request is finished the appropriate callback is fired, the BarionClient was initialized with in Step 1. In case of successful authentication, you have to call our /Payment/Complete endpoint, where the actual charge will happen.

Recurring payment/Merchant Initiated payment

For these types of payments, the subsequent payments are nearly identical to the process of Creating the token. The only difference is that the TraceId received in the initial GetPaymentState response must be sent in the Payment/Start request. Also don't forget to set the appropriate Recurrence Type.

Possible error responses

Error code Description
InvalidRecurrenceId The token specified in the RecurrenceId is invalid. Check if the token registration was successful.
RecurringPaymentDenied Something happened to the user since the token registration, either deleted, suspended, or blocked. The payment s not allowed in these cases.
InsufficientFunds If the original payment was with an e-money wallet and the customer doesn't have enough money to fulfill this charge this error happens.
OriginalPaymentWasntSuccessful This means that the token belongs to an originally unsuccessful payment so this token can not be used anymore. This could only happen if the original payment was financed with a credit card.
InvalidCurrency If the original payment was paid with e-money and the current token payment is in a currency that the wallet does not have an account in this error happens.