/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 Type

Description

Bearer Token

access-token should be added to Authorization header

Request Parameters

Header

Parameter

Type

Description

apikey

string

developer app API key

Path Parameters

Parameter

Type

Description

payId

string

tpay 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

Parameter

Type

Description

payId

string

payment id

status

string

payment status

The following values are allowed:
Created
Processing
Succeeded
Failed
Expired
WaitingConfirm
CancelPaymentProcessing
PaymentCompletionProcessing
Returned
PartialReturned

currency

string

transaction currency (3 digit ISO code)

amount

number

transaction amount
format: 0.00

confirmedAmount

number

in case of preAuthoraztion, specifies confirmed amount for the transaction
format: 0.00

returnedAmount

number

transaction

links { }

object

links

transactionId

string

transaction_id from UFC

recurringCard { }

object

saved card parameters: card recId, cardMask and expiryDate. If saving card wasn't required, null will be returned

paymentMethod

string

paymentMethod

RNN

string

Transaction identifier (12 characters)

extra

string

Additional parameter for merchant specific info (optional)

extra2

string

Additional parameter for merchant specific info (optional)

preAuth

string

preauthorization status for given payment (true, false)

httpStatusCode

string

http status code

developerMessage

string

developer message for logging in local system

userMessage

string

error message for user

resultCode

string

Business level transaction status description. Detailed list of available statuses is described in the Classifications chapter/ Result Codes

PaymentCardNumber

number

mask of payment card

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

📘

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.

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

Recipe


Did this page help you?