Ana içeriğe geç

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"
}
AlanTipZorunluAçıklama
transaction.tokenstring (UUID)evetİade edilecek ödemenin token'ı. Çalışma alanınıza ait olmalıdır.
amountstringhayı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.

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
}

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",
"billing_address": { "firstname": "Ahmet", "lastname": "Yılmaz", "email": "[email protected]" }
},
"conversion": null,
"refund": {
"type": "refund",
"amount": "100.00"
}
}
AlanTipAçıklama
result.successfulbooleanİadenin sonucu. Sağlayıcı reddettiyse false, yanıt yine 200.
result.messagestring | nullsuccessful false ise nedeni.
transaction, customer, conversionobjectİade edilen ödeme: Ödeme yanıtı. transaction.payment_status iadeden sonraki durumdur.
refund.typestringrefund.
refund.amountstringİ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ı​

KodDurum
200İade işlendi; sonuç result.successful içinde.
401API anahtarı ya da imza geçersiz.
403Çalışma alanı işlem yapamıyor (ödenmemiş bakiye). Bu uç modül gerektirmez.
404Bu işlem bulunamadı. Token yok ya da başka bir çalışma alanına ait.
422Doğrulama hatası ya da ödeme iade edilemiyor.
429İstek sınırı aşıldı.

Hatalar​

AlanMesaj
transaction.tokenYalnızca başarıyla tamamlanmış bir ödeme iade edilebilir.
transaction.tokenİptal edilmiş bir ödemeden iade yapılamaz.
transaction.tokenBu ödemenin iade edilebilir tutarı kalmadı.
transaction.tokenBu ö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.