Ana içeriğe geç

cancel-payment

POST /api/{team}/gateway/cancel-payment

Başarılı bir ödemeyi tamamıyla iptal eder. Tutar gönderilmez; iptal her zaman ödemenin tamamı içindir. Kısmen iade edilmiş bir ödeme iptal edilemez. İ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"
}
}
AlanTipZorunluAçıklama
transaction.tokenstring (UUID)evetİptal edilecek ödemenin token'ı. Çalışma alanınıza ait olmalıdır.

SDK örnekleri​

not

Örneklerdeki $client / client nesnesinin kurulumu: İstemciyi Kurmak.

use Gurmehub\Odemehub\Request\CancelPayment;

$cancel = $client->cancelPayment(new CancelPayment(token: $transactionToken));

if (! $cancel->result->successful) {
$cancel->result->message;
}

Yanıt​

refund-payment ile aynı biçimdedir; refund.type cancel, refund.amount ödemenin tutarıdır.

{
"result": { "successful": true, "message": null },
"transaction": {
"token": "0b8f6c2d-3e41-4a7b-9c5d-1e2f3a4b5c6d",
"reference": "SIP-10231",
"status": "successful",
"payment_status": "cancelled",
"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": "cancel",
"amount": "450.00"
}
}

Sağlayıcı iptali reddederse yanıt yine 200'dür; result.successful false olur. result.successful: false ile dönebilecek mesajlar: sağlayıcının ret mesajı, Ödeme sağlayıcısına ulaşılamadı., İptal işlenirken bir hata oluştu.

HTTP durum kodları​

KodDurum
200İptal 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 iptal 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.tokenKısmen iade edilmiş bir ödeme iptal edilemez, kalan tutar iade edilebilir.
transaction.tokenBu ödeme hesabı İptal işlemini desteklemiyor.