POSTPayment Cancellation / Refund Transactions
It is easy to perform payment cancelations and refund transaction for all payment methods (vPOS, e-wallets, carrier billing) through Teqpay API.
Service Address:/paymentcancel
Request
Header
| Parameter Name | Parameter Type | Explanation |
|---|---|---|
|
ApiKey
|
string | It is provided by the service provider .
|
|
SecretKey
|
string | It is provided by the service provider .
|
Body Parameter
| Parameter Name | Parameter Type | Explanation |
|---|---|---|
|
orderId
|
integer | The unique number of the payment transaction to be canceled. (TeqpayOrderId information returned as a result of the payment transaction) |
|
partialAmount
|
decimal | Partial Amount. If not shipped, the entire order will be canceled/refunded. |
|
language
|
string | It is the language option. The values it can receive are "TR-EN". "TR" is the default. |
Request Sample
{
"orderId": "15",
"partialAmount": "100.00",
"language": "TR"
}
Response
Response Parameter
| Parameter Name | Parameter Type | Explanation |
|---|---|---|
| Result | boolen | The result of a successful or unsuccessful query. |
| ResultCode | integer | This is the code that returns the query result. |
| ResultMessage | string | The result of the query is the description returned. |
| OrderID | integer | It is the identical value of the operation. This value is automatically assigned by Teqpay services. |
Response Sample
{
"OrderID": 12345,
"Result": true,
"ResultCode": 10000,
"ResultMessage": "Başarıyla tamamlandı.",
}