Аударымдар бойынша операцияларды тізіммен сұрату

Токенді алу

TEST URL POST https://testoauth.homebank.kz/epay2/oauth2/token
PROD URL POST https://epay-oauth.homebank.kz/oauth2/token

Body-ға сұрау салу Body: form-data

grant_type:     "password"
username:       "USERNAME"
password:       "USERPASSWORD"
scope:          "transfer"
client_id:      "CLIENTID"
client_secret:  "CLIENTSECRET"

Жауап

   {
     "access_token":"DCEB8O_ZM5U7SO_T_U5EJQ",
     "expires_in": 7200,
     "refresh_token":"",
     "scope":"transfer",
     "token_type":"Bearer"
   }

URL https://testepay.homebank.kz/api/p2p/operations

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

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

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

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

Сүзгілер:

Сұрау салу мысалы, JSON:

{
    "paging": {
        "page": 0,
        "size": 20
    },
    "searchParameters": [
        {
            "name": "created_at",
            "method": "between",
            "searchParameter": [
                "2022-01-10T12:00:00.000Z",
                "2022-02-10T13:59:59.999Z"
            ]
        }
    ],
    "orderParameters": [
        {
            "field": "created_at",
            "typeOrder": "ASC"
        },
        {
            "field": "id",
            "typeOrder": "ASC"
        }
    ]
}

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

{
    "totalCount": 132,
    "records": [
        {
            "id": "f0c79d0d-1b98-4b8c-8ea3-83a110be191e",
            "dateTime": "2022-02-03T11:42:35.533398+06:00",
            "invoiceId": "123456789377804",
            "amount": 200,
            "currency": "KZT",
            "terminal": "98151552",
            "accountId": "",
            "description": "TEST p2p",
            "language": "",
            "senderCardMask": "4003********9821",
            "receiverCardMask": "5578********0613",
            "senderCardType": "VISA",
            "receiverCardType": "MasterCard",
            "senderIssuer": "",
            "receiverIssuer": "",
            "reference": "203480420271",
            "secure": "",
            "code": "00",
            "reason": "",
            "reasonCode": 0,
            "name": "Sergey Frolov",
            "email": "dosbols@halykbank.kz",
            "phone": "",
            "ip": "",
            "ipCountry": "",
            "ipCity": "",
            "ipRegion": "",
            "ipDistrict": "",
            "ipLongitude": 0,
            "ipLatitude": 0,
            "status": "ok",
            "senderCardId": "",
            "receiverCardId": ""
        }
    ]
}

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

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