Операциялар

Операциялар бойынша деректерді ауқыммен алу

TEST URL https://testepay.homebank.kz/api/operations
PROD URL https://epay-api.homebank.kz/operations

Авторизация қажет

Авторизация түрі: Password credentials

scope: webapi usermanagement email_send verification statement statistics payment

Кіру параметрлері JSON түрінде беріледі: Модель келесі түрде ұсынылған:

{
    "paging":{
            "page": ,
            "size": 
            },
    "searchParameters":[
    {
            "name":"",
            "method":"",
            "searchParameter":["","",...]
    }
    ],
    "orderParameters":[
    {
        "field":"",
        "typeOrder":"ASC/DESC"
    }
    ]
}

«Paging» блогына екі параметрді беру керек:

• «page» - өткізіп жіберу керек жазбалар саны;
• «size» - бетке шығарылуы керек жазбалар саны.

«searchParameters» блогына үш параметрді беру керек, сонымен қатар көптеген жол бойынша іздеуге болады: (сұрау салу мысалында)

• «name» ретінде көрсетілген - жолдың атауы (сүзгі) ол бойынша ДБ-да іздеу жүреді, тізім төменде келтірілген;
• «method» - іздеу әдісі (келесі түрде көрсетіңіз: between, in, like , = , < , > , <= , >= ) ;
• «searchParameter» - іздеу параметрлері. Between іздеу әдісін қолданған кезде 2 параметрді, like-ті пайдаланған кезде бір параметрді беру керек, онда % белгісі бар, in іздеу әдісінде кем дегенде 1 параметрді пайдалану керек. Параметрлер дұрыс берілмеген жағдайында қате қайта оралады. Сұрау салуда транзакция кезеңі көрсетілуі керек. Бұл іздеу параметрі міндетті болып табылады.

«OrderParameters» блогына екі параметрді беруге болады:

• «field» - сұрыптау жүргізілетін жолдың атауы;
• • «typeOrder» - ASC/DESC сұрыптау түрі. Егер сұрыптау қажет болмаса немесе бірнеше жолдар бойынша сұрыптау қажет болмаса, бұл блокты бос қалдыруға болады (төмендегі мысалда келтірілген).

Назар аударыңыз! Created_date бойынша іздеу әдісі міндетті болып табылады

Сүзгілер:

Қайтару сомасы:

{
    "paging":{
            "page": 0,
            "size": 2
            },
    "searchParameters":[
    {
            "name":"created_date",
            "method":"between",
            "searchParameter":["2017-11-19T00:00:00Z", "2018-11-20T00:00:00Z"]
    },
    {
            "name":"description",
            "method":"in",
            "searchParameter":["description"]
    },
    {
            "name":"payer_email",
            "method":"like",
            "searchParameter":["danatugumbayeva%"]
    }
    ],
    "orderParameters":[
    {
        "field":"payer_email",
        "typeOrder":"ASC"
    },
    {
        "field":"description",
        "typeOrder":"DESC"
    }
    ]
}

Жауап JSON түрінде қайтарылады:

{
    "totalCount": 2,
    "records": [
        {
            "id": "b9d46313-264e-41ec-814c-728dd51eb97f",
            "amount": 1000,
            "orgAmount: 1000,
            "currency": "KZT",
            "amountBonus": 80,
            "invoiceId": "",
            "accountId": "",
            "payerIp": "10.6.50.57",
            "payerName": "Tester Petrov",
            "payerPhone": "77777777777",
            "payerEmail": "test@gmail.com",
            "description": "description",
            "data": "",
            "createdDate": "2018-10-27T15:08:14+06:00",
            "authDate": "2018-10-27T15:08:14+06:00",
            "confirmDate": "2018-10-27T15:08:14+06:00",
            "payoutDate": "2018-12-29T00:01:01.374084+06:00",
            "payoutAmount": 1000,
            "ipCountry": "",
            "ipCity": "",
            "ipRegion": "",
            "ipDistrict": "",
            "ipLatitude": 0,
            "ipLongitude": 0,
            "cardType":"MasterCard",
            "issuer":"Казкоммерцбанк",
            "issuerBankCountry":"",
       		"status":"AUTH",
       		"reference":"034580951245",
       		"client":"polisonline",
       		"language":"RU",
       		"failureLink":"https://page.site.kz/failureLink",
       		"postLink":"https://page.site.kz/postLink",
       		"postLinkStatus":true,
       		"merchant":"merchantName",
       		"shop":"merchantShop",
       		"secure3D":false,
       		"cardMask":"5483...0413",
       		"installment":null,
       		"resultCode":"00",
       		"resultMessage":""
        },
        {
            "id": "b9d46313-264e-41ec-814c-728dd525877f",
            "amount": 500,
            "orgAmount: 1000,
            "currency": "KZT",
            "amountBonus": 80,
            "invoiceId": "",
            "accountId": "",
            "payerIp": "10.6.50.57",
            "payerName": "Tester Petrov",
            "payerPhone": "77777777777",
            "payerEmail": "test@gmail.com",
            "description": "description",
            "data": "",
            "createdDate": "2018-10-27T15:08:14+06:00",
            "authDate": "2018-10-27T15:08:14+06:00",
            "confirmDate": "2018-10-27T15:08:14+06:00",
            "payoutDate": "2018-12-29T00:01:01.374084+06:00",
            "payoutAmount": 0,
            "ipCountry": "",
            "ipCity": "",
            "ipRegion": "",
            "ipDistrict": "",
            "ipLatitude": 0,
            "ipLongitude": 0,
            "cardType":"MasterCard",
            "issuer":"Казкоммерцбанк",
            "issuerBankCountry":"",
       		"status":"CHARGE",
       		"reference":"034580958547",
       		"client": "polisonline",
       		"language": "RU",
       		"failureLink":"https://page.site.kz/failureLink",
       		"postLink":"https://page.site.kz/postLink",
       		"postLinkStatus":true,
       		"merchant": "merchantName",
       		"shop": "merchantShop",
       		"secure3D":false,
       		"cardMask":"5483...0413",
       		"installment":null,
       		"resultCode":"00",
       		"resultMessage":""
        }
    ]
}

Қате туралы жауап JSON түрінде қайтарылады:

{
    "code": 232,
    "message": "Метод поиска отсутствует"
}