Detay

v1/subscription/subscription_detail

Düzenli ödeme emri ile ilgili detay bilgileri dönen servistir.

https://api.paynet.com.tr/v1/subscription/subscription_detail

Parametre İsmi

Tip

Zorunlu

Açıklama

subscription_id

string

Evet*

Fatura ID

reference_no

string

Evet*

Fatura numarası

Parametre İsmi

Tip

Zorunlu

Açıklama

name_surname

string

Evet

İsim ve soyisim bilgisi

amount

decimal

Evet

Düzenli ödeme tutarı

interval

int

Evet

Ödeme Periyodu ( 0: Günlük, 1: Haftalık, 2: Aylık, 3: Yıllık )

interval_count

int

Evet

Toplam kaç adet çekim yapılacak. interval aylık (2) ise interval_count 12 ise bir yıl boyunca her ay çekim yapar. Eğer period değeri 2 gönderilirse 2 ayda bir toplam 12 çekim yapılır yani 24 ayda düzenli ödeme tamamlanır.

begin_date

datetime

Evet

Düzenli ödeme başlangıç tarihi

reference_no

string

Evet

Referans no bilgisi

end_user_email

string

Evet

Son kullanıcı email bilgisi

end_user_gsm

string

Evet

Son kullanıcı gsm bilgisi.

agent_id

string

Hayır

Paynet bayi kodu

agent_amount

decimal

Evet

Ödeme çekildikten sonra burada belirtilen tutar bayi hesabına aktarılır. Tutar belirtilmezse default ayarlar geçerlidir.

company_amount

decimal

Evet

Ödeme çekildikten sonra burada belirtilen tutar Ana Firma hesabına aktarılır. Tutar belirtilmezse default ayarlar geçerlidir.

end_user_desc

string

Evet

Son kullanıcıya gösterilecek açıklama. “xxx aidatınız için düzenli ödeme onayı istiyoruz” gibi.

addcomission_to_amount

decimal

Hayır

true/false, Default: false. Komisyon tutarının ödeme tutarına eklenip eklenmeyeceği belirlenir. True olduğunda komisyon tutarı kredi kartından çekilecek tutara eklenir.

currency

string

Hayır

Para birimi. Sadece TL destekleniyor.

period

string

Hayır

Ödemenin hangi periyotta olacağını belirler (Default 0), interval ve interval_count ile birlikte kullanılıyor. Örn: 12 adetli Aylık ödemeli düzenli ödeme talimatında periyod 2 girilirse 2 ayda bir çekim yapılır ve toplam 24 ayda tamamlanır.

user_name

string

Hayır

Düzenli ödeme talebini oluşturan kullanıcının adı.

agent_note

string

Hayır

Düzenli ödeme talebini oluşturan bayinin kendisine notu. Sadece bayi görür.

confirmation_webhook

string

Hayır

Düzenli ödeme talebi son kullanıcı tarafından onaylanırsa, burada belirleyeceğiniz URL'e request gönderilir.

suceed_webhook

string

Hayır

Düzenli ödeme onaylandıktan sonra karttan ödeme çekimleri başarılı olduğunda burada belirleyeceğiniz URL'e request gönderilir.

error_webhook

string

Hayır

Düzenli ödeme onaylandıktan sonra karttan ödeme çekimleri hatalı olduğunda burada belirleyeceğiniz URL'e request gönderilir.

confirmation_redirect_url

string

Hayır

Düzenli ödeme talebi son kullanıcı tarafından onaylandığında redirect edilecek sayfanın URL'ini burada gönderilir.

send_mail

bool

Hayır

Email gönderilsin mi? true ise düzenli ödeme talebi oluşturulduktan sonra son kullanıcının email adresine düzenli ödemeyi onaylaması için gerekli link mail olarak gönderilir.

send_sms

bool

Hayır

Sms gönderilsin mi? true ise düzenli ödeme talebi oluşturulduktan sonra son kullanıcının telefonuna düzenli ödemeyi onaylaması için gerekli link sms olarak gönderilir.

is_fixed_price

bool

Hayır

Sabit Tutar mı ? true ise tüm ödemeler amount alanında belirtilen tutar kadar çekilir. false ise invoice_create servisi ile her bir ödeme için çekilecek tutarı vade bilgisi ile göndermelisiniz.

auto_renew

bool

Hayır

Düzenli ödeme emri bitince tekrarlansın mı ?

agent_logo

bool

Hayır

Bayi logo linki

attempt_day_count

int

Hayır

Ödeme çekim deneme gün sayısı. Default 3 gündür. 3 gün boyunca tanımlı kartlardan ödeme çekilmeye çalışılır. 3. günün sonunda hala çekim yapılamaz ise sözleşmeyi durdurur.

daily_attempt_count

int

Hayır

Ödeme gün içerisinde çekim denemesi sayısı. Default 3'tür. Gün içerisinde karttan en fazla 3 kere çekim denemesi yapılır.

plan

list

Evet

Düzenli ödemenin plan listesi

-> plan_id

int

Evet

Oluşturulan plan id

-> invoice_id

int

Evet

Fatura id

-> val_date

string

Evet

Geçerlilik tarihi

-> amount

decimal

Evet

Çekilecek tutar

-> xact_id

int

Evet

Çekim işleminin numarası

-> status

int

Evet

Plan durumu. 0: Bekleniyor, 1:ödeme alınacak, 2:Harici alındı, 3:Ödeme alındı, 4:Ödeme alınamadı.

-> status_desc

string

Evet

Plan durumu açıklaması

 {
    "subscription_id": "3f7ac56a-a23f-4eee-a3ef-a21e3277b1b6"
 }

"Data": {
        "subscription_id": "3f7ac56a-a23f-4eee-a3ef-a21e3277b1b6",
        "company_code": "10009",
        "agent_id": "600146",
        "user_name": null,
        "name_surname": "Test Kullanıcısı",
        "end_user_email": "test@paynet.com.tr",
        "end_user_gsm": "5019999999",
        "agent_logo": "",
        "amount": "100,00",
        "agent_amount": "0,00",
        "company_amount": "0,00",
        "currency": null,
        "reference_no": "1213456",
        "agent_note": "",
        "end_user_desc": "Elif Örnek",
        "add_comission_to_amount": false,
        "interval": 2,
        "interval_count": 13,
        "period": 1,
        "begin_date": "28.08.2019 15:26:00",
        "is_fixed_price": true,
        "auto_renew": false,
        "confirmation_webhook": "",
        "suceed_webhook": "",
        "error_webhook": "",
        "confirmation_redirect_url": "",
        "status": 0,
        "send_mail": true,
        "send_sms": true,
        "sms_verification_code": "",
        "plan": [
            {
                "plan_id": 45306,
                "invoice_id": -1,
                "val_date": "28.08.2019 15:26:00",
                "amount": 100,
                "xact_id": -1,
                "status": 0,
                "status_desc": "Bekleniyor"
            },
            {
                "plan_id": 45307,
                "invoice_id": -1,
                "val_date": "28.09.2019 15:26:00",
                "amount": 100,
                "xact_id": -1,
                "status": 0,
                "status_desc": "Bekleniyor"
            },
            {
                "plan_id": 45308,
                "invoice_id": -1,
                "val_date": "28.10.2019 15:26:00",
                "amount": 100,
                "xact_id": -1,
                "status": 0,
                "status_desc": "Bekleniyor"
            },
            {
                "plan_id": 45309,
                "invoice_id": -1,
                "val_date": "28.11.2019 15:26:00",
                "amount": 100,
                "xact_id": -1,
                "status": 0,
                "status_desc": "Bekleniyor"
            },
            {
                "plan_id": 45310,
                "invoice_id": -1,
                "val_date": "28.12.2019 15:26:00",
                "amount": 100,
                "xact_id": -1,
                "status": 0,
                "status_desc": "Bekleniyor"
            },
            {
                "plan_id": 45311,
                "invoice_id": -1,
                "val_date": "28.01.2020 15:26:00",
                "amount": 100,
                "xact_id": -1,
                "status": 0,
                "status_desc": "Bekleniyor"
            },
            {
                "plan_id": 45312,
                "invoice_id": -1,
                "val_date": "28.02.2020 15:26:00",
                "amount": 100,
                "xact_id": -1,
                "status": 0,
                "status_desc": "Bekleniyor"
            },
            {
                "plan_id": 45313,
                "invoice_id": -1,
                "val_date": "28.03.2020 15:26:00",
                "amount": 100,
                "xact_id": -1,
                "status": 0,
                "status_desc": "Bekleniyor"
            },
            {
                "plan_id": 45314,
                "invoice_id": -1,
                "val_date": "28.04.2020 15:26:00",
                "amount": 100,
                "xact_id": -1,
                "status": 0,
                "status_desc": "Bekleniyor"
            },
            {
                "plan_id": 45315,
                "invoice_id": -1,
                "val_date": "28.05.2020 15:26:00",
                "amount": 100,
                "xact_id": -1,
                "status": 0,
                "status_desc": "Bekleniyor"
            },
            {
                "plan_id": 45316,
                "invoice_id": -1,
                "val_date": "28.06.2020 15:26:00",
                "amount": 100,
                "xact_id": -1,
                "status": 0,
                "status_desc": "Bekleniyor"
            },
            {
                "plan_id": 45317,
                "invoice_id": -1,
                "val_date": "28.07.2020 15:26:00",
                "amount": 100,
                "xact_id": -1,
                "status": 0,
                "status_desc": "Bekleniyor"
            },
            {
                "plan_id": 45318,
                "invoice_id": -1,
                "val_date": "28.08.2020 15:26:00",
                "amount": 100,
                "xact_id": -1,
                "status": 0,
                "status_desc": "Bekleniyor"
            }
        ]
    },
    "object_name": null,
    "code": 0,
    "message": null

*subcription_id veya reference_no'dan en az birini göndermeniz gerekmektedir.

PreviousOluşturma NextListeleme

Last updated 4 years ago