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"
}
}
| Alan | Tip | Zorunlu | Açıklama |
|---|---|---|---|
transaction.token | string (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.
- PHP
- Node.js
- Python
- Java
- cURL
use Gurmehub\Odemehub\Request\CancelPayment;
$cancel = $client->cancelPayment(new CancelPayment(token: $transactionToken));
if (! $cancel->result->successful) {
$cancel->result->message;
}
const cancel = await client.cancelPayment({ token: transactionToken });
if (!cancel.result.successful) {
cancel.result.message;
}
from odemehub.request import CancelPayment
cancel = client.cancel_payment(CancelPayment(token=transaction_token))
if not cancel.result.successful:
cancel.result.message
import com.odemehub.request.CancelPayment;
var cancel = client.cancelPayment(new CancelPayment(transactionToken));
if (!cancel.getResult().isSuccessful()) {
cancel.getResult().getMessage();
}
URI_PATH="/api/$ODEMEHUB_TEAM/gateway/cancel-payment"
BODY='{"transaction":{"token":"0b8f6c2d-3e41-4a7b-9c5d-1e2f3a4b5c6d"}}'
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
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",
},
"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ı
| Kod | Durum |
|---|---|
200 | İptal 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 iptal 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 | Kısmen iade edilmiş bir ödeme iptal edilemez, kalan tutar iade edilebilir. |
transaction.token | Bu ödeme hesabı İptal işlemini desteklemiyor. |