When Cardholder is logged in to the merchant’s e-shop, a ‘One click Payment’ button is presented for easy payment with just one click.

The Card token is detokenized, and the one click payment context is validated before the transaction is presented to IPS with a reference to the initial transaction. This allows the authentication flow to be bypassed.

How it works

To perform a payment with 3DS authorization, first create the order as detailed in API Integration Guide.

Note that you should include the additional OneClick and Tokenization parameters to the Order Request, as shown below:

Request example:

{"merchant": {
 "terminalId": {{TerminalID}},
 "channel": "web",
 "merchantTransactionId": "Order Id: r7cxvi0saj"},"transaction": {
 "transactionTimestamp": "{{trxDatetime}}",
 "description": "Transaction for order number 4908 terminalId 100886",
 "moto": false,
 "paymentType": "PURS",
 "amount": {
 "value": 50.50,
 "currency": "PLN"},"paymentMethod": [
 "CARD"]
 },"tokenisation": {
 "paymentTokens": [{
 "tokenType": "Card",
 "value": "{{purchaseTokenValue}}" }
 ]
 }
}

After completing the Order Creation, you may proceed to Make a payment.

Note that the following request needs an Authorization Header with the transactionSignature returned from payment order operation.

In this purchase request, include the additional DeviceInfo, OneClick and TokenInfo parameters, as shown below.

Request example:

{"info": {
 "deviceInfo": {
 "browserAcceptHeader": "application/json, text/plain, */*",
 "browserJavaEnabled": "false",
 "browserLanguage": "en",
 "browserColorDepth": "24",
 "browserScreenHeight": "1080",
 "browserScreenWidth": "1920",
 "browserTZ": "-60",
 "browserUserAgent": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Safari/537.36",
 "geoLocalization": "Lat: 38.7350528 | Long: -9.2143616",
 "systemFamily": "Windows",
 "systemVersion": "Windows",
 "deviceID": "498bfd4c3a3645b38667a7037b616c18",
 "applicationName": "Chrome",
 "applicationVersion": "106" },
 "customerInfo": [
 {
 "key": "customerName",
 "value": "User X" },
 {
 "key": "customerEmail",
 "value": "testingemail@gmail.com" }
 ]
 },"tokenInfo": {
 "value": "{{purchaseTokenValue}}",
 "tokenType": "Card"},"oneClick": {
 "oneClickApplication": true}
}

Expected response:

You will receive a response comprising a paymentStatus in the message. It informs whether the transaction was accepted, declined, still pending a final result, or requires additional action.

• Success: The purchase has been processed successfully and the customer has been debited.
• Declined: The purchase has been declined.
• Pending: The final result of the purchase is not yet known. You will need to inquiry on the status of this transaction until it reaches a final state, or you decide to cancel it.
• Partial: The purchase is partially accepted, but requires additional actions to the completed (e.g. 3D-Secure authentication). The actionResponse element is provided for instructions on how to proceed.

Perform a Get Status

After the payment has been fully processed, you can check the status of your transaction by sending a GET request.

Ensure that the Authorization HTTP header is set to the same Bearer token that was used in the initial Payment Order.

Request URL:

https://stargate-cer.qly.site1.sibs.pt/api/v1/payments/{transactionID}/status

Request Headers:

Authorization: ‘Bearer <AuthToken>’
X-IBM-Client-Id: ‘<ClientId>’
Content-Type: application/json

A successful technical response comprises of an HTTP-200 status and a returnStatus.statusCode=”000″.

Here are some examples of the possible result codes: