İçeriğe atlayın

API

Bu sayfada

İptal

İşlem imzalama başlamadan önce bekleyen bir çekimi iptal edin, hangi durumların iptale izin verdiğini anlayın ve güncellenen yanıtı işleyin.

POST/v1/withdrawals/:withdrawal_id/cancel

API anahtarı: Payout

Henüz yürütülmeye başlanmamış bir çekimi iptal edin. Paymos çekimi işlemeye başladığı anda pencere kapanır — bu, herhangi bir şey imzalanmadan önce, çekim hâlâ created durumundayken gerçekleşir. Bu yüzden created durumu tek başına çekimin hâlâ iptal edilebilir olduğunu garanti etmez: yürütme başladıktan sonra çağrı 409 döndürür. Zaten iptal edilmiş bir çekimi iptal etmek işlemsizdir: hata değil, aynı çekimle 200 döndürür.

İstek gövdesi

Bir reason gönderin (zorunlu, en fazla 500 karakter). Paymos bunu çekim kaydında saklar ve denetim kaydına yazar. Size geri dönmez: iptal yanıtı da withdrawal.cancelled webhook'u da gerekçeyi değil durumu taşır.

{
  "reason": "Customer requested cancellation"
}

Yanıt (200 OK)

{
  "withdrawal_id": "wdr_2M8K6Q4P9X1Z7A3B",
  "external_order_id": "payout-001",
  "status": "cancelled",
  "is_final": true,
  "is_test": true,
  "amount": "100.00",
  "currency": "USDT",
  "network": "TRC20",
  "destination_address": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
  "created_at": 1739289600,
  "cancelled_at": 1739289660
}

Hatalar

Tam katalog için bkz. Hata Kodları. Her hata yanıtındaki type URI'si ilgili satıra doğrudan bağlanır.