Merchants have the option to accommodate returning customers by offering the facility to save their card details for future use. However, this can only be done upon explicit request from the customer and with their explicit permission. This convenient feature is applicable to transactions involving the AUTH and PURS payment types when using a card as the payment method.

Step 1: Token creation

Action 1: Create the order

Action 2: Generate the transaction

Action 3: Perform a Get Status

The token creation has several actions, and the merchant and the cardholder have some roles to play:

1. In the checkout request, the merchant allows the returning customer to save the card for future use and generates the card form with the “save card” option.
2. The payment request carries the card data and the “save card” option requesting SIBS Gateway to process the payment and, on success, create a card token.
3. The payment response returns a unique card token and PCI card data so the merchant can save it next to the customer data to a user in payment based on the card token.

Action 1: Create the order

The token creation process begins when you start creating an order, adding the following tokenization elements to the existent order body message.

Request URL:

https://stargate-cer.qly.site1.sibs.pt/api/v1/payments

Request Headers:

Autorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6I (...)
X-IBM-Client-Id: b4480347-9fc8-4790-b359-100a99c60ea3
Content-Type: application/json

Example request including the tokenization information as follows:

{
 "merchant": {
 "terminalId": 24,
 "channel": "web",
 "merchantTransactionId": "Order Id: mg990kgc5c",
 "transactionDescription": "transaction to create token",
 "shopURL": "https://mytest.e-shop.pl/"
 },
 "transaction": {
 "transactionTimestamp": "2023-05-23T07:54:20.418Z",
 "description": "transaction statement description",
 "moto": false,
 "paymentType": "AUTH",
 "amount": {
 "value": 50.5,
 "currency": "PLN"
 },
 "paymentMethod": [
 "CARD"
 ]
 },
 "tokenisation": {
 "tokenisationRequest": {
 "tokeniseCard": true
 }
 }
}

Action 2: Generate the transaction

Note that the following request needs an Authorisation Header with the transactionSignature returned from checkout operation and createToken parameter set to true.

In this request, the Bearer Token is replaced by the checkout response transactionSignature.

At this step, it is necessary to add the following elements to the purchase:

Request URL:

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

Request Headers:

Authorisation: Digest {transactionSignature}
X-IBM-Client-Id: b4480347-9fc8-4790-b359-100a99c60ea3
Content-Type: application/json

The request should contain:

"cardInfo": {
 "PAN": "{{MCRegularCardNum}}",
 "secureCode": "{{MCRegularCardCVV}}",
 "validationDate": "{{MCRegularCardExpiry}}",
 "cardholderName": "TKN {{trxDatetime}}",
 "createToken": true
}

Action 3: Perform a Get Status

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>’

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

Here are some examples of the possible result codes:

Step 2: Token usage

Action 1: Create the order

Action 2: Generate the transaction

Action 3: Perform a Get Status

For a returning customer, the option to pay with a previously tokenized card associated with their account on the merchant store can be made available, using either the AUTH or PURS method.

The token usage process can be illustrated through the following stages:

1. The merchant presents a list of available cards to the customer, displaying masked PAN (Partial Account Number) and expiration date. This information is provided by the service provider gateway (SPG) during the tokenization flow.
2. The customer identifies the desired card from the list and inputs the card’s CVV (Card Verification Value).
3. The merchant proceeds with the checkout and payment process, utilizing the selected tokenized card for the transaction.

This ensures a smooth transaction experience by securely utilizing the stored token for payment processing.

Action 1: Create the order

The token usage process is initiated when you begin creating the order, incorporating an additional token element within the existing order body message.

Request URL:

https://stargate-cer.qly.site1.sibs.pt/api/v1/payments

Request Headers:

Autorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6I (...)
X-IBM-Client-Id: b4480347-9fc8-4790-b359-100a99c60ea3
Content-Type: application/json

Request example should contain the following “tokenisation” object to include the payment token:

{
 "merchant": {
 "terminalId": 24,
 "channel": "web",
 "merchantTransactionId": "Order Id: bwatdhbew2",
 "transactionDescription": "transaction with 3DS",
 "shopURL": "https://mytest.e-shop.pl/"
 },
 "transaction": {
 "transactionTimestamp": "2023-05-23T08:06:07.231Z",
 "description": "transaction statement description",
 "moto": false,
 "paymentType": "AUTH",
 "amount": {
 "value": 50.5,
 "currency": "PLN"
 },
 "paymentMethod": [
 "CARD"
 ]
},
"tokenisation": {
 "paymentTokens": [
 {
 "tokenType": "Card",
 "value": "{{tokenValue}}"
 }
 ]
 }
}

The response will contain only the valid tokens that can be used on the next action:

"tokenList": [
 {
 "tokenName": "TKN 2023-06-20T11:22:11.474Z",
 "tokenType": "Card",
  "value": "ODI2YWQ1MGEtMzhlNC00NjA2LTk2YTAtNjdjYTRjY2JiMDU2",
 "maskedPAN": "520474******4390",
 "expireDate": "2025-12-01T00:00:00.000Z",
 "oneClickButton": "false"
 }

Action 2: Generate the transaction

After that, the transaction must be generated adding the tokeninfo element.

Note that the following request needs an Authorisation Header with the transactionSignature returned from checkout operation.

In this request, the Bearer Token is replaced by the checkout response transactionSignature.

Request URL:

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

Request Headers:

Authorisation: Digest {transactionSignature}
X-IBM-Client-Id: b4480347-9fc8-4790-b359-100a99c60ea3
Content-Type: application/json

Request example should contain the following “tokenInfo” object to include the necessary token information:

"tokenInfo": {
 "value": "{{tokenValue}}",
 "secureCode": "536", 
 "tokenType": "Card"
}

Action 3: Perform a Get Status

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>’

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