/Execute recurring payment

Request initiates recurring payment.

Request Endpoint

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

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
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. The following values are allowed: true, false
recId (required)	string	recId of the saved card
initiator	string	If merchant is initiator of the transaction it is needed to indicate additional parameter “merchant”, if the parameter is not followed it will be initiated as a customer initiated transaction.
merchantPaymentId	string	Merchant-side payment identifier
extra	string	additional parameter for merchant specific info (optional). only non-unicode (ANS) symbols allowed. max length 25
extra2	string	additional parameter for merchant specific info (optional). only non-unicode (ANS) symbols allowed. max length 52.
money { } (required)	object

Complex Types Description

money

Parameter	Type	Description
amount (required)	number	amount of payment format: 0.00
currency (required)	string	transaction currency (3 digit ISO code). Note 1) payments in given currency should be enabled for the merchant. The following values are allowed: GEL, USD, EUR

Request Sample

{
  "money": {
      "currency": "GEL",
      "amount": 0.1
  },
  "recId": "4dd8f36C6D3F4iuFAD6Fd4D574651ccE"
}

curl --location --request POST 'https://api.tbcbank.ge/v1/tpay/payments/{payId}/completion' \
--header 'apikey: lXcDL8JJiAN8Vjlu6NW3kNeceOQolwnF' \
--header 'Authorization: Bearer eyJhbGciOiJKSeriiIsImtpZCI6IjVFMjBGMzQ2RUY1RjU2ODkxQTIyRkUzQUVCRjAzMzlGMzVDNjk1QjYiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJYaUR6UnU5ZlZva2FJdjQ2Nl9Bem56WEdsYlkifQ.eyJuYmYiOjE2MzE2NDQyNjEsImV4cCI6MTYzMTczMDY2MSwiaXNzIjoiaHR0cHM6Ly9hY2NvdW50c2FwaS50YmNiYW5rLmdlLyIsImF1ZCI6WyJodHRwczovL2FjY291bnRzYXBpLnRiY2JhbmsuZ2UvcmVzb3VyY2VzIiwicGF5bWVudGFwaSJdLCJjbGllbnRfaWQiOiI3MDAwMDAyIiwic2NvcGUiOlsicGF5bWVudGFwaSJdfQ.GNIaxgik-ElXrvXOky5_1D1YjEEX5CB3eQHKPwvdCNhB-HvblqZ78QSNJcl6qLfL8gRTd0x9ASCgXu2z2RQYJ-wls0V2IwrQ7p4WEU-ON9QnasOjZWgPeVAtZQC_zjH9DdmL1GiDTIHLErhKDGl3YtSGcvPKSvTpABWda6HvF7lNGlEK0SZxzzt1i1SkpAnQfzIO1ATEmKdM1EmWzp5ZaDk0cF-Wzfk_2CrQAGofc80GT64U8WOXvVOx1gVYmjzqYs71XCOqfQdySYBIc-tbUC6YIoeSPZfu1hpi33Gz40ig57t4jxeE7Jh--38ydO4AGEw8BdlLv534O0V3ZoOddg' \
--header 'Content-Type: application/json' \
--data-raw '{
  "money": {
      "currency": "GEL",
      "amount": 0.1
  },
  "recId": "4dd8f36C6D3F4iuFAD6Fd4D574651ccE"
}'

Response Parameters

Parameter	Type	Description
payId	string	payment id
status	string	payment status The following values are allowed: Succeeded WaitingConfirm Failed
currency	string	transaction currency (3 digit ISO code)
amount	number	transaction amount format: 0.00
links { }	object	links
transactionId	string	transaction_id from UFC
preAuth	string	preauthorization status for given payment (true, false)
initiator	string	The parameter defines by whom the transaction is initiated: client: Client initiator transaction Merchant: Merchant initiator transaction
recurringCard { }	object	saved card parameters: card recId, cardMask and expiryDate. If saving card wasn't required, null will be returned
httpStatusCode	number	http status code
developerMessage	string	developer message for logging in local system
userMessage	string	error message for user

Complex Types Description

links

Parameter	Type	Description
uri	string	URL
method	string	method to use on URL
rel	string	action to use on URL

recurringCard

Parameter	Type	Description
recId	string	saved card recId. used for initiating payment with saved card.
cardMask	string	masked card PAN
expirtyDate	string	date of expiry

Response Sample

{
  "payId": "mztv8vdd2170l15248",
  "status": "Succeeded",
  "currency": "GEL",
  "amount": 1,
  "confirmedAmount": 1,
  "returnedAmount": 0,
  "links": null,
  "transactionId": "FUVHzR335WiLh+xG+7cVJq0jX9M=",
  "paymentMethod": 11,
  "preAuth": false,
  "recurringCard": {
    "recId": "fA0F39Dcd5C4B49b1ab1B9c5b960467898fEa980",
    "cardMask": "511588******0614",
    "expiryDate": "0222"
  },
  "httpStatusCode": 200,
  "developerMessage": null,
  "userMessage": null
}

{
  "type": "https://developers.tbcbank.ge/docs/error-type-401",
  "title": "Invalid Api Key",
  "status": "401",
  "detail": "Please make sure api key is valid",
  "systemCode": "System code for problem is tpay-access-token.401.001"
}

Error Response

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

Details can be found at Error Code Description.

in case of 400 Bad Request additional parameter, resultCode containing detailed business error description will be returned.

Parameter	Type	Description
type	string	A URI identifying a human-readable web page with information about the error
title	string	General error description
status	string	Http status code
systemCode	string	error code in following format: {method-name}.{http-status-code}
detail	string	Human-readable text providing additional Information
resultCode	string	Business level transaction status description. Detailed list of available statuses is described in the Classifications chapter/ Result Codes