/Complete pre-authorized payment
Request completes pre-authorized payment for given payId.
/Complete pre-authorized payment
Request completes pre-authorized payment for given payId.
Request Overview
Request completes authorization process for payment with given payId. amount passed in the request body should not exceed transaction amount. If amount passed in /completion request is less than the transaction amount, difference is automatically returned to the customer. Completion request can be initiated not later than 30 days from Preauthorization date
Request Endpoint
https://api.tbcbank.ge/v1/tpay/payments/{payId}/completion
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 |
Body Parameters
Parameter | Type | Description |
---|---|---|
amount | number | amount to be confirmed (should not exceed transaction amount). if confirmed amount is less than the original transaction amount, difference is automatically returned to the customer. |
Request Sample
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 '{
"amount":0.1
}
'
Response Parameters
In case of succesfull cancelation 200 OK is returned.
Response Sample
{
"status": "Succeeded",
"amount": 10,
"confirmedAmount": 0.1,
"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 |
Updated about 3 years ago