refund-payment
POST /api/{team}/gateway/refund-payment
Başarılı bir ödemeden tutar iade eder. amount gönderilmezse iade edilebilir tutarın tamamı iade edilir. Aynı ödemeden birden fazla kısmi iade yapılabilir. İade ile iptal arasındaki fark: İade ve İptal.
Kimlik doğrulama
X-Api-Key, X-Timestamp, X-Signature, Content-Type: application/json. Ayrıntılar: Kimlik Doğrulama ve İmza. Uç, ödeme sınırına (dakikada 60) tabidir.
İstek
{
"transaction": {
"token": "0b8f6c2d-3e41-4a7b-9c5d-1e2f3a4b5c6d"
},
"amount": "100.00"
}
| Alan | Tip | Zorunlu | Açıklama |
|---|---|---|---|
transaction.token | string (UUID) | evet | İade edilecek ödemenin token'ı. Çalışma alanınıza ait olmalıdır. |
amount | string | hayır | İade tutarı; gövdenin en üst seviyesinde gönderilir. Sıfırdan büyük, iade edilebilir tutardan büyük olamaz. Gönderilmezse iade edilebilir tutarın tamamı. Kur çevirisiyle çekilen ödemede çekilen para birimindedir. |
İade edilebilir tutar, ödeme tutarından başarılı ve sonuçlanmamış iadelerin düşülmesiyle bulunur.
SDK örnekleri
not
Örneklerdeki $client / client nesnesinin kurulumu: İstemciyi Kurmak.
- PHP
- Node.js
- Python
- Java
- cURL
use Gurmehub\Odemehub\Request\RefundPayment;
$refund = $client->refundPayment(new RefundPayment(token: $transactionToken, amount: '100.00'));
if ($refund->result->successful) {
$refund->refund->amount; // 100.00
$refund->transaction->paymentStatus; // Enum\PaymentStatus::PartiallyRefunded
}
const refund = await client.refundPayment({ token: transactionToken, amount: '100.00' });
if (refund.result.successful) {
refund.refund?.amount; // 100.00
refund.transaction.paymentStatus; // partially_refunded
}
from odemehub.request import RefundPayment
refund = client.refund_payment(RefundPayment(token=transaction_token, amount="100.00"))
if refund.result.successful:
refund.refund.amount # 100.00
refund.transaction.payment_status # PaymentStatus.PARTIALLY_REFUNDED
import com.odemehub.request.RefundPayment;
var refund = client.refundPayment(new RefundPayment(transactionToken, "100.00"));
if (refund.getResult().isSuccessful()) {
refund.getRefund().getAmount(); // 100.00
refund.getTransaction().getPaymentStatus(); // PaymentStatus.PARTIALLY_REFUNDED
}
URI_PATH="/api/$ODEMEHUB_TEAM/gateway/refund-payment"
BODY='{"transaction":{"token":"0b8f6c2d-3e41-4a7b-9c5d-1e2f3a4b5c6d"},"amount":"100.00"}'
TIMESTAMP=$(date +%s)
SIGNATURE=$(printf '%s\n%s\n%s\n%s' "$TIMESTAMP" "POST" "$URI_PATH" "$BODY" | openssl dgst -sha256 -hmac "$ODEMEHUB_API_SECRET" | sed 's/^.* //')
curl -X POST "https://sandbox.odemehub.com$URI_PATH" \
-H "Content-Type: application/json" \
-H "X-Api-Key: $ODEMEHUB_API_KEY" \
-H "X-Timestamp: $TIMESTAMP" \
-H "X-Signature: $SIGNATURE" \
--data-raw "$BODY"
Yanıt
{
"result": { "successful": true, "message": null },
"transaction": {
"token": "0b8f6c2d-3e41-4a7b-9c5d-1e2f3a4b5c6d",
"reference": "SIP-10231",
"status": "successful",
"payment_status": "partially_refunded",
"security_type": "secure",
"amount": "450.00",
"base_amount": "450.00",
"currency": "TRY",
"installment_number": 1,
"is_test": false,
"created_at": "2026-10-02T09:15:30.000000Z",
"order": null,
"payment_link": null,
"link_payment": null,
"subscription": null
},
"customer": {
"reference": "musteri-88",
},
"conversion": null,
"refund": {
"type": "refund",
"amount": "100.00"
}
}
| Alan | Tip | Açıklama |
|---|---|---|
result.successful | boolean | İadenin sonucu. Sağlayıcı reddettiyse false, yanıt yine 200. |
result.message | string | null | successful false ise nedeni. |
transaction, customer, conversion | object | İade edilen ödeme: Ödeme yanıtı. transaction.payment_status iadeden sonraki durumdur. |
refund.type | string | refund. |
refund.amount | string | İade için kullanılan tutar, iki ondalıklı. |
result.successful: false ile dönebilecek mesajlar: sağlayıcının ret mesajı, İstenen tutar ödemenin iade edilebilir tutarını aşıyor., Ödeme sağlayıcısına ulaşılamadı., İade işlenirken bir hata oluştu.
HTTP durum kodları
| Kod | Durum |
|---|---|
200 | İade işlendi; sonuç result.successful içinde. |
401 | API anahtarı ya da imza geçersiz. |
403 | Çalışma alanı işlem yapamıyor (ödenmemiş bakiye). Bu uç modül gerektirmez. |
404 | Bu işlem bulunamadı. Token yok ya da başka bir çalışma alanına ait. |
422 | Doğrulama hatası ya da ödeme iade edilemiyor. |
429 | İstek sınırı aşıldı. |
Hatalar
| Alan | Mesaj |
|---|---|
transaction.token | Yalnızca başarıyla tamamlanmış bir ödeme iade edilebilir. |
transaction.token | İptal edilmiş bir ödemeden iade yapılamaz. |
transaction.token | Bu ödemenin iade edilebilir tutarı kalmadı. |
transaction.token | Bu ödeme hesabı İade işlemini desteklemiyor. |
amount | İade tutarı sıfırdan büyük olmalıdır. / İade tutarı, ödemenin iade edilebilir tutarından büyük olamaz. |