/Get E-Commerce payment details

Request returns payment status and details for given payId.

/Get E-Commerce payment details

Request returns payment status and details for given payId.



Request Endpoint

https://api.tbcbank.ge/v1/tpay/payments/{payId}

Authorization

Authorization TypeDescription
Bearer Tokenaccess-token should be added to Authorization header

Request Parameters

Header

ParameterTypeDescription
apikeystringdeveloper app API key

Path Parameters

ParameterTypeDescription
payIdstringtpay payment identifier

Request Sample

curl --location --request GET 'https://api.tbcbank.ge/v1/tpay/payments/' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'apikey: lXcDL8JJiAN8Vjlu6NW3kNeceOQolwnF' \
--header 'Authorization: Bearer eyJhbGciOiJKSeriiIsImtpZCI6IjVFMjBGMzQ2RUY1RjU2ODkxQTIyRkUzQUVCRjAzMzlGMzVDNjk1QjYiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJYaUR6UnU5ZlZva2FJdjQ2Nl9Bem56WEdsYlkifQ.eyJuYmYiOjE2MzE2NDQyNjEsImV4cCI6MTYzMTczMDY2MSwiaXNzIjoiaHR0cHM6Ly9hY2NvdW50c2FwaS50YmNiYW5rLmdlLyIsImF1ZCI6WyJodHRwczovL2FjY291bnRzYXBpLnRiY2JhbmsuZ2UvcmVzb3VyY2VzIiwicGF5bWVudGFwaSJdLCJjbGllbnRfaWQiOiI3MDAwMDAyIiwic2NvcGUiOlsicGF5bWVudGFwaSJdfQ.GNIaxgik-ElXrvXOky5_1D1YjEEX5CB3eQHKPwvdCNhB-HvblqZ78QSNJcl6qLfL8gRTd0x9ASCgXu2z2RQYJ-wls0V2IwrQ7p4WEU-ON9QnasOjZWgPeVAtZQC_zjH9DdmL1GiDTIHLErhKDGl3YtSGcvPKSvTpABWda6HvF7lNGlEK0SZxzzt1i1SkpAnQfzIO1ATEmKdM1EmWzp5ZaDk0cF-Wzfk_2CrQAGofc80GT64U8WOXvVOx1gVYmjzqYs71XCOqfQdySYBIc-tbUC6YIoeSPZfu1hpi33Gz40ig57t4jxeE7Jh--38ydO4AGEw8BdlLv534O0V3ZoOddg' \
--data-raw ''

Response Parameters

ParameterTypeDescription
payIdstringpayment id
statusstringpayment status

The following values are allowed:
Created
Processing
Succeeded
Failed
Expired
WaitingConfirm
CancelPaymentProcessing
PaymentCompletionProcessing
Returned
PartialReturned
currencystringtransaction currency (3 digit ISO code)
amountnumbertransaction amount
format: 0.00
confirmedAmountnumberin case of preAuthoraztion, specifies confirmed amount for the transaction
format: 0.00
returnedAmountnumbertransaction
links { }objectlinks
transactionIdstringtransaction_id from UFC
recurringCard { }objectsaved card parameters: card recId, cardMask and expiryDate. If saving card wasn't required, null will be returned
paymentMethodintegerpaymentMethod
RNNstringTransaction identifier (12 characters)
extrastringAdditional parameter for merchant specific info (optional)
extra2stringAdditional parameter for merchant specific info (optional)
preAuthstringpreauthorization status for given payment (true, false)
InitiatorstringThe parameter defines by whom the transaction is initiated:
client: Client initiator transaction
Merchant: Merchant initiator transaction
None: no recurring payment
httpStatusCodenumberhttp status code
developerMessagestringdeveloper message for logging in local system
userMessagestringerror message for user
resultCodestringBusiness level transaction status description. Detailed list of available statuses is described in the Classifications chapter/ Result Codes
PaymentCardNumbernumbermask of payment card

Complex Types Description

links

ParameterTypeDescription
uristringURL
methodstringmethod to use on URL
relstringaction to use on URL

recurringCard

ParameterTypeDescription
recIdstringsaved card recId. used for initiating payment with saved card.
cardMaskstringmasked card PAN
expirtyDatestringdate of expiry

📘

Checking payment status should be finished when one of the following final status values is returned:

  • Succeeded
  • Failed
  • Expired
  • WaitingConfirm (in case of preauthorization)

Response Sample

{
  "payId": "vel8b76o5t881126014",
  "status": "PartialReturned",
  "currency": "GEL",
  "amount": 3000,
  "confirmedAmount": 0.1,
  "returnedAmount": 0,
  "links": null,
  "transactionId": "qZXG0HqGDINvXG/P9jNU0HqGDJn3LMPVjE=",
  "paymentMethod": 5,
  "preAuth": true,
  "recurringCard\"": {
    "recId": "8715aBbB4314e7dC4f91482283988365a3c30822",
    "cardMask": "415479******8365",
    "expiryDate": "0222"
  },
  "paymentCardNumber": null,
  "rrn": null,
  "extra": "GE50TB7809945000000000",
  "extra2": "0.10",
  "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.

ParameterTypeDescription
typestringA URI identifying a human-readable web page with information about the error
titlestringGeneral error description
statusstringHttp status code
systemCodestringerror code in following format: {method-name}.{http-status-code}
detailstringHuman-readable text providing additional Information
resultCodestringBusiness level transaction status description. Detailed list of available statuses is described in the Classifications chapter/ Result Codes

Recipe