Online Nakit Yönetimi Tahsilat Sistemi Web Servis Dokümanı – v2.2.1
Aşağıdaki web servisler Telekomünikasyon firmalarının Online Nakit Tahsilat Sistemleri için kullanılmaktadır.
Her firma için belirtilen IP adreslerinden istek yapılacak şekilde izin tanımlanması gerekmektedir.IP Adresleri, izinli listesine tanımlandıktan sonra servisler kullanıma açık olacaktır.
Anlaşmalı Banka tarafından istek yapılacak IP adreslerinin [email protected] adresine gönderilmesi sonrasında gerekli tanımlar yapılmaktadır.
Servis tanımları içerisinde yer alan parametrelerden;
-
Gönderim parametreleri hakkında ( Request );
-
HTTP Post isteği yapılması gerekmektedir.
-
uniq_code: UNIQ_CODE bilgisi her istekte POST parametresi olarak gönderimi zorunludur. Her firma için farklı bir uniq_code bilgisi tahsis edilmektedir.
-
api_code: Her servis URL bilgisinin sonunda olmak zorundadır. Her firma için farklı api_code tahsis edilmektedir.
-
member_no: Telekomünikasyon aboneliği olan kullanıcılar için belirlenen bilgidir. Her tesis aboneliği için benzersizdir. 10 karakter ve numeric olmak zorundadır. Uygulama seviyesinde kullanım yapılırken kullanıcı tarafından alınması gereken bilgidir. Diğer parametreler backend parametreleridir.
-
-
Dönüş parametreleri hakkında ( Response );
-
Response, JSON olarak dönecektir.
-
status: “00, 01, 02 ” gibi dönecektir. Sadece “00” durumu başarılı işlemler için dönecektir. Diğerleri bilgilendirme, hata parametreleridir.
-
data: JSON veri formatında dönüş sağlamaktadır. Servis çıktısı veri çıktısı veriyor ise JSON formatında veri çıktısı sağlar. Bazı servislerde ise data bilgisi sadece string içerebilir ( Örn : “İşlem başarılı” )
-
Abone detay sorgulama servisidir.
Sorgulama için zorunlu alanlar:
-
uniq_code :
-
member_no : Abone numarası
Parametre | Örnek Değer | Tip | Açıklama |
---|---|---|---|
member_no | 1000000001 | text | Abone tekil hat numarası |
uniq_code | {{uniq_code}} | text | Yetkiliden talep ediniz. |
curl -X POST 'https://ws.wiradius.com/online_bank/get_user/{{api_code}}' \
--form 'member_no=1000000001' \
--form 'uniq_code={{uniq_code}}' \
<?php
$post_fields = array();
$post_fields[ 'member_no' ] = '1000000001';
$post_fields[ 'uniq_code' ] = '{{uniq_code}}';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://ws.wiradius.com/online_bank/get_user/{{api_code}}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => $post_fields,
));
$response = curl_exec( $curl );
curl_close($curl);
echo $response; ?>
Örnek cevap :
{
"status": "00",
"data": {
"firstname": "u**r",
"lastname": "k***z",
"mobile": "05xxxxxxxx38",
"email": "[email protected]",
"birth_day": ""
}
}
Sorgulama ile ilgili bir hata olması durumunda;
- Status değeri "00"dan farklı gelecektir.
- Data içerisinde hata açıklaması gelecektir.
Status “00” değilse data bilgisi / hata dönüşleri:
- 01 - Herhangi bir istek bulunamadı veya API_CODE eksik.
- 02 - Herhangi bir API bilgisi bulunamadı.
- 03 - Abone No bilgisi hatalı.
- 04 - Herhangi bir Abone bilgisi bulunamadı.
- 05 - Abonelik tipiniz bu hizmete uygun değildir.
Sorgu için uniq_code ve member code ile birlikte sorgulama gerçekleştirilmektedir.
Parametre | Örnek Değer | Tip | Açıklama |
---|---|---|---|
member_no | 1000000001 | text | Abone tekil hat numarası |
uniq_code | {{uniq_code}} | text | Yetkiliden talep ediniz. |
curl -X POST 'https://ws.wiradius.com/online_bank/get_user_invoice/{{api_code}}' \
--form 'member_no=1000000001' \
--form 'uniq_code={{uniq_code}}' \
<?php
$post_fields = array();
$post_fields[ 'member_no' ] = '1000000001';
$post_fields[ 'uniq_code' ] = '{{uniq_code}}';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://ws.wiradius.com/online_bank/get_user_invoice/{{api_code}}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => $post_fields,
));
$response = curl_exec( $curl );
curl_close($curl);
echo $response; ?>
Dönüş Değerleri
Status 00 durumunda aşağıdaki çıktı türetilmektedir.
Sonuç bilgisi :
{
"status": "00",
"data": [
{
"invoice_id": "9529",
"document_number": "CTV2021000025654",
"cari_name": "UxXR KA___D_Z - BIREYSEL1",
"cari_code": "CARI-0000000839",
"document_datetime": "2026-05-01 14:42:37",
"expiry_datetime": "2026-05-11 14:42:37",
"amount": "71.42"
},{
"invoice_id": "9525",
"document_number": "CTV2021000025650",
"cari_name": "UxXR KA___D_Z - BIREYSEL1",
"cari_code": "CARI-0000000839",
"document_datetime": "2026-01-01 14:42:37",
"expiry_datetime": "2026-01-11 14:42:37",
"amount": "71.42"
}]
}
Status “00” ise işlem başarılı anlamına gelmektedir.
Status 00 'dan farklı ise hata kodu ve açıklamaları:
- 01 - Herhangi bir istek bulunamadı veya API_CODE eksik.
- 02 - Herhangi bir API bilgisi bulunamadı.
- 03 - Abone No bilgisi hatalı.
- 04 - Herhangi bir Abone bilgisi bulunamadı.
- 05 - Abonelik tipiniz bu hizmete uygun değildir.
- 06 - Ödenmemiş faturanız bulunmamaktadır.
Tahsilat işlemini başlatmak için gerekli zorunlu parametreler aşağıdaki gibidir;
- uniq_code
- member_no
- amount: Tutar bilgisi ( Örn : 100.57 veya 1067.61 vb. ) ( "." ) ondalık ayraçtır. "," gibi başka değerler reddedilir.
- payment_type: Ödeme tipi bilgisi ( Hesap, Kredi Kartı,Nakit ,Atm , Vb. ). ( Banka istediği tanım ile gönderebilir. Düzenli olması, iç raporlama için önemlidir.)
- invoice_id: Borç servisinden gelen invoice_id ( Borç sorgulamada dönüş alınan değerdir. ).
- order_no: Ödeme öncesi banka tarafından oluşturulacak rastgele 20 karakterlik sipariş numarası, bu fatura ödeme iptali için gereklidir.
- bank_name: Hangi kuruluş üzerinden ödeme geliyor ise o kuruluşun adı ( Entegasyonda farklı alt kuruluş ismi yer alabilir ).
- fullname: Ödeme yapan kişinin adı soyadı ( Ya* *_K_C ) Olabilir.
- reference: Ödeme öncesi banka tarafından oluşturulacak rastgele 20 karakterlik referans numarası, bu fatura iptali için gereklidir.
Parametre | Örnek Değer | Tip | Açıklama |
---|---|---|---|
amount | 1 | text | |
bank_name | BANK_ATM | text | |
fullname | TEST USER | text | |
invoice_id | 123 | number | |
member_no | 1000000001 | text | Abone tekil hat numarası |
order_no | 123 | text | |
payment_type | 000000000175088 | text | |
reference | 12345 | text | |
uniq_code | {{uniq_code}} | text | Yetkiliden talep ediniz. |
curl -X POST 'https://ws.wiradius.com/online_bank/user_payment/{{api_code}}' \
--form 'amount=1' \
--form 'bank_name=BANK_ATM' \
--form 'fullname=TEST USER' \
--form 'invoice_id=123' \
--form 'member_no=1000000001' \
--form 'order_no=123' \
--form 'payment_type=000000000175088' \
--form 'reference=12345' \
--form 'uniq_code={{uniq_code}}' \
<?php
$post_fields = array();
$post_fields[ 'amount' ] = '1';
$post_fields[ 'bank_name' ] = 'BANK_ATM';
$post_fields[ 'fullname' ] = 'TEST USER';
$post_fields[ 'invoice_id' ] = 123;
$post_fields[ 'member_no' ] = '1000000001';
$post_fields[ 'order_no' ] = '123';
$post_fields[ 'payment_type' ] = '000000000175088';
$post_fields[ 'reference' ] = '12345';
$post_fields[ 'uniq_code' ] = '{{uniq_code}}';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://ws.wiradius.com/online_bank/user_payment/{{api_code}}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => $post_fields,
));
$response = curl_exec( $curl );
curl_close($curl);
echo $response; ?>
Dönüş Cevap Örnekleri :
Status 00 ise başarılı şekilde işlem gerçekleşmiştir.
Status “00” değilse data bilgisi / hata dönüşleri:
- 01 - Herhangi bir istek bulunamadı veya API_CODE eksik.
- 02 - Herhangi bir API bilgisi bulunamadı.
- 03 - Abone No bilgisi hatalı.
- 04 - Herhangi bir Abone bilgisi bulunamadı.
- 05 - Abonelik tipiniz bu hizmete uygun değildir.
- 06 - İşlem numarası daha önce kullanılmış.
- 07 - Fatura bilgisi bulunamadı.
- 08 - Fatura ödenmiş durumdadır. Birkaç dakika içerisinde işleme alınacaktır. Lütfen bekleyiniz.
- 09 - Fatura ödenmiş durumdadır. Lütfen kontrol ediniz.
- 10 - Fatura ödeme bilgisi bulunamadı. Yetkililer ile görüşünüz.
- 11 - Fatura ödeme bilgisi bulunamadı. Yetkililer ile görüşünüz.
- 12 - Tutar bilgisi fatura tutarı ile uyuşmamaktadır.
- 13 - Ödeme işlemi başarısız..
- 14 - İşlem numarası eksik.
- 15 - Referans numarası eksik.
- 16 - Tutar bilgisi eksik.
- 17 - Ödeme Tipi bilgisi ( Hesap, Kredi Kartı vs. ) eksik.
- 18 - Fatura bilgisi eksik.
- 19 - Banka bilgisi eksik.
- 20 - Ad Soyad bilgisi eksik.
- 21 - Açıklama alanı hatalı.
Mutabakat Servisi - Tüm işlemlerin listesini almak için kullanılan servistir.
Serviste aşağıdaki alanlar gerekmektedir.
- uniq_code
- member_no: Zorunlu alan değildir. Abone özelinde sorgulama için kullanılabilir.
- begin_datetime: Sorgulama başlangıç zamanı ( Max 365 gün ). Tarih Formatı : (Y-m-d H:i:s )
- end_datetime: Sorgulama bitiş zamanı ( Max 365 gün ). Tarih Formatı : (Y-m-d H:i:s )
Parametre | Örnek Değer | Tip | Açıklama |
---|---|---|---|
begin_datetime | 2022-12-12 00:00:00 | text | Başlangıç Tarihi (Y-m-d H:i:s) |
end_datetime | 2022-12-12 23:59:59 | text | Bitiş Tarihi Formatı : Y-m-d H:i:s |
member_no | 1000000001 | text | Abone tekil hat numarası |
uniq_code | {{uniq_code}} | text | Yetkiliden talep ediniz. |
curl -X POST 'https://ws.wiradius.com/online_bank/consensus_list/{{api_code}}' \
--form 'begin_datetime=2022-12-12 00:00:00' \
--form 'end_datetime=2022-12-12 23:59:59' \
--form 'member_no=1000000001' \
--form 'uniq_code={{uniq_code}}' \
<?php
$post_fields = array();
$post_fields[ 'begin_datetime' ] = '2022-12-12 00:00:00';
$post_fields[ 'end_datetime' ] = '2022-12-12 23:59:59';
$post_fields[ 'member_no' ] = '1000000001';
$post_fields[ 'uniq_code' ] = '{{uniq_code}}';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://ws.wiradius.com/online_bank/consensus_list/{{api_code}}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => $post_fields,
));
$response = curl_exec( $curl );
curl_close($curl);
echo $response; ?>
Dönüş Parametreleri
- status
- data
Örnek cevap:
{
"status": "00",
"data": {
"id": "314",
"oid": "TEST0000000057",
"card_fullname": "uxxr kxxxxeniz",
"amount": "80",
"bank_name": null,
"pay_type": "KREDI KARTI",
"invoice_id": "9594",
"datetime": "2022-09-16 14:59:20",
"status": 4,
"status_description": "İptal Edilmiş"
}
}
Status 00 gelmesi durumunda yukarıdaki şekilde rapor paylaşılmaktadır.
Status 00'dan farklı gelmesi halinde aşağıdaki hata kodları ve açıklamalar dönmektedir.
Status “00” değilse data bilgisi / hata dönüşleri:
- 01 - Herhangi bir istek bulunamadı veya API_CODE eksik.
- 02 - Herhangi bir API bilgisi bulunamadı.
- 03 - Başlangıç tarihi formatı hatalıdır. "Y-m-d H:i:s" formatında gönderiniz.
- 04 - Bitiş tarihi formatı hatalıdır. "Y-m-d H:i:s" formatında gönderiniz.
- 05 - Başlangıç ve bitiş tarihi arasındaki fark 31 günden fazla olamaz.
- 06 - Başlangıç ve bitiş tarihi arasındaki fark 365 günden fazla olamaz.
Data > Status açıklamaları
- 1 - Başarılı
- 2 - Başarısız
- 3 - Başarılı / İşleniyor
- 4 - İptal Edilmiş
- 5 - İptal Talebi Alınmış
Mutabakat Servisi - Tüm işlemlerin listesi , Günsonu raporunu almak için kullanılan servisdir.
Serviste aşağıdaki alanlar gerekmektedir.
-
uniq_code
-
begin_datetime : sorgulama başlangıç zamanı ( Max 365 gün ) : Tarih Formatı : (Y-m-d H:i:s )
-
end_datetime : sorgulama bitiş zamanı ( Max 365 gün ) : Tarih Formatı : (Y-m-d H:i:s )
Başlangıç, bitiş tarihi paylaşılmaması durumunda sadece uniq_code ile servise ulaşılabilir. Bu durumda sorgulamadan bir önceki gün için günsonu raporu listesi dönecektir.
Parametre | Örnek Değer | Tip | Açıklama |
---|---|---|---|
begin_datetime | 2022-12-12 00:00:00 | text | Başlangıç Tarihi (Y-m-d H:i:s) |
end_datetime | 2022-12-12 23:59:59 | text | Bitiş Tarihi Formatı : Y-m-d H:i:s |
uniq_code | {{uniq_code}} | text | Yetkiliden talep ediniz. |
curl -X POST 'https://ws.wiradius.com/online_bank/consensus_list_report/{{api_code}}' \
--form 'begin_datetime=2022-12-12 00:00:00' \
--form 'end_datetime=2022-12-12 23:59:59' \
--form 'uniq_code={{uniq_code}}' \
<?php
$post_fields = array();
$post_fields[ 'begin_datetime' ] = '2022-12-12 00:00:00';
$post_fields[ 'end_datetime' ] = '2022-12-12 23:59:59';
$post_fields[ 'uniq_code' ] = '{{uniq_code}}';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://ws.wiradius.com/online_bank/consensus_list_report/{{api_code}}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => $post_fields,
));
$response = curl_exec( $curl );
curl_close($curl);
echo $response; ?>
Dönüş Değerleri
Dönüş Parametreleri:
- status
- data
Örnek Cevap:
{
"status": "00",
"data": [
{ // Başarılı gerçekleşen ödemelerin tutar ve kayıt sayısı .
"description": "Başarılı",
"status": 1,
"amount_total": "160.00",
"count_total": "2.00"
},
{ // Ödeme denemesi yapılan fakat başarısız gerçekleşen Tutar ve işlem sayısı
"description": "Başarısız",
"status": 2,
"amount_total": "0.00",
"count_total": "0.00"
},
{ // Tahsilat kayıdı başaralı fakat muhasebe kayıdı bir nedenle geciken işlem sayısı
"description": "Başarılı / İşleniyor",
"status": 3,
"amount_total": "0.00",
"count_total": "0.00"
},
{ // Iptal Edilmiş ödemelerin toplamı
"description": "İptal Edilmiş",
"status": 4,
"amount_total": "80.00",
"count_total": "1.00"
},
{ // Iptal işlemi aynı günden farklı ise iptal talebi olarak alınır .
"description": "İptal Talebi Alınmış",
"status": 5,
"amount_total": "128.00",
"count_total": "1.00"
},
{ // Tüm işlemlerin genel toplam tutar ve işlem bilgisi.
"description": "Toplam İşlem Tutarı ve Adeti",
"status": 6,
"amount_total": "368.00",
"count_total": "4.00"
}
]
}
Status 00 'dan farklı ise hata kodu ve açıklamaları:
- 01 - Herhangi bir istek bulunamadı veya API_CODE eksik.
- 02 - Herhangi bir API bilgisi bulunamadı.
- 03 - Başlangıç tarihi formatı hatalıdır. "Y-m-d H:i:s" formatında gönderiniz.
- 04 - Bitiş tarihi formatı hatalıdır. "Y-m-d H:i:s" formatında gönderiniz.
- 05 - Başlangıç ve bitiş tarihi arasındaki fark 365 günden fazla olamaz.
Abone Numarası ( member_no ) daha önce bir ödeme talimatı var mı kontrolü yapmak için ya da verilmiş bir talimatın aktif olup olmadığını sorgulamak için kullanilabilecek servistir.
Parametre | Örnek Değer | Tip | Açıklama |
---|---|---|---|
member_no | 1000000001 | text | Abone tekil hat numarası |
status | 2 | number | Durum |
uniq_code | {{uniq_code}} | text | Yetkiliden talep ediniz. |
curl -X POST 'https://ws.wiradius.com/online_bank/change_user_instruction_status/{{api_code}}' \
--form 'member_no=1000000001' \
--form 'status=2' \
--form 'uniq_code={{uniq_code}}' \
<?php
$post_fields = array();
$post_fields[ 'member_no' ] = '1000000001';
$post_fields[ 'status' ] = 2;
$post_fields[ 'uniq_code' ] = '{{uniq_code}}';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://ws.wiradius.com/online_bank/change_user_instruction_status/{{api_code}}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => $post_fields,
));
$response = curl_exec( $curl );
curl_close($curl);
echo $response; ?>
Servis Dönüş Değerleri
Dönüş Parametreleri:
- status
- data
Status “00” İşlem Başarılı.
İşlem başarısız ise hata kodu ve açıklamaları:
- 01 - Herhangi bir istek bulunamadı veya API_CODE eksik.
- 02 - Herhangi bir API bilgisi bulunamadı.
- 03 - Abone No bilgisi hatalı.
- 04 - Herhangi bir Abone bilgisi bulunamadı.
- 05 - Abonelik tipiniz bu hizmete uygun değildir.
- 06 - Status Parametresi hatalı.
- 07 - Ödeme talimatınız bulunmaktadır. Ödeme talimatınızı iptal ederek Yeni Ödeme Talimatı oluşturabilirsiniz.
- 08 - Ödeme talimatınız bulunmaktadır. Ödeme talimatınızı “TARAFIMIZDAN_FİRMA_İSMİ_OTOMATİK_GELECEKIR” Online İşlemler Mobile veya Web Uygulamasından iptal ederek Ödeme Talimatı oluşturabilirsiniz.
- 09 - Talimat Durum Değiştirme İşlemi başarısız.
Otomatik ödeme talimatı var mı yok mu sorgulamak için kullanılan fonksiyondur.
Parametre | Örnek Değer | Tip | Açıklama |
---|---|---|---|
member_no | 1000000001 | text | Abone tekil hat numarası |
uniq_code | {{uniq_code}} | text | Yetkiliden talep ediniz. |
curl -X POST 'https://ws.wiradius.com/online_bank/get_user_instructions/{{api_code}}' \
--form 'member_no=1000000001' \
--form 'uniq_code={{uniq_code}}' \
<?php
$post_fields = array();
$post_fields[ 'member_no' ] = '1000000001';
$post_fields[ 'uniq_code' ] = '{{uniq_code}}';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://ws.wiradius.com/online_bank/get_user_instructions/{{api_code}}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => $post_fields,
));
$response = curl_exec( $curl );
curl_close($curl);
echo $response; ?>
Dönüş Değerleri
Dönüş Parametreleri:
- status
- data
Status “00” ise işlem başarılı anlamına gelmektedir.
Status 00 'dan farklı ise hata kodu ve açıklamaları:
- 01 - Herhangi bir istek bulunamadı veya API_CODE eksik.
- 02 - Herhangi bir API bilgisi bulunamadı.
- 03 - Abone No bilgisi hatalı.
- 04 - Herhangi bir Abone bilgisi bulunamadı.
- 05 - Abonelik tipiniz bu hizmete uygun değildir.
- 06 - Ödeme talimatınız bulunmaktadır. Ödeme talimatınızı iptal ederek Yeni Ödeme Talimatı oluşturabilirsiniz.
- 07 - Ödeme talimatınız bulunmaktadır. Ödeme talimatınızı “TARAFIMIZDAN_FİRMA_İSMİ_OTOMATİK_GELECEKTIR” Online İşlemler Mobile veya Web Uygulamasından iptal ederek Ödeme Talimatı oluşturabilirsiniz.
Fatura ödeme onay işlemi gerçekleşen bir hizmetin, iptali talep ediliyorsa bu durumda bu servis yardımı ile işlem aynı gün içerisinde ise iptal talebi başarılı şekilde iptal edilir ve dönüş olarak başarılı sonucu gelecektir. İşlem tarihinden farklı bir günün iptal talebi söz konusu ise bu durumda iptal talep olarak alınır ve sistem yöneticisinin onayına düşecektir. bu durumda 09 hata kodunu dönecektir. Sistem yöneticisi onayladıktan sonra iptal işlemi gerçekleşmiş olacaktır.
Sorgulama metodu için;
- uniq_code: Firma Entegrasyon servis anahtarı
- member_no: Abone numarası
- referance: Ödeme işlemi referans numarası ( ödeme tahsilat servisine bankanın gönderdiği )
- order_no: Ödeme işlemi sipariş numarası ( ödeme tahsilat servisine bankanın gönderdiği )
Parametre | Örnek Değer | Tip | Açıklama |
---|---|---|---|
member_no | 1000000001 | text | Abone tekil hat numarası |
order_no | 000000000175088 | text | Bu Bilgi mail ile paylaşılmıştır. |
reference | 000000000175088 | text | Bu Bilgi mail ile paylaşılmıştır. |
uniq_code | {{uniq_code}} | text | Yetkiliden talep ediniz. |
curl -X POST 'https://ws.wiradius.com/online_bank/payment_cancel/{{api_code}}' \
--form 'member_no=1000000001' \
--form 'order_no= 000000000175088' \
--form 'reference= 000000000175088' \
--form 'uniq_code={{uniq_code}}' \
<?php
$post_fields = array();
$post_fields[ 'member_no' ] = '1000000001';
$post_fields[ 'order_no' ] = ' 000000000175088';
$post_fields[ 'reference' ] = ' 000000000175088';
$post_fields[ 'uniq_code' ] = '{{uniq_code}}';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://ws.wiradius.com/online_bank/payment_cancel/{{api_code}}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => $post_fields,
));
$response = curl_exec( $curl );
curl_close($curl);
echo $response; ?>
Dönüş Değerleri
Dönüş Parametreleri:
- status
- data
Status = 00 ise işlem başarılıdır .
Status 00 'dan farklı bir değer almış ise aşağıdaki hata kodları ve açıklamaları gelecektir .
Status “00” değilse data bilgisi / hata dönüşleri:
- 01 - Herhangi bir istek bulunamadı veya API_CODE eksik.
- 02 - Herhangi bir API bilgisi bulunamadı.
- 03 - Abone No bilgisi hatalı.
- 04 - Herhangi bir Abone bilgisi bulunamadı.
- 05 - Abonelik tipiniz bu hizmete uygun değildir.
- 06 - İşlem numarası bulunamadı.
- 07 - Referans numarası bulunamadı.
- 08 - Herhangi bir ödeme bilgisi bulunamadı.
- 09 - Talimatınız alınmıştır. Yetkililer tarafından bilgilendireleceksiniz.
- 10 - Ödeme İptali İşlemi başarısız.
- 11 - Ödemeniz otomatik olarak İPTAL edilmiştir.