Bağış Sorgulama

Bu API kurumların bağış hareketlerini listelemektedir.

API Bilgileri

URL

/donationInquiry

Metot

POST

Versiyon

1.0

Scope

payment

Yetkilendirme Yöntemi

Client Credentials


Girdi Bilgileri

Alan Adı Format Açıklama Zorunlu/Opsiyonel

StartDate

yyyy-MM-dd Başlangıç tarihi Zorunlu

EndDate

yyyy-MM-dd Bitiş tarihi Zorunlu

CampaignCode

String (250) Bagış kampanya kodu Opsiyonel

LastId

Integer Belirtilen son id’den itibaren sonuçlar getirilir Opsiyonel


Çıktı Bilgileri

List< Transaction >

Alan Adı Format Açıklama

CurrencyCode

String Döviz cinsi

IdentityNumber

String T.C. kimlik numarası

NameSurname

String Ad soyad

CollectionStanNumber

String Tahsilat stan no

CollectionDate

yyyy-MM-ddTHH24:mm:ss Tahsilat tarihi

CollectionStatusCode

Integer Tahsilat durum kodu
0=None, 1=TahsilEdildi, 2=TahsilatIptalEdildi, 3=BakiyeYetersiz, 4=HesapKapali, 5=TahsilEdilmedi, 6=ManuelIadeEdildi, 7=ManuelIadeBekliyor

Description

String Açıklama

ChannelCode

Integer Giriş kanal kodu
None = 0, Branch = 1, ATM = 2, POS = 3, Internet = 4, CallCenter = 5, Mobile = 6, VirtualPOS = 7, IVR = 8, RegularPayment = 9, Unit = 10, WebServiceBanking = 11, OtherBankATM = 12, OtherBankPOS = 13, OnSiteBanking = 14, CallCenterIntegration = 15, ScheduledOperations = 51, PeriodicOperation = 52, EventHandler = 53, Integration = 54, AsynchronousOperation = 55, OperationCenter = 56, BusinessPartners = 57, WebChannels = 58, QueueMatic = 59, CentralCollection = 60, VITMobil = 61, SesliIVR = 62, WebChat = 63, ApiGateway = 64, MobileAssistant = 65, CommonATM = 66, DigitalBank = 67, EbisDestekWebChat = 68, TellerTablet = 69

BranchCode

String Giriş şube kodu

Address

String Adres

PhoneNumber

String Telefon numarası

MobileNumber

String Cep telefonu numarası

Item

Integer Adet

Email

String E-Posta

CountryName

String Ülke adı

CountryCode

String Ülke kodu

CityName

String İl adı

CityCode

Integer İl kodu

DistrictName

String İlçe adı

DistrictCode

Integer İlçe kodu

DonatedonBehalf

String Adına bagış yapılan ad soyad

AccountNumber

String Depo hesap numarası

BranchName

String Giriş şube adı

DonationType

String Bagış tipi

DonationName

String Bagış adı

ReceiptNumber

String Dekont numarası

InvoiceAmount

Decimal Fatura tutarı

Result

Alan Adı Format Açıklama

ErrorCode

Integer Hata kodu
0= None, 1= BasariliIslem, 2= ApiKeyBosOlamaz, 3= ApiKeyTanimiBulunamadi, 4= ApiKeyTanimiHatali, 5= BaslangicTarihiBosOlamaz, 6= BitisTarihiBosOlamaz, 99= SistemHatasi

ErrorDescription

String Hata açıklaması

TransactionStatusCode

Integer İşlem durum kodu
0= HataliIslem, 1= BasariliIslem


Mesaj Kodları

Mesaj Kodu Açıklama

ACBH000025

Başlangıç tarihi formatı hatalıdır.

ACBH000026

Bitiş tarihi formatı hatalıdır.

ACBH000100

Başlangıç tarihi bitiş tarihinden büyük olamaz.

ACBH000248

Başlangıç tarihi boş olamaz.

ACBH000249

Bitiş tarihi boş olamaz.

ACBH000335

Kampanya kodu uygun formatta girilmelidir.

Örnek

İstek:

{
    "StartDate" : "2015-01-01",
    "EndDate" : "2021-01-01",
    "CampaignCode": "",
    "LastId": 1
}

Cevap:

{
    "Header": {
        "StatusCode": "APIGW000000",
        "StatusDescription": "Tamamlandı",
        "StatusDescriptionEn": "Completed",
        "ObjectID": "e7a2252f-8ced-49e1-861a-5a25fdfe9268"
    },
    "Data": {
        "Transaction": {
            "CityCode": 6,
            "Description": "",
            "Email": "abc@vakifbank.com.tr",
            "CollectionDate": "2015-01-01T00:00:00",
            "Address": "HGFHGFH BLV. NO:4",
            "CountryName": "Türkiye",
            "ChannelCode": 4,
            "Item": 1,
            "BranchName": "İNTERNET ŞUBESİ",
            "CountryCode": "TR",
            "DistrictCode": 607,
            "ReceiptNumber": 2020000027190781,
            "DonationType": 0,
            "CityName": "Ankara",
            "CollectionStatusCode": 1,
            "AccountNumber": "00158000000000000",
            "DistrictName": "Çamlıdere",
            "NameSurname": "VARLI SİGORTA EKSPER LİK HİZ.LTD.ŞTİ.",
            "MobileNumber": 5999999999,
            "DonationName": "",
            "PhoneNumber": 5999999999,
            "CollectionStanNumber": "0000000000000000005",
            "CurrencyType": "TL",
            "BranchCode": "S00725",
            "DonatedonBehalf": "emre",
            "IdentityNumber": "0230019204"
        },
        "Result": {
            "ErrorDescription": "",
            "TransactionStatusCode": 1,
            "ErrorCode": 1
        }
    }
}