Payment

Refund

Used to refund a payment. The refund is executed over paymentTransactionId (per basket item). You can perform a full or partial refund for the payment amount.

post/payment/refund

Request

Base URL
https://sandbox-api.iyzipay.com
Auth
none declared. Required headers: Authorization, Content-Type
TypeScript
https://skmtc.dev/iyzico/apis/bin-and-installment/docs/payment/refund/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Authorizationstring required

Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.

Content-Typestring required

Content-Type değeri.

Request body

paymentTransactionIdstring required

Basket item (payment breakdown) identifier (paymentTransactionId) to be refunded.

conversationIdstring

Unique ID for request/response correlation.

ipstring

IP address the request is sent from.

locale'tr' | 'en'

Response language.

priceunknown required

currencystring

Payment currency.

Response

Successful response

status'success' | 'failure'

Indicates the outcome of the request.

locale'tr' | 'en'

Response language.

systemTimeinteger

Current epoch ms at the time of response.

conversationIdstring

Echoes the conversationId sent in the request.

paymentIdstring

Payment number.

paymentTransactionIdstring

Refunded payment item identifier.

priceunknown

currencystring

Currency.

authCodestring

Authorization (auth) code returned by the bank.

hostReferencestring

Reference value provided by the bank for the payment.

refundHostReferencestring

Reference value provided by the bank for the refund.

retryabletrue | false

Indicates whether the operation can be retried.

signaturestring

Signature value that can be used for verification.

Changes

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