/Create E-Commerce payment

Request Endpoint

https://api.tbcbank.ge/v1/tpay/payments

Authorization

Authorization Type	Description
Bearer Token	access-token should be added to Authorization header

Request Parameters

Header

Parameter	Type	Description
apikey	string	developer app API key

Body Parameters

Parameter	Type	Description
amount { } (required)	object	Transaction amount
returnurl (required)	string	Url to redirect user after finishing payment
extra	string	Additional parameter for merchant specific info (optional). only non-unicode (ANSI) symbols allowed. max length 25. This parameter will appear in the account statement
extra2	string	Additional parameter for merchant specific info (optional). only non-unicode (ANSI) symbols allowed. max length 52.
userIpAddress	string	User IP address
expirationMinutes	number	Payment initiation expiration time in minutes. Recommended value is max 12 minutes. If the value is not specified in the request, 12 minutes will be assigned by default.
methods	array	There are several payment methods available to be passed when initiating TBC E-Commerce payment. Detailed list and description of available methods is described in the Classifications chapter/ Payment Methods If no method is passed, all methods available for a given merchant will be displayed by default
installmentProducts [ ]	array	list of installment products. mandatory if installment is selected as payment method. Please note, sum of prices of installment products should be same as total amount.
callbackUrl	string	When the payment status changes to final status, POST request containing PaymentId in the body will be sent to given URL. Request body example {"PaymentId":"6azzo13uw5u2116332"} In case of successful receipt of the request, the merchant must return the status code 200 and check the payment status through Get Payment endpoint. CallbackUrl must be added on the merchant dashboard at ecom.tbcpayments.ge. If callbackUrl parameter is not provided, system automatically takes the basic callbackUrl value from the merchant dashboard. Please, verify that POST request is allowed at your callbackUrl from the following IP addresses: 193.104.20.44 193.104.20.45 185.52.80.44 185.52.80.45 See how to add callback url on the merchant datshboard
preAuth	boolean	Specify if preauthorization is needed for the transaction. if "true" is passed, amount will be blocked on the card and additional request should be executed by merchant to complete payment. To finalize authorization process, /v1/tpay/payments/:paymentId/completion endpoint should be used. Note, that Completion request can be initiated not later than 30 days from Preauthorization date. By default block is saved for 30 days, although some banks may have a different setting, so this setting depends on the card issuing bank (Isuer Bank). The following values are allowed: true, false
language	string	Language for payment page. The following values are allowed: KA, EN If the language value is not specified in the request, Georgian page will be loaded by default.
merchantPaymentId	string	Merchant-side payment identifier
skipInfoMessage	boolean	If true is passed, TBC E-Commerce info message will be skipped and customer will be redirected to merchant. If false is passed or this parameter isn’t passed at all, TBC E-Commerce info message will be shown and customer will be redirected to merchant.
saveCard	boolean	Specify if saving card funcion is needed. This function should be enabled for the merchant by bank. If true is passed, recId parameter should be returned in response, through this parameter merchant can execute payment by saved card - POST /payments/execution. Zero amount is allowed for this function. If card saving funtion is requested with preauthorization parameter=true, saved card execution method will be activated after preauthorization completion. WebQR, ApplePay and installments pay methods are not allowed for saving card request
saveCardToDate	string	The date until the card will be saved can be passed in following format "MMYY". If the saveCardToDate is not provided or data provided by the merchant exceeds card expiry , the system will automatically assign the SaveCardToDate value that will be equal to card expiry. The actual card save date must be verified by getting payment status after transaction completed with GET /payments/{payment-id}
description	string	Payment short description for clients, max length 30. This parameter will appear on the checkout page.

Complex Types Description

amount

Parameter	Type	Description
currency (required)	string	transaction currency (3 digit ISO code). The following values are allowed: GEL, USD, EUR Note ● payments in given currency should be enabled for the merchant by bank. ● only "GEL" is available for payment methods: ▹ 8 - Installment
total	number	total amount of payment format: 0.00
subtotal	number	amount of purchase format: 0.00
tax	number	amount of tax format: 0.00
shipping	number	amount of shipping price format: 0.00

installmentProducts

Parameter	Type	Description
name	string	Product description
price (required)	number (decimal)	Product price in Lari 0.00
quantity (required)	integer (int32)	Number of purchased units.

Request Sample

{
    "amount": {
        "currency":"GEL",
        "total": 1
    },
    "returnurl":"test.ge/callback",
    "callbackUrl":"https://test.ge", 
    "preAuth":false,
    "language":"EN",
    "merchantPaymentId": "P123123",
    "description": "free text, which will be visible on payment page"
}

{
    "amount": {
        "currency":"GEL",
        "total": 1,
        "subTotal": 0,
        "tax": 0,
        "shipping": 0
    },
    "returnurl":"test.ge/callback",
    "extra":"GE60TB4572261006330008",
    "userIpAddress" : "127.0.0.1",
    "expirationMinutes" : 12,
    "methods" : [5, 7, 8],
    "installmentProducts":
    [
       {"Name":"t1","Price":100,"Quantity":1},
       {"Name":"t1","Price":50,"Quantity":1},
       {"Name":"t1","Price":50,"Quantity":1}
    ],
    "callbackUrl":"https://test.ge", 
    "preAuth":false,
    "language":"EN",
    "merchantPaymentId": "P123123",
    "saveCard": true,
    "saveCardToDate": "1030",
    "description": "free text, which will be visible on payment page"
}

Response Parameters

Parameter	Type	Description
payId	string	Payment id
status	string	Payment status The following values are allowed: Created
currency	string	Transaction currency (3 digit ISO code)
amount	number	Transaction amount Format: 0.00
links	object	Links
- uri	string	Url
- method	string	Method to use on URL
- rel	string	Action to use on URL
transactionId	string	Transaction_id from UFC
recId	string	In case of recurring payment registration, recId of saved card. recId should be used for executing recurring payment.
preAuth	string	Preauthorization status for given payment (true, false)
httpStatusCode	number	HTTP status code
developerMessage	string	Developer message for logging in local system
userMessage	string	Error message for user
expirationMinutes	number	Payment initiation expiration time in minutes.

Response Sample

"payId": "tpay-tbvqma2372015",
  "status": "Created",
  "currency": "GEL",
  "amount": 200,
  "links": [
    {
      "uri": "https://api.tbcbank.ge/v1/tpay/payments/tpay-tbvqma2372015",
      "method": "GET",
      "rel": "self"
    },
    {
      "uri": "https://tpay.tbcbank.ge/checkout/choose-payment-method/tpay-tbvqma2372015",
      "method": "REDIRECT",
      "rel": "approval_url"
    }
  ],
  "transactionId": null,
  "preAuth": false,
  "recId": "8715aBbB4314e7dC4f91482283988365a3c30822",
  "httpStatusCode": 200,
  "developerMessage": null,
  "userMessage": null
}

Error Response

In case of error, standard response in problem json will be returned.

Details can be found at Error Code Description.

Recipe

👉

TBC E-Commerce Create web payment

Open Recipe