Ödeme Kırılımı Onay Verme

URL

Ödeme kırılımı onaylamak için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

HTTP Metod URL
POST /payment/v1/payment-transactions/approve

İstek Parametreleri

Ödeme kırılımı onayı vermek için yapılacak isteklerde gönderilmesi beklenen parametreler aşağıdaki tablo ve alt başlıklar altında listelenmiştir.

Parametre Adı Tipi Zorunlu Açıklama
paymentTransactionIds number[] Evet Onay verilmek istenen ödeme kırılımlarının ID değerlerini barındırır
isTransactional boolean Hayır Onaylama işlemi sırasında eğer herhangi bir ödeme kırılımı süreçsel nedenlerden dolayı onaylanamazsa bu değer true ise hiçbir ödeme kırılımı onaylanmaz. Eğer bu değer false ise onaylanabilen ödeme kırılımları onaylanır onaylanamayanlar ise onaylanamamış durumda kalır.

Dönüş Parametreleri

Ödeme işleminin sonucunda dönen parametreler de API dokümantasyonu giriş sayfasındaki Dönüş Formatları bölümünde belirtilen kurallara tabidir. Sistemsel ya da kurgusal bir hata bulunmadığı durumda data parametresinde dönen objenin alt parametreleri aşağıdaki gibidir:

Parametre Adı Tipi Açıklama
size number Onaylama işlemi sonucunda etkilenen ödeme kırılımı sayısı
items PaymentTransactionApproval[] Onaylama işlemine dair bilgileri taşıyan obje bkz: Ödeme Kırılımı Onay Bilgileri

Ödeme Kırılımı Onay Bilgileri

Ödeme kırılımı onay ve onay geri çekme isteği yapılırken dönüş objesi içerisinde yapılan işleme ve ödeme kırılımına ait bilgiler içeren objedir.

Parametre Adı Tipi Açıklama
paymentTransactionId number Ödeme kırılımının ID'si
approvalStatus string Ödeme kırılımı sonucu başarılı ise SUCCESS başarısız ise FAILURE değerini barındırır
failedReason string Ödeme kırılımı onaylama ya da onay geri çekme sonucu hatalı ise hata detayına dair bilgi barındırır

Örnek Kodlar

Açık kaynak kodlu Craftgate API client'larındaki örnek kodları inceleyebilirsiniz.