We are using cookies in our website in order to offer better service to you. You allow us to use cookies by continuing to use our internet website. You can reach the detailed information on cookies from our Privacy Policy and Cookies Policy.
X
Home > Api Products > Donation Payments

Donation Payments

Description

This API is used to payments of donations.

Institutions

This API is used to retrieve institutions list.

How it Works

Sample Request

GET /api/isbank/v1/donation-institutions
Headers:
X-IBM-client-id: {YOUR_CLEINT_ID} 
X-IBM-client-secret: {YOUR_CLEINT_SECRET} 
Authorization: Bearer {access_token}
Content-Type: application/json


Services of Institutions

This API is used to retrieve service list of institutions.

How it Works

Sample Request

GET /api/isbank/v1/donation-institution-services/10065
Headers:
X-IBM-client-id: {YOUR_CLEINT_ID} 
X-IBM-client-secret: {YOUR_CLEINT_SECRET} 
Authorization: Bearer {access_token}
Content-Type: application/json


Payments

This API is used to execute donation payment.

How it Works​

Parameters

This part needs to be in body of the request.

{
    "debtor_account_id": 43642864,
    "idempotency_key": "38f93ecc-88ce-4e58-82a8-6b93a4ae8739",
    "quantity": 1,
    "amount": 265,
    "currency_code": "EUR",
    "predefined_collectable_id": 67,
    "debtor_use_of_overdraft": false,
    "debtor_use_of_sos": false,
    "service_id": 10115,
    "description": "Kurban Bağışı",
    "basic_input_values": [
        {
            "name": "Description",
            "value": "Kurban Bağışı"
        },
        {
            "name": "Name",
            "value": "Ali"
        },
        {
            "name": "Surname",
            "value": "Veli"
        },
        {
            "name": "Tckn",
            "value": "86843441446"
        },
        {
            "name": "Email",
            "value": "aliveli@gmail.com"
        },
        {
            "name": "CellPhone",
            "value": "5321112233"
        }
    ],
    "selected_input_values": [
        {
            "name": "OnBehalfOf",
            "selected_item": {
                "key": "K",
                "value": "Kendi Adıma"
            }
        }
    ],
    "complex_input_values": [
        {
            "name": "Address",
            "basic_input_field_values": [
                {
                    "name": "Country",
                    "value": "TÜRKİYE"
                },
                {
                    "name": "Province",
                    "value": "İSTANBUL"
                },
                {
                    "name": "District",
                    "value": "TUZLA"
                },
                {
                    "name": "Quarter",
                    "value": "TUTOM"
                },
                {
                    "name": "AddressText",
                    "value": "B-1"
                }
            ]
        }
    ],
    "customer_ip": "1.1.1.1"
}

Sample Request

GET /api/isbank/v1/donation-payments
Headers:
X-IBM-client-id: {YOUR_CLEINT_ID} 
X-IBM-client-secret: {YOUR_CLEINT_SECRET} 
Authorization: Bearer {access_token}
Content-Type: application/json



Sample Response

Sample Response for Institutions

{
    "data": [
        {
            "id": 21365,
            "name": "Kızılay",
            "contract_type": "BAGIS",
            "executing_system": "PH",
            "services": [
                {
                    "id": 10115,
                    "name": "Yurtdışı Kesimli Kurban",
                    "payment_instruments": [
                        "DEPOSITACCOUNT",
                        "CASH",
                        "CREDITCARD",
                        "TEMP"
                    ]
                }
            ]
        },
        {
            "id": 21364,
            "name": "Darüşşafaka Cemiyeti",
            "contract_type": "BAGIS",
            "executing_system": "PH",
            "services": [
                {
                    "id": 10065,
                    "name": "Kesimli Adak",
                    "payment_instruments": [
                        "DEPOSITACCOUNT",
                        "CASH",
                        "CREDITCARD",
                        "CREDITCARD_NOTONUS",
                        "DEBITCARD",
                        "DEBITCARD_NOTONUS",
                        "PREPAIDCARD"
                    ]
                }
            ]
        }
    ]
}

Sample Response for Services

{
    "data": {
        "service_id": 10065,
        "payment_features": {
            "collectable_payment_allowed": false,
            "free_payment_allowed": true,
            "collectable_payment_options": {
                "allowed_if_payment_order_exist": false,
                "exceed_payment_allowed": false,
                "partial_payment_allowed": false
            }
        },
        "free_collection_query_specs": {
            "input_method": {
                "type": "Payment"
            },
            "predefined_collectables": [
                {
                    "main_info": []
                }
            ],
            "input_fields": [
                {
                    "label": "Kimin Adına",
                    "name": "OnBehalfOf",
                    "required": false,
                    "parameter_type": "\n            ",
                    "items": [
                        {
                            "key": "K",
                            "value": "Kendi adıma"
                        },
                        {
                            "key": "B",
                            "value": "Başkası adına"
                        }
                    ],
                    "regex": "\n            ",
                    "sample": "\n            ",
                    "description": "Lütfen Başkası adına/Kendi adıma seçiniz",
                    "group_index": 0,
                    "type": "\n            ",
                    "input_fields": [
                        {
                            "items": []
                        }
                    ]
                },
                {
                    "label": "Adına Bağış Yapılan",
                    "name": "SubscriberName",
                    "required": true,
                    "parameter_length": {
                        "max": 100,
                        "min": 1
                    },
                    "ui_hint": "CUSTOMER_NAME",
                    "parameter_type": "Alphanumeric",
                    "items": [],
                    "description": "Lütfen Adı/Ünvan alanını doldurunuz.",
                    "group_index": 1,
                    "type": "\n            ",
                    "input_fields": [
                        {
                            "items": []
                        }
                    ]
                },
                {
                    "label": "TCKN/VKN/YKN",
                    "name": "Tckn_Vkn_Ykn",
                    "required": true,
                    "parameter_length": {
                        "max": 11,
                        "min": 11
                    },
                    "ui_hint": "CUSTOMER_TCKN_VKN_YKN",
                    "parameter_type": "Numeric",
                    "items": [],
                    "description": "Lütfen TCKN/VKN/YKN alanını doldurunuz.",
                    "group_index": 2,
                    "type": "\n            ",
                    "input_fields": [
                        {
                            "items": []
                        }
                    ]
                },
                {
                    "label": "Adres",
                    "name": "Address",
                    "required": false,
                    "parameter_type": "\n            ",
                    "items": [],
                    "regex": "\n            ",
                    "sample": "\n            ",
                    "description": "Lütfen adres alanını giriniz",
                    "group_index": 3,
                    "type": "\n            ",
                    "input_fields": [
                        {
                            "description": "Lütfen Ülke alanını doldurunuz.",
                            "label": "Ülke",
                            "name": "Country",
                            "parameter_length": {
                                "max": "100",
                                "min": "1"
                            },
                            "parameter_type": "Alphanumeric",
                            "required": "true",
                            "ui_hint": "CUSTOMER_ADDRESS_COUNTRY",
                            "items": [],
                            "type": "\n                "
                        },
                        {
                            "description": "Lütfen il alanını doldurunuz.",
                            "label": "İl",
                            "name": "Province",
                            "parameter_length": {
                                "max": "20",
                                "min": "1"
                            },
                            "parameter_type": "Alphanumeric",
                            "required": "true",
                            "ui_hint": "CUSTOMER_ADDRESS_PROVINCE",
                            "items": [],
                            "type": "\n                "
                        },
                        {
                            "description": "Lütfen ilçe alanını doldurunuz.",
                            "label": "İlçe",
                            "name": "District",
                            "parameter_length": {
                                "max": "20",
                                "min": "1"
                            },
                            "parameter_type": "Alphanumeric",
                            "required": "false",
                            "ui_hint": "CUSTOMER_ADDRESS_DISTRICT",
                            "items": [],
                            "type": "\n                "
                        },
                        {
                            "description": "Lütfen semt alanını doldurunuz.",
                            "label": "Semt",
                            "name": "Quarter",
                            "parameter_length": {
                                "max": "20",
                                "min": "1"
                            },
                            "parameter_type": "Alphanumeric",
                            "required": "false",
                            "ui_hint": "CUSTOMER_ADDRESS_QUARTER",
                            "items": [],
                            "type": "\n                "
                        },
                        {
                            "description": "Lütfen posta kodu alanını giriniz",
                            "label": "Posta kodu",
                            "name": "PostalCode",
                            "parameter_length": {
                                "max": "10",
                                "min": "1"
                            },
                            "parameter_type": "Alphanumeric",
                            "required": "false",
                            "ui_hint": "CUSTOMER_ADDRESS_POSTALCODE",
                            "items": [],
                            "type": "\n                "
                        },
                        {
                            "description": "Lütfen adres alanını doldurunuz.",
                            "label": "Adres",
                            "name": "AddressText",
                            "parameter_length": {
                                "max": "60",
                                "min": "1"
                            },
                            "parameter_type": "Alphanumeric",
                            "required": "true",
                            "ui_hint": "CUSTOMER_ADDRESS_TEXT",
                            "items": [],
                            "type": "\n                "
                        }
                    ]
                },
                {
                    "label": "E-Posta",
                    "name": "Email",
                    "required": false,
                    "parameter_length": {
                        "max": 100,
                        "min": 3
                    },
                    "ui_hint": "CUSTOMER_EMAIL",
                    "parameter_type": "Alphanumeric",
                    "items": [],
                    "description": "Lütfen e-posta adresi alanını doldurunuz.",
                    "group_index": 4,
                    "type": "\n            ",
                    "input_fields": [
                        {
                            "items": []
                        }
                    ]
                },
                {
                    "label": "Telefon numarası",
                    "name": "PhoneNumber",
                    "required": false,
                    "parameter_length": {
                        "max": 10,
                        "min": 10
                    },
                    "ui_hint": "CUSTOMER_PHONENUMBER",
                    "parameter_type": "Alphanumeric",
                    "items": [],
                    "description": "Lütfen telefon numarası alanını doldurunuz.",
                    "group_index": 5,
                    "type": "\n            ",
                    "input_fields": [
                        {
                            "items": []
                        }
                    ]
                },
                {
                    "label": "Cep Telefonu Numarası",
                    "name": "CellPhone",
                    "required": false,
                    "parameter_length": {
                        "max": 10,
                        "min": 10
                    },
                    "ui_hint": "CUSTOMER_CELLPHONENUMBER",
                    "parameter_type": "Alphanumeric",
                    "items": [],
                    "description": "Lütfen cep telefonu numarası alanını doldurunuz.",
                    "group_index": 6,
                    "type": "\n            ",
                    "input_fields": [
                        {
                            "items": []
                        }
                    ]
                },
                {
                    "label": "Açıklama",
                    "name": "Description",
                    "required": false,
                    "parameter_length": {
                        "max": 100,
                        "min": 1
                    },
                    "parameter_type": "Alphanumeric",
                    "items": [],
                    "description": "Lütfen açıklama alanını doldurunuz.",
                    "group_index": 7,
                    "type": "\n            ",
                    "input_fields": [
                        {
                            "items": []
                        }
                    ]
                }
            ],
            "display_info": []
        },
        "collectable_query_specs": {
            "input_fields": {
                "input_fields": {
                    "type": 0
                }
            },
            "display_info": []
        },
        "amount_input": {
            "selected_amount_limitation": {
                "currency_code": "TRY"
            },
            "amount_limitations": {
                "amount_range": [
                    {
                        "currency_code": "TRY",
                        "max_value": 999999999999,
                        "min_value": 900
                    },
                    {
                        "currency_code": "USD",
                        "max_value": 999999999999,
                        "min_value": 295
                    },
                    {
                        "currency_code": "EUR",
                        "max_value": 999999999999,
                        "min_value": 265
                    }
                ]
            },
            "decimal_fraction_allowed": true,
            "type": "FreeAmount"
        }
    }
}

​Payments

Sample Response

{
    "data": {
        "payment_id": "2493761",
        "execution_date": "2020-08-14T10:03:14.7450165+03:00",
        "amount": 265,
        "overdraft_amount": 0,
        "sos_used": false,
        "overdraft_currency_code": "TRY",
        "currency_code": "EUR"
    }
}