Donation Inquiry

This API lists institution’s donation transactions.

API Information

URL

 /donationInquiry

Method

 POST

Version

 1.0

Scope

 payment

Authorization Flow

 Client Credentials


Input Information

Name Format Description Required/Optional

StartDate

 yyyy-MM-dd Start date Required

EndDate

 yyyy-MM-dd End date Required

CampaignCode

 String (250) Donation campaign code Optional

LastId

 Integer Returns last results from last id Optional


Output Information

List< Transaction >

Name Format Description

CurrencyCode

 String Currency code

IdentityNumber

 String T.R. Identity number

NameSurname

 String Name surname

CollectionStanNumber

 String Collection stan no

CollectionDate

 yyyy-MM-ddTHH24:mm:ss Collection date

CollectionStatusCode

 Integer Collection status code
0=none 1=Charged 2=Collection canceled 3=Insufficient balance 4= Account Closed 5= Cannot charged 6=Manualy charge back 7=Waiting manually charge back

Description

 String Description

ChannelCode

 Integer Channel Code
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 Branch Code

Address

 String Address

PhoneNumber

 String Phone number

MobileNumber

 String Cell phone number

Item

 Integer Item

Email

 String E-mail

CountryName

 String Country name

CountryCode

 String Country code

CityName

 String City name

CityCode

 Integer City code

DistrictName

 String District name

DistrictCode

 Integer District code

DonatedonBehalf

 String Name surname of donated on behalf

AccountNumber

 String Account number

BranchName

 String Branch name

DonationType

 String Donation type

DonationName

 String Donation name

ReceiptNumber

 String Receipt number

InvoiceAmount

 Decimal Invoice amount

Result

Name Format Description

ErrorCode

 Integer Error Code
0= None, 0=None 1=Successful Transaction 2=Api Key cannot be empty 3= Api key defination cannot be found 4=Api key definition is incorrect 5=Start date cannot be empty. 6=End date cannot be empty. 99=System error

ErrorDescription

 String Error description

TransactionStatusCode

 Integer Transaction status code
0=Incorrect transaction 1=Successful transaction


Message Codes

Message Code Description

ACBH000025

Start date format is incorrect.

ACBH000026

End date format is incorrect.

ACBH000100

Start date cannot be greater than end date.

ACBH000248

Start date cannot be empty.

ACBH000249

End date cannot be empty.

ACBH000335

Campaign code format is incorrect.

Example

Request:

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

Response:

{
    "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
        }
    }
}