For the complete documentation index, see llms.txt. This page is also available as Markdown.

12. İptal & İade

İptal & İade servisi, hem iptal işlemlerini hem de iade işlemlerini aynı anda sağlamaktadır

İptal & İade

POST {{Private Base Address}}/api/paywall/private/revert

Yukarıda verilmiş olan adrese istek atmanız yeterli olacaktır. Test ortamı ve Gerçek ortam için 'Base Address' istediğiniz gibi kullanabilirsiniz.

Önemli: İptal & İade servisini kullanabilmeniz için 'Header' alanında 'apikeyprivate' ve 'apiclientprivate' parametrelerini göndermeniz gerekmektedir. PaymentPrivateAPI Adresi

Gerekli header ve istek parametreleri:

Zorunlu header parametreleri
Parametre
Tip
Zorunlu
Açıklama

apikeyprivate

string

Evet

Üye işyeri panelinden temin etmiş olduğunuz Private Key.

apiclientprivate

string

Evet

Üye işyeri panelinden temin etmiş olduğunuz Private Client.

İstek gövdesi parametreleri
Parametre
Tip
Zorunlu
Açıklama

UniqueCode

Guid

Evet

Ödeme başlatma sonrasında Paywall tarafından dönen API cevabında, ilgili işlemin Paywall'daki UniqueCode karşılığı bulunmaktadır. Bu bilgi tarafınızda saklanmalıdır

MerchantUniqueCode

string

Evet

Ödeme başlatma için gönderilen istek içerisindeki MerchantUniqueCode ile aynı değer olmalıdır. Bu kod sizin tarafınızdan işleme ait verilen tekil değerdir. İptal/İade/Ödeme Sorgulama işlemlerinin hepsinde bir ödemeyi tekilleştirmeniz ve takip etmeniz için kullanılmaktadır.

Amount

decimal

Hayır

Amount parametresi 0 gönderilirse, işlem ana tutar üzerinden gerçekleştirilir. Eğer Amount değer, var olan işlem tutarından farklı gönderilirse Kısmi İade olarak işlenir

MarketPlace:DeleteExistingRecords

bool

Hayır

Pazaryeri kapsamında ilgili ödemenin hakediş onayının verilmesi durumunda, bu parametre true gönderilmelidir. True gönderilmesi durumunda var olan hakedişler, iptal emrinin başarılı olması sonrasında silinir

Servise gönderilmesi gereken parametreler şu şekildedir :

Servisten dönen parametreler şu şekildedir:

Parametreler ve açıklamaları
Parametre
Tip
Açıklama

ErrorCode

int

Hata kodu. İşlem başarılı ise '0' değerini döner.

Result

bool

True ya da false değeri döner. İşlem başarılı iste 'true' değerini döner

Message

string

İşlem hatalıysa, bu hataya dair belirtilen mesajdır, locale parametresine göre dil desteği sunar.

İptal & İade V2

POST {{Private Base Address}}/api/paywall/private/revert/v2

Yukarıda verilmiş olan adrese istek atmanız yeterli olacaktır. Test ortamı ve Gerçek ortam için 'Base Address' istediğiniz gibi kullanabilirsiniz.

Önemli: İptal & İade servisini kullanabilmeniz için 'Header' alanında 'apikeyprivate' ve 'apiclientprivate' parametrelerini göndermeniz gerekmektedir. PaymentPrivateAPI Adresi

Gerekli header ve istek parametreleri:

Zorunlu header parametreleri
Parametre
Tip
Zorunlu
Açıklama

apikeyprivate

string

Evet

Üye işyeri panelinden temin etmiş olduğunuz Private Key.

apiclientprivate

string

Evet

Üye işyeri panelinden temin etmiş olduğunuz Private Client.

İstek gövdesi parametreleri
Parametre
Tip
Zorunlu
Açıklama

UniqueCode

Guid

Evet

Ödeme başlatma sonrasında Paywall tarafından dönen API cevabında, ilgili işlemin Paywall'daki UniqueCode karşılığı bulunmaktadır. Bu bilgi tarafınızda saklanmalıdır

MerchantUniqueCode

string

Evet

Ödeme başlatma için gönderilen istek içerisindeki MerchantUniqueCode ile aynı değer olmalıdır. Bu kod sizin tarafınızdan işleme ait verilen tekil değerdir. İptal/İade/Ödeme Sorgulama işlemlerinin hepsinde bir ödemeyi tekilleştirmeniz ve takip etmeniz için kullanılmaktadır.

Amount

decimal

Hayır

Amount parametresi 0 gönderilirse, işlem ana tutar üzerinden gerçekleştirilir. Eğer Amount değer, var olan işlem tutarından farklı gönderilirse Kısmi İade olarak işlenir

MarketPlace:DeleteExistingRecords

bool

Hayır

Pazaryeri kapsamında ilgili ödemenin hakediş onayının verilmesi durumunda, bu parametre true gönderilmelidir. True gönderilmesi durumunda var olan hakedişler, iptal emrinin başarılı olması sonrasında silinir

Servise gönderilmesi gereken parametreler şu şekildedir :

Servisten dönen parametreler şu şekildedir:

Parametreler ve açıklamaları
Parametre
Tip
Açılama

Body

object

Ödemeye ilişkin detay içeren JSON (opsiyonel)

ErrorCode

int

Hata kodu. İşlem başarılı ise '0' değerini döner.

Result

bool

True ya da false değeri döner. İşlem başarılı iste 'true' değerini döner

Message

string

İşlem hatalıysa, bu hataya dair belirtilen mesajdır, locale parametresine göre dil desteği sunar.

Payment.PaymentId

int

İade edilen ödemenin sistem tarafından atanan benzersiz kimlik numarası.

Payment.UniqueCode

string

Ödemeye ait sistem tarafından üretilen tekil UUID değeri.

Payment.MerchantUniqueKey

string

Üye işyerine ait tekil UUID anahtar değeri.

Payment.TrackingCode

string

İade işlemine ait takip kodu.

Payment.PaymentActivityType

int

İşlem sonucu oluşturulan hareketin tipini gösteren kod

Payment.Installment

byte

İşlemde uygulanan taksit sayısı

Payment.PaymentGatewayId

int

İşlemin gerçekleştiği sağlayıcının bağlantısının kimlik bilgisi

Payment.PaymentGatewayName

string

İşlemin gerçekleştiği sağlayıcının bağlantısına verilen isim

Payment.PaymentGatewayProviderName

string

İşlemin gerçekleştiği sağlayıcının sistem ismi

Payment.PaymentGatewayProviderKey

string

İşlemin gerçekleştiği sağlayıcının sistemdeki anahtar kodu

Payment.RelationalId1

string

Kart ile ilişkilendirilen unique bilgi

Payment.RelationalId2

string

Kart ile ilişkilendirilen ikinci unique bilgi

Payment.RelationalId3

string

Kart ile ilişkilendirilen üçüncü unique bilgi

Error.ProviderErrorCode

string

Ödeme sağlayıcısından dönen hata kodu. İşlem başarılı ise boş string döner.

Error.ProviderErrorMessage

string

Ödeme sağlayıcısından dönen hata mesajı. İşlem başarılı ise boş string döner.

ExternalInfo.PaymentActivityTypeId

int

Ödeme aktivite tipi kimliği. İade işlemleri için 2 değerini döner.

ExternalInfo.PaymentExternalAuthCode

string

Ödeme sağlayıcısından dönen yetkilendirme kodu.

ExternalInfo.PaymentExternalOrderId

string

Ödeme sağlayıcısındaki harici sipariş kimliği. Sağlayıcı tarafından dönülmüyorsa boş string olabilir.

ExternalInfo.PaymentExternalTransId

string

Ödeme sağlayıcısındaki harici işlem kimliği. Genellikle UniqueCode ile aynı değeri taşır.

ExternalInfo.PaymentExternalHostReference

string

Ödeme sağlayıcısının host sistemi tarafından atanan referans kodu.

ExternalInfo.PaymentExternalMerchantId

string

Ödeme sağlayıcısındaki harici üye işyeri kimliği. Sağlayıcı tarafından dönülmüyorsa boş string olabilir.

Last updated