Sign in
Payments

Cancel Payment

post/api/v1/payment/cancel

Request body

application_keystring required

It is the key of your application on our environment

order_idstring required

It must be one the order_id's that you send to payment request previously.

transaction_idstring required

It must be one the transaction_id's that returned from payment transaction.

ip_addressstring

IP address of client.

languagestring

Its default value is tr. If you want to get messages in other languages, please send it. You can find supported languages in the api supported_languages.

Example request

{
  "application_key": "6e3cdaa3-65df-4eff-aed2-9d74387701dd",
  "order_id": "9ee3fd53-42f9-4f16-b454-77e6b714c2e9",
  "transaction_id": "8123asd23a45sf1341dasd1",
  "ip_address": "1.1.111.111",
  "language": "tr"
}

Response

Successful Response

response_codestring

You will get 00 for successful cancel/refund operation, otherwise another response code for the error. You can reach the list of response codes on the Response Codes Api

messagestring

Here is the explanation of response code

suggestionstring

This is the suggestion about you can take the action if the payment fails

service_resp_codestring

Payment service response code

service_resp_messagestring

Payment service response message

Example response

{
  "response_code": "00",
  "message": "Successfully Cancelled",
  "suggestion": "Suggestion about operation success",
  "service_resp_code": "7804",
  "service_resp_message": "İptal işlemi aynı gün yapılmalıdır."
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.