Долбоор
Банк жана төлөм кызмат көрсөтүүлөрүнүн маалыматтарын алмашуу жана пайдалануу үчүн API СТАНДАРТЫ
1. Жалпы жобо
1. Бул стандарт ачык банктык интерфейстер аркылуу өз ара иш алып баруунун алкагында маалымат алмашуу боюнча жетектөө принциптерин жана API стандарттарын камтыйт. Стандарттын негизги максаты - маалыматтардын ачык-айкындуулугун, коопсуздугун жана жеткиликтүүлүгүн камсыз кылуу аркылуу ачык API чөйрөсүндө катышуучулардын өз ара иш алып баруусуна бирдиктүү ыкма түзүү.
2. Бул стандарт коммерциялык банктар, төлөм уюмдары, төлөм системасынын операторлору жана Кыргыз Республикасынын аймагында иштеп жаткан ачык API чөйрөсүнүн башка катышуучулары тарабынан колдонууга сунушталат.
3. Бул стандартта төмөнкү терминдер жана алардын аныктамалары колдонулат:
API (Application programming interfaces) - программалык тиркемелерди түзүү үчүн нускоолордун, протоколдордун жана инструменттердин жыйындысы. API программалык компоненттердин кандайча өз ара иш алып барууга тийиш экендигин аныктайт.
Көп факторлуу аутентификация – билим, ээлик жана ажырагыс деп классификацияланган эки же андан көп элементтерди колдонууга негизделген аутентификация. Бул пункттар көз карандысыз, анткени биринин бузулушу башкалардын ишенимдүүлүгүнө коркунуч келтирбейт.
Ачык API - бирдиктүү API стандартынын негизинде маалыматтарды санарип алмашуу мүмкүнчүлүгүн камсыз кылган программалык интерфейстер.
Колдонуучу - банкта тейленген жеке адам, жеке ишкер жана юридикалык жак.
Эсептерди тейлөө боюнча төлөм кызмат көрсөтүүлөрүн сунуштоочу (ASPSP) – бул колдонуучунун эсебин тейлеген жана ачык API жарыялаган коммерциялык банк.
Төлөмдөрдү демилгелөө боюнча кызмат көрсөтүүлөрүн сунуштоочу (PISP) – колдонуучуга акча каражаттарын которууну демилгелөө боюнча кызмат көрсөтүүчү юридикалык жак.
Эсептер жөнүндө маалыматты берүү боюнча кызмат көрсөтүүлөрдү сунуштоочу (AISP) – колдонуучуга колдонуучунун банктык эсеби (эсептери) жөнүндө маалыматты алуу боюнча кызмат көрсөтүүчү юридикалык жак.
Макулдук - API колдонуучусу менен API сунуштоочунун ортосунда банк эсептери боюнча маалыматтарды иштеп чыгууга жана берүүгө API сунуштоочу тарабында кардардын макулдугу.
Ачык API чөйрөсү – бул ачык банк интерфейстеринин стандарттарынын комплекси, башкаруу, системалар, процесстер, коопсуздук жана катышуучуларды колдоо үчүн колдонулган жол-жоболор.
Башка сунуштоочу (TPP) – маалымат кызматтарды көрсөтүү (AISP) же акча каражаттарын (төлөмдөрдү) которууларды (PISP) жүзөгө ашыруу максатында колдонуучунун банктык эсебинен пайдалануу үчүн ачык API колдонгон юридикалык жак.
4. ASPSP жана TPP ортосундагы маалымат алмашуу ачык API ASPSP тарабында түзүлгөн электрондук билдирүүлөр аркылуу ишке ашырылат.
2. API принциптери жана дизайны
5. Архитектура принциптери ачык API чөйрөсүнүн архитектурасы RESTful API концепциясына ылайык келет.
6. Физикалык деңгээлде, билдирүүлөрдү долбоорлоодо YAML форматында 3-версиянын Open интерфейсинин баяндоо тили колдонулат.
3. Керектөөчүлөрдүн укугун коргоо
7. Ачык API чөйрөсүнүн катышуучулары колдонуучуларга башкалардан тышкары, төмөнкү маалыматтарды камтыган маалыматтын минималдуу көлөмүн ачууну камсыз кылат:
- ачык API чөйрөсүндөгү катышуучунун толук жана (же) кыскартылган (эгерде бар болсо) фирмалык аталышы, жайгашкан жериндеги дареги, электрондук почтасынын дареги, байланыш телефону, расмий интернет сайттын дареги (эгерде бар болсо);
- колдонуучуларга кызмат (сервис) көрсөтүүнү алуу тартиби, колдонуучунун мүмкүн болуучу тобокелдиктери;
- ачык API чөйрөсүндө катышуучу тарапта техникалык көйгөйлөр келип чыккан учурда колдонуучунун укуктары жана иш алып баруу тартиби;
- колдонуучу тарабынан кайрылууларды (даттанууларды) жөнөтүү ыкмалары жана даректери;
- колдонуучулардын укуктарын коргоо ыкмалары;
- колдонуучунун талабы боюнча ачык API чөйрөсүндөгү катышуучу тарабынан кызматтарды (сервис) көрсөтүүгө тиешелүү документтерди (анын ичинде электрондук документ түрүндө) берүүнүн тартиби жана мөөнөтү;
- колдонуучуга келишимдин жана (же) ачык API чөйрөсүнүн катышуучусу тарабынан кызмат (сервис) көрсөтүүнү тастыктоочу башка документтин көчүрмөсүн жазуу жүзүндө (анын ичинде электрондук документ түрүндө) берүү тартиби;
- ачык API чөйрөсүндөгү катышуучу тарабынан кызмат (сервис) көрсөтүүгө байланыштуу маалыматты колдонуучуга жөнөтүү ыкмалары;
- ачык API чөйрөсүнүн катышуучуларынын, ошондой эле колдонуучуга кызмат көрсөтүүнүн алкагында милдеттерди аткарбагандыгы же талаптагыдай аткарбагандыгы үчүн кызматтарды көрсөтүү үчүн ачык API чөйрөсүнүн катышуучулары тарабынан тартылган үчүнчү жактардын ортосунда жоопкерчиликти бөлүштүрүү жөнүндө маалымат;
- чектөөлөр (бар болсо), ачык API чөйрөсүндөгү катышуучунун кызмат (сервис) көрсөтүүнү пайдалануунун шарттарын жана ыкмаларын, шарттарды өзгөртүү жана колдонуучу тарабынан кызмат (сервис) көрсөтүүдөн баш тартуу;
- колдонуучу тарткан чыгымдардын ордун толтуруу тартиби;
- техникалык бузулуулар келип чыккан учурда кызмат (сервис) көрсөтүү режимин калыбына келтирүүнүн болжолдуу мөөнөттөрү жөнүндө маалымат;
- ачык API чөйрөсүнүн катышуучусу тарабынан ачык API чөйрөсүнүн башка катышуучуларына коюлуучу талаптар, алар менен өз ара иш алып барууда колдонуучуга кызмат (сервис) көрсөтүлөт.
8. Ачык API чөйрөсүнүн катышуучусу маалыматты колдонуучуга ачып көрсөтүү тартиби төмөнкү критерийлерге жооп беришин камсыздайт:
- колдонуучуга бирдей укукта жана бирдей көлөмдө маалымат алуу мүмкүнчүлүгүн камсыз кылуу;
- кызматтын (сервис) өзгөчөлүгүн ар кандай чечмелөөгө алып келиши мүмкүн болгон маалыматтарды ачыкка чыгарууну алып салуу;
- маалыматтын мамлекеттик же расмий тилде жеткиликтүү түрдө берилишин камсыз кылуу (окууга мүмкүн болгон шрифттерди, берүү форматтарын колдонуу менен);
- колдонуучунун келишимде белгиленген тартипте жана шарттарда, бирок операция/кызмат көрсөтүү күнүнөн тартып бир күндөн кечиктирбестен операция/кызмат көрсөтүү жөнүндө билдирүүнү алуу мүмкүнчүлүгүн камсыз кылуу;
- колдонуучунун талабы боюнча кызмат (сервис) көрсөтүүгө тиешелүү документтерди (анын ичинде электрондук документ түрүндө) алуу мүмкүнчүлүгүн камсыз кылуу;
- келишимдин жана (же) кызмат (сервис) көрсөтүүнү тастыктоочу башка документтин көчүрмөсүн пайдалануучу тарабынан алуу мүмкүнчүлүгүн камсыз кылуу.
9. Ачык API чөйрөсүнүн катышуучусу төмөнкүлөрдү камсыз кылат:
- эгерде кызматты (сервисти) алуучу жеке адам болсо, колдонуучунун жеке маалыматтарынын купуялуулугун жана корголушун;
- колдонуучунун акча каражаттары жана электрондук акча каражаттары менен уруксатсыз операцияларды жүргүзүү жагында колдонуучунун мүлктүк кызыкчылыктарын коргоону;
- ачык API чөйрөсүнүн катышуучуларынын, ошондой эле башка үчүнчү жактардын ортосунда кызмат (сервис) көрсөтүүнүн алкагында милдеттенмелерди аткарбагандыгы же талаптагыдай аткарбагандыгы үчүн жоопкерчиликти бөлүштүрүү жөнүндө колдонуучуга билдирүүнү;
- ачык API аркылуу операцияларды ишке ашырууда (кызмат көрсөтүүдө) максаттуу зарыл жана жетиштүү маалыматты гана колдонууну;
- колдонуучу уруксат бербеген операцияларды алып салууну;
- колдонуучудан аны иштетүүгө ачык макулдук алынбаган маалыматты сунуш түзүү максатында колдонуучуга пайдаланууну алып салууну;
- башка кызматты (сервисти) көрсөтүүгө жараша бир кызматты (сервисти) көрсөтүүнү шарттоо мүмкүнчүлүгүн алып салууну;
- кызмат (сервис) көрсөтүү максатында ачык API чөйрөсүнүн катышуучуларына колдонуучу тарабынан берилген маалыматтарды контролдоону жоготуу мүмкүнчүлүгүн алып салууну;
- колдонуучунун кызмат үчүн колдонуучуга жеткиликтүү формада төлөө мүмкүнчүлүгүн;
- колдонуучуга (мыйзамдардын жана Улуттук банктын ченемдик укуктук актыларынын талаптарын сактоо менен) кызмат көрсөтүүлөрдү (сервис) көрсөтүүнүн атайылап ыңгайсыз шарттарын таңуулоону болтурбоо.
4. Процесстин ролдору жана катышуучулары
10. Ачык API чөйрөсү төмөнкү катышуучуларды жана алардын ролдорун аныктайт:
Колдонуучу - акча каражаттарын жана маалыматтарды төлөөчү же алуучу болуп саналган жеке адам же юридикалык жак.
Эсептер жөнүндө маалыматты берүү боюнча кызмат көрсөтүүлөрдү сунуштоочу (AISP) – маалымат кызмат көрсөтүү максатында колдонуучунун банк эсебине жетүү үчүн ачык API колдонгон юридикалык жак.
Төлөмдөрдү демилгелөө боюнча кызмат көрсөтүүлөрүн сунуштоочу (PISP) – колдонуучуга акча каражаттарын (төлөмдөрдү) которуу максатында колдонуучунун банк эсебине жетүү үчүн ачык API колдонгон юридикалык жак.
Эсептерди тейлөө боюнча төлөм кызмат көрсөтүүлөрүн сунуштоочу (ASPSP) –колдонуучунун эсебин тейлеген жана ачык API жарыялаган коммерциялык банк.
11. Ачык API төмөнкү катышуучулардын ортосундагы гана өз ара иш алып барууну жөнгө салат:
ASPSP башка сунуштоочу (TPP) үчүн ачык API менен камсыз кылат. Ачык API аркылуу суроо-талап билдирүүлөрүн кабыл алат жана тиешелүү TPP жооп билдирүүлөрүн жөнөтөт.
TPP колдонуучунун макулдугу менен ачык API аркылуу ASPSP тарабынан башкарылган колдонуучунун эсебине жете алат. TPP суроо-талап билдирүүлөрүн ASPSPтин ачык API аркылуу жөнөтөт жана ошол ASPSPден тиешелүү жооп билдирүүлөрүн алат.
5. Өз ара иш алып барууну түзүү принциптери
12. Төмөнкү сүрөттө түзүлүп жаткан чөйрөдө ачык API интерфейсинин жайгашкан орду көрсөтүлгөн:
13. Ачык API чөйрөсүндөгү катышуучулардын ортосунда төмөнкү өз ара аракеттенүүлөр орун алышы мүмкүн:
1. Колдонуучу өзүнүн TPP маалыматтарын пайдаланууга узак мөөнөттүү макулдугун берет.
2. Колдонуучу TPP акча каражаттарын которууну баштоо үчүн ASPSP сунуштоочуга кыска мөөнөттүү макулдук берет.
3. Колдонуучунун макулдугу менен TPP жана ASPSP ортосунда маалымат алмашуу.
6. Колдонуучунун макулдук берүүсү
14. Узак мөөнөттүү макулдук колдонуучу тарабынан анын түздөн-түз катышуусуз, TPP менен ASPSP ортосунда узак мөөнөткө маалымат алмашууга ASPSP тарапта берилет. Мындай макулдук берилгенден кийин, өз ара иш алып баруу төмөнкүдөй ишке ашат: Колдонуучу - TPP - ASPSP.
Колдонуучу каалаган убакта ачык API аркылуу жана ASPSP тарабынан берилген каражаттар аркылуу узак мөөнөттүү макулдукту жокко чыгара алат.
Банк эсебинин маалыматын алууга узак мөөнөттүү макулдук төмөнкүчө схемалык түрдө көрсөтүлүшү мүмкүн:
15. Кыска мөөнөттүү макулдук колдонуучу тарабынан зарыл болгон учурда анын банктык эсебинен акча каражаттарын которууга берилет. Кыска мөөнөттүү макулдук ТРР акча каражаттарын которуу башталгандыгын тастыктоо болуп саналат.
Төлөм кызмат көрсөтүүсүн баштоого кыска мөөнөттүү макулдук төмөнкүдөй схемалык түрдө көрсөтүлүшү мүмкүн:
16. TPP жана ASPSP ортосунда маалымат алмашуу колдонуучу ASPSP сунуштоочуга кыска мөөнөттүү же узак мөөнөттүү макулдук бергенден кийин ишке ашат. Төмөнкү сүрөттө ачык API аркылуу TPP жана ASPSP өз ара иш алып баруусу көрсөтүлгөн:
ASPSP ошондой эле TPP ролдорунун биринде (AISP жана/же PISP) иштей алат жана башка ASPSP сунуштоочунун ачык API интерфейсине кире алат.
7. Маалыматтарды берүү процессинин катышуучуларынын өз ара иш алып баруусу
17. Ачык API төмөнкү маалымат алмашуу сценарийлерин колдойт:
- эсеп жөнүндө маалымат алууга узак мөөнөттүү макулдук алуу;
- пайдалануу мүмкүнчүлүгү берилген эсептердин тизмесин алуу;
- пайдалануу мүмкүнчүлүгү берилген эсеп жөнүндө толук маалымат алуу;
- пайдалануу мүмкүнчүлүгү берилген эсептин балансын алуу;
- пайдалануу мүмкүнчүлүгү берилген эсеп боюнча транзакциялардын тизмесин алуу.
7.1. Эсеп жөнүндө маалымат алууга узак мөөнөттүү макулдук алуу
TPP AISP ролу үчүн жеткиликтүү болгон башка колдонуу сценарийлерине ылайык маалыматтарды алуу үчүн бул колдонуу сценарийин аткарат. Эгерде TPP ачык API аркылуу туура идентификациялоо мүмкүн болбосо, анда ASPSP өтүнүчтү четке кагат.
Эгерде TPPде AISP ролу жок болсо, анда PISP суроо-талапты четке кагат. Колдонуучунун макулдугу менен AISP төмөнкү сценарийлерге кире алат:
- эсептердин тизмесин алуу;
- эсеп жөнүндө толук маалымат алуу;
- эсептин балансын алуу;
- эсеп боюнча транзакциялардын тизмесин алуу.
7.2. Пайдалануу мүмкүнчүлүгү берилген эсептердин тизмесин алуу
Бул колдонуу сценарийинде TPP колдонуучунун мурда берилген узак мөөнөттүү макулдугу менен колдонуучунун эсептеринин тизмесин алат. Эгерде TPP ачык API аркылуу туура идентификациялоо мүмкүн болбосо, анда ASPSP суроо-талапты четке кагат. Эгерде TPPде AISP ролу жок болсо, анда ASPSP суроо-талапты четке кагат. Төмөнкү схемада эсептердин тизмесин алуу үчүн жогорку деңгээлдеги маалымат агымдары көрсөтүлгөн:
7.3. Пайдалануу мүмкүнчүлүгү берилген эсеп жөнүндө толук маалымат алуу
Бул колдонуу сценарийинде TPP колдонуучунун мурда берилген узак мөөнөттүү макулдугу менен колдонуучунун эсептери жөнүндө кошумча маалыматтарын алат. Эгерде TPP ачык API аркылуу туура идентификациялоо мүмкүн болбосо, анда ASPSP суроо-талапты четке кагат. Эгерде TPPде AISP ролу жок болсо, анда ASPSP суроо-талапты четке кагат.
Төмөнкү схемада эсептер жөнүндө толук маалыматты алуу үчүн жогорку деңгээлдеги маалымат агымдары көрсөтүлгөн:
7.4. Пайдалануу мүмкүнчүлүгү берилген эсептин балансын алуу
Бул колдонуу сценарийинде TPP колдонуучунун мурда берилген узак мөөнөттүү макулдугу менен колдонуучунун эсептеринин балансын алат. Эгерде TPP ачык API аркылуу туура идентификациялоо мүмкүн болбосо, анда ASPSP суроо-талапты четке кагат.
Эгерде TPPде AISP ролу жок болсо, анда ASPSP суроо-талапты четке кагат. Төмөнкү схемада эсептердин балансын алуу үчүн жогорку деңгээлдеги маалымат агымдары көрсөтүлгөн:
7.5. Эсеп боюнча транзакциялардын тизмесин алуу
Бул колдонуу сценарийинде TPP колдонуучунун мурда берилген узак мөөнөттүү макулдугу менен колдонуучунун эсептери боюнча транзакцияларды алат. Эгерде TPP ачык API аркылуу туура идентификациялоо мүмкүн болбосо, анда ASPSP суроо-талапты четке кагат.
Эгерде TPPде AISP ролу жок болсо, анда ASPSP суроо-талапты четке кагат. Төмөнкү схемада эсептер боюнча транзакциялардын тизмесин алуу үчүн жогорку деңгээлдеги маалымат агымдары көрсөтүлгөн:
8. API кирүү ыкмалары
Төмөнкү таблицаларда API акыркы чекиттери тарабынан колдоого алынган HTTP кирүү ыкмалары жана бул API аркылуу түзүлгөн ресурстар тууралуу маалымат келтирилген.
Мисалы
Эсептердин акыркы чекиттери
Акыркы чекиттер/ресурс |
Метод |
Шарттар |
Баяндалышы |
accounts |
GET |
Милдеттүү түрдө |
Колдонуучу акыркы чекиттер/ макулдук аркылуу берилген эсептердин бардык идентификаторлорун окуңуз. Мындан тышкары, эсептер жөнүндө тиешелүү маалымат жана буга чейин тиешелүү макулдук берилген болсо, эсептердин тиешелүү маалымат ресурстарына гипершилтемелер берилет. Эскертүү: Стандарт AISP сунуштоочуга колдонуучунун бардык учурдагы эсептеринин тизмесине кирүү мүмкүнчүлүгүн камсыздай тургандыгын эске алыңыз. Бул учурда, бул акыркы чекит мүмкүн болушунча тез арада колдонуучунун бардык даректүү эсептеринин тизмесин берет. |
accounts?withBalance |
GET |
Милдеттүү эмес |
Берилген макулдукка жараша баланс жөнүндө маалымат менен бирге тиешелүү макулдукта так көрсөтүлбөгөн банк эсебинин идентификаторлорун окуу |
accounts/{account-id} |
GET |
Милдеттүү түрдө |
Көрсөтүлгөн эсеп жөнүндө толук маалымат көрсөтүңүз |
ccounts/{account-id}?withBalance |
GET |
Милдеттүү эмес |
Баланс жөнүндө маалымат менен бирге көрсөтүлгөн эсеп жөнүндө толук маалымат көрсөтүңүз |
accounts/{account-id}/balance |
GET |
Милдеттүү түрдө |
Көрсөтүлгөн эсептин балансы жөнүндө толук маалымат көрсөтүңүз |
accounts/{account-id}/transaction |
GET |
Милдеттүү түрдө |
Берилген эсеп боюнча транзакциялардын тизмесин көрүү. Берилген эсеп үчүн кошумча параметрлер, мисалы, «dateFrom» жана «dateTo» атрибуттары болуп саналат. ASPSP баланссыз транзакциялардын тизмелери колдоого алынбаса баланс жөнүндө маалыматты кошо алат. |
accounts/{account-id}/transactions?withBalance |
GET |
Милдеттүү эмес |
Калдыктар менен бирге «bookingStatus» башкаруу параметрине жараша көрсөтүлгөн эсеп боюнча транзакциялардын тизмелерин көрүңүз. |
accounts/{account-id}/transactions/{transaction Id} |
GET |
Милдеттүү эмес |
Көрсөтүлгөн транзакция жөнүндө маалымат окуңуз. |
Эскертүү: API интерфейсине кирүү ыкмалары үчүн адегенде техникалык макулдук механизмдери талап кылынат.
Эскертүү: {Аccount-id} параметрлери ресурстардын идентификаторлору болуп саналат, демек, AISP маркировкаланышы мүмкүн, мында bankc сыяктуу эсептик жазууларынын номерлери маалыматтарды коргоо боюнча API жолун аныктоонун бөлүгү болуп саналбайт. Бул токенизация AISP тарабынан башкарылат. Бул спецификацияда ресурстарды идентификациялоо үчүн UUID колдонууну сунуштайт.
Банктык төлөм картасынын акыркы чекиттери
Бул акыркы чекиттер колдонуучу тарабынан карта боюнча транзакцияларды макулдашуу үчүн колдонулган банктык төлөм карталарына байланыштуу эсептер жөнүндө маалымат берет.
Эскертүү: Банктык төлөм карталарын пайдалануу ыкмалары кадимки банк эсептерине салыштырмалуу чектелген функцияга байланыштуу эсептерге кирүү ыкмаларына караганда толук көрсөтүлбөгөн.
Акыркы чекиттер/ресурс |
Ыкма |
Шарттар |
Баяндалышы |
card-accounts |
GET |
Милдеттүү эмес |
Колдонуучу акыркы чекиттер/ макулдук аркылуу берилген эсептердин бардык идентификаторлорун окуңуз. Мындан тышкары, эсептер жөнүндө тиешелүү маалымат жана буга чейин тиешелүү макулдук берилген болсо, эсептердин тиешелүү маалымат ресурстарына гипершилтемелер берилет. |
card-accounts/{account-id} |
GET |
Милдеттүү эмес |
Көрсөтүлгөн картанын эсеби жөнүндө толук маалымат. |
card-accounts/{account-id}/balances |
GET |
Милдеттүү эмес |
Даректелген карта эсеби боюнча баланс жөнүндө толук маалымат көрсөтүңүз |
card-accounts/{account-id}/transactions |
GET |
Милдеттүү түрдө |
Көрсөтүлгөн карта эсебине байланыштуу транзакциялардын тизмесин көрүү. Берилген эсеп үчүн кошумча параметрлер, мисалы, «dateFrom» жана «dateTo» атрибуттары болуп саналат. |
Эскертүү: API интерфейсине кирүү ыкмалары үчүн адегенде техникалык макулдук механизмдери талап кылынат.
Эскертүү: {Аccount-id} параметрлери ресурстардын идентификаторлору болуп саналат, демек, AISP маркировкаланышы мүмкүн, мында bankc сыяктуу эсептик жазууларынын номерлери маалыматтарды коргоо боюнча API жолун аныктоонун бөлүгү болуп саналбайт. Бул токенизация AISP тарабынан башкарылат. Бул спецификацияда ресурстарды идентификациялоо үчүн UUID колдонууну сунуштайт.
Макулдук алуу процессинин алкагында AISP үчүн статус жөнүндө маалымат
Жогоруда айтылгандай, ASPSP банк эсептерине байланыштуу маалыматты пайдаланууга техникалык макулдук токени талап кылынат.
9. HTTP жооп коддору
HTTP жооп коду суроо-талап билдирүүсүнүн ийгиликтүү же ийгиликсиздигин көрсөтөт. HTTP 4XX жооп коддору учурдагы суроо-талапты аткаруу мүмкүн болбогондо гана көрсөтүлүшү керек, мисалы, төлөмдү баштоо же эсеп транзакцияларын алуу мүмкүн болбосо. Учурдагы төлөмдүн же макулдуктун статусун алуу суроо-талабы, адатта, 200 HTTP жооп кодун кайтарат, анткени төлөм же макулдук статусу ишке ашпай калган же белгиленгендигине карабастан, статусту алуу суроо-талабы ийгиликтүү болгон.
Бул спецификация төмөнкү HTTP жооп коддорун колдойт:
Коддун статусу |
Баяндалышы |
200 OK |
PUT, GET жооп коддору Эгерде суроо-талап тайм-ауттан улам кайталанса, бул кайтаруу кодуна уруксат берилет. Бул учурда жооп ASPSP ишке ашырылышына жараша 200 же 201 коду болушу мүмкүн. Каражатты суроо үчүн POST да 200 кайтарып берет, анткени ал жаңы ресурсту түзбөйт. Төлөм ресурсу ийгиликтүү жокко чыгарылганда жана андан ары жокко чыгарууга уруксат талап кылынбаганда жооп коду DELETE. |
201 Created |
Төлөмдү баштоо же макулдук суроо-талабы туура толтурулган POST жооп коду. |
202 Accepted |
Төлөм ресурсун бүтүндөй жокко чыгарууга болот, бирок жокко чыгаруу үчүн кошумча уруксат талап кылынган жооп коду DELETE. |
204 No Content |
Макулдук ресурсу ийгиликтүү өчүрүлсө жооп коду DELETE. Код суроо-талап аткарылганын, бирок контент кайтарылбаганын көрсөтөт. |
400 Bad Request |
Текшерүүдө ката кетти. Бул код суроо-талаптагы туура эмес синтаксисти же пайдалуу жүктөгү туура эмес маалыматтарды камтыйт. |
401 Unauthorized |
Белгиленген катышуучулар же колдонуучу суроо-талапты аткарууга укугу жок. Суроо-талапты туура аутентификация маалыматы менен кайталап көрүңүз. |
403 Forbidden |
Жолдо шилтеме келтирилген ресурс бар болсо, бирок ага катышуучулар же колдонуучулар кире албаса кайтарылат. Бул код идентификаторлорго активдүү эмес шилтемелер үчүн гана колдонулушу керек, анткени ал ресурстун бар экенин, ага кирүү мүмкүн эмес болсо да көрсөтөт. |
404 Not found |
Жол менен шилтемеленген ресурс же акыркы чекит жок болсо же ага катышуучулар же колдонуучу шилтеме келтире албаса кайтарылат. Жолдогу белгилүү бир идентификатор купуялуубу же жокпу деп күмөн санасаңыз, HTTP 403 жооп кодунун ордуна HTTP 404 жооп кодун колдонуңуз. |
405 Method Not Allowed |
Бул код HTTP ыкмасы (PUT, POST, DELETE, GET ж.б.) белгилүү бир акыркы чекитте колдоого алынбаса гана жөнөтүлөт. Анын макулдук, төлөм же эсептик жазуу жөнүндө маалыматтын моделине эч кандай тиешеси жок. Юридикалык же башка операциялык себептерден улам төлөм демилгесин жокко чыгаруу мүмкүн болбогондо, төлөмдү баштоо жокко чыгарылган учурда жооп коду DELETE. |
406 Not Acceptable |
ASPSP Accept аталышында катышуучулар көрсөткөн мазмунду түзө албайт. |
408 Request Timeout |
Сервер дагы эле туура иштеп жатат, бирок өзүнчө суроо-талаптын убактысы бүттү. |
409 Conflict |
Максаттуу ресурстун учурдагы абалына карама-каршы келгендиктен, суроо-талап аткарылышы мүмкүн эмес. |
415 Unsupported Media Type |
Башка катышуучу ASPSP тарабынан колдоого алынбаган каражаттын түрүн берди. |
429 Too Many Requests |
Башка катышуучу макулдук берилген же RTS тарабынан уруксат берилген суроо-талаптардын санынан ашып кетти. |
500 Internal Server Error |
Серверде ички ката орун алды. |
503 Service Unavailable |
ASPSP сервери учурда жеткиликсиз. Эреже катары, бул убактылуу шарт болуп саналат. |
10. Эсеп боюнча маалымат кызматы
Суб-кызматты колдоо
Бул спецификацияда эсеп боюнча маалымат кызматтарынын ар кандай түрлөрү камтылат:
• Бул эсептеги баланстар,
• Даректүү эсептердин тизмеси,
• Бул аккаунттун эсептеринин же берилген макулдукка байланыштуу бардык жеткиликтүү эсептердин тизмеси боюнча маалыматтар, жана
• Эсептер боюнча маалыматта ага карата макулдук алуу процессине коюлган өзгөчө талаптар колдонулушу ыктымал болгон эсеп ээсинин аты-жөнү камтылышы мүмкүн, төмөнкүнү караңыз.
Төмөндө даректүү жана жеткиликтүү эсептердин тизмеси аныкталат:
Аныктама: ASPSP сунуштоочусунда колдонуучуга байланышкан даректүү каттоо эсептеринин тизмеси, бул, колдонуучунун API аркылуу жеткиликтүү болгон эсептеринин тизмеси.
Аныктама: Колдонуучунун макулдугуна байланышкан ASPSP сунуштоочусунда жеткиликтүү эсептердин тизмеси, бул, колдонуучу эсеп жөнүндө маалыматтын белгиленген түрлөрүнүн жок дегенде бирине макулдук берген эсептердин тизмеси.
Эскертүү: Даректүү эсептердин тизмеси үчүн жана бул эсеп боюнча маалыматтарды окуу үчүн суроо-талап синтаксистик жактан окшош. Айырмачылыгы негизги макулдук ресурсунда гана, ага "Consent-ID" HTTP аталышын параметри аркылуу шилтеме келтирүүгө болот.
Мисал: ASPSP колдонуучу үчүн Bankc1 жана Bankc2 камсыз кылат. Колдонуучу TPPге Bankc 1де гана транзакцияларга жана каражаттардын калдыгына кирүүгө макулдук берди. Бул учурда даректүү эсептер Bankc1 жана Bankc2 болуп саналат, жеткиликтүү эсептердин тизмеси Bankc1ден гана турат.
Макулдук алуу жана эсеп боюнча маалыматтарды окуу
Бул спецификациянын алкагында эсеп боюнча маалымат кызматы эки этапка бөлүнөт:
1-этап: эсептер жөнүндө маалыматты колдонууга макулдук берүү.
Колдонуучулардын эсептери боюнча маалымат кызматын көрсөтүүнүн ушул этабынын алкагында AISP төмөнкүлөргө макулдук берет:
- эсеп боюнча маалымат кызматына жеткиликтүү эсептер,
- эсеп боюнча маалымат кызматынын түрү, аны пайдалануу мүмкүнчүлүгү камсыз кылынат;
- эсеп боюнча маалымат кызматын сунуштоонун мезгилдүүлүгү, б.а. бир жолку же кайталануучу кирүү мүмкүнчүлүгү, жана
- акыркы учурда - макулдуктун жарактуулук мөөнөтү күндөр же колдонуучу тарабынан сунушталган максималдуу мөөнөт. AISP жана зарыл болсо, кайталанган суроо-талаптардын жыштыгы.
Андан ары колдонуучу SCA аркылуу бул макулдукту ASPSP үчүн авторизациялайт.
Бул процесстин натыйжасы болуп контенттин ресурсу саналат. Бул процесстин алкагында AISP бул ресурска шилтемени кайтарат. TPP бул ресурс үчүн GET ыкмасын жөнөтүү аркылуу контенттин объектисин ала алат. Бул объект пайдалануу укуктары, учурдагы жарактуулук мөөнөтү жана Content-ID токен жөнүндө маалыматтарды камтыйт.
2-этап: эсеп боюнча маалыматтарды окуу
Бул учурда, AISP колдонуучунун макулдугунда аныкталгандай, бул эсептерге кирүү мүмкүнчүлүгүн алат. Эсеп боюнча маалыматтарды окууга суроо-талап ошол ресурска жогорудагы шилтемени колдонуу менен макулдук алуу үчүн тийиштүү ресурска жөнөтүлөт.
Эсептер боюнча маалыматтарды окууга суроо-талапта төмөнкүлөр көрсөтүлөт:
- кирүү мүмкүнчүлүгүн алуу зарыл болгон эсеп боюнча маалыматтын түрү,
- колдонуучу кирип жаткан эсептин идентификатору, эгер мүмкүн болсо,
- колдонуучу түздөн-түз реалдуу убакытта суроо-талапты демилгелегенби,
- эгерде бар болсо, баланстарды кошумча көрсөтүү зарылбы;
- транзакциялардын тизмеси болгон учурда эсеп жөнүндө маалымат катары төмөнкүлөрдү кошумча киргизиңиз:
• даректелген эсептин идентификатору жана
• транзакциялар тизмесинин колдонуу мөөнөтү
• кошумча, ыктыярдуу түрдө, кошумча маалыматтар менен акыркы суроо-талапка салыштырмалуу дельта-отчетту суроо-талапты көрсөтүүчү дельта желеги.
• транзакциялардын тизмелери үчүн тандалган форматтар.
Эсепке кирүү үчүн банк эсептери жана банктык төлөм карталары акыркы чекиттерге бөлүнөт, анткени маалыматтар адатта ASPSP серверинде бөлүнөт.
Бир жолку макулдук алган учурда, эгерде AISP маалыматтарды бир нече жолу сураса же макулдук мөөнөтү бүтсө, мисалы, TPP ишке ашырууга жараша, макулдук алуу механизми аяктагандан 20 мүнөттөн кийин кирүү мүмкүндүгүн берүүдөн баш тартылышы мүмкүн.
Кийинчерээк, эгерде эсеп боюнча маалымат кызматынын түрү макулдашылган кызматка дал келбесе, же иш жүзүндө жеткиликтүүлүк макулдашылган узактыкка же жыштыкка дал келбесе, маалыматтарды окуу мүмкүнчүлүгүн берүүдөн баш тартылат.
Эгерде колдонуучу эсептердин тизмесине кирүүгө макулдук берсе, TPP ар бир кирген эсепке жана кирүүгө макулдук берген ар бир колдонуучуга кирүү жыштыгын текшерет.
10.1 Эсеп боюнча маалыматтардын агымын окуу
Эсеп боюнча маалыматты окуу үчүн, адегенде API-интерфейстеринде тиешелүү макулдукту алуу үчүн агым талап кылынат. Бул учурда, окула турган иш жүзүндөгү эсеп боюнча маалыматтардын агымы макулдукту башкаруунун тиешелүү агымынан көз каранды эмес. Бул жөнөкөй суроо/жооп процесси, ал төмөнкүдөй болот:
10.2 Эсеп боюнча маалыматты карап чыгуу
Төмөнкү таблицада AISP үчүн эсептер жөнүндө маалыматтардын абстракттуу моделинин техникалык сүрөттөлүшү берилген. Төмөнкү тилкелерде API протоколдорунун баяндамасы көрсөтүлгөн:
- «Маалымат элементи» тилкесинде ошол документтеги эрежелерге жана ролдун аныктамаларына байланышты камсыз кылуу үчүн маалыматтардын абстракттуу элементтери колдонулат.
- «Атрибуттардын кодун белгилөө» тилкесинде бул документте аныкталгандай, API интерфейсинде кодду белгилөөнүн айкын аныктамасын берет.
- «Жайгашкан жери» тилкелеринде маалыматтын тиешелүү элементтери HTTP параметрлери катары кайсы жерде өткөрүлөрү аныкталат, алар eIDAS сертификаттарынан алынган. HTTP параметрлери үчүн «жолдо» API хосту, порту жана негизги жолу камтылат.
- «Колдонуу» тилкесинде API интерфейсинин ар башка суроо-талаптарында маалымат элементтеринин колдонулушу тууралуу маалымат берилет. Бул суроо-талаптар POST, PUT, DELETE жана GET HTTP буйруктары катары техникалык жактан ишке ашырылат төмөнкү түрдө:
- Маалыматтарды окууга суроо-талап - бул ар кандай параметрлери бар ар башка акыркы чекиттерге багытталган эсеп боюнча маалыматты алууга суроо-талап.
Эскертүү: Эсептер боюнча маалымат алуу үчүн, адегенде колдонуучудан SCA тарабынан тастыкталган, эсептерге кирүү үчүн техникалык макулдук талап кылынат.
«Жайгашкан жери» жана «Колдонуу» тилкелеринде төмөнкү кыскартуулар аныкталган.
• x: Бул маалымат элементи тиешелүү деңгээлде өткөрүлөт.
• м: Милдеттүү
• o: TPP колдонуу үчүн милдеттүү эмес
• в: Шарттуу. Шарт API суроо-талаптарында көрсөтүлөт, шарт TPP тарабынан аныкталган.
Төмөнкү таблицада суроо-талап билдирүүлөрүнө гана эмес, жооп билдирүүлөрүнүн маалымат элементтерине да талаптар аныкталат. Бул талаптар оң жоопторго гана тиешелүү (мисалы, HTTP 2xx жооп кодуна). Ката пайда болсо, ката жөнүндө жалпы маалымат HTTP 40x жооп коду менен бирге берилет.
Эскертүү: GET .../{consentId} жана GET .../{ avtorizationId } сыяктуу башка техникалык функциялар, ошондой эле жокко чыгаруу суроо-талабы бул маалыматта көрсөтүлгөн эмес.
Маалымат элементтери |
Атрибуттардын кодун белгилөө |
Жайгашкан жери |
Колдонуу |
|||||||||||||||
Жол |
Суроо-талап параметрлери |
Аталышы |
Маалымат |
Сертификат |
Суроо-талаптын маалыматын окуу |
Жооп маалыматты окуу |
||||||||||||
ТPP идентификациясы |
x |
m |
||||||||||||||||
Каттоо номери |
x |
m |
||||||||||||||||
Аталышы |
x |
m |
||||||||||||||||
ТРР ролу |
x |
m |
||||||||||||||||
Улуттук банк |
x |
m |
||||||||||||||||
Суроо-талап идентификациясы |
X-Request-ID |
x |
m |
m |
||||||||||||||
Макулдуктун ID |
Consent-ID |
x |
m |
|||||||||||||||
Токенге кирүү (OAuth2 нин опционунан) |
Authorization |
x |
c |
|||||||||||||||
API кардарынын электрондук колун кою |
x-jws-signature |
x |
c |
|||||||||||||||
Кошумча электрондук колдун маалыматы |
Digest |
x |
c |
|||||||||||||||
Колдонуучунун билдирүү маалыматы |
psuMessage |
x |
o |
|||||||||||||||
API кардарынын билдирүү маалыматы |
apiClientMessages |
x |
o |
|||||||||||||||
Колдонуучунун IP адреси |
PSU-IP-Address |
x |
c |
|||||||||||||||
Колдонуучунун IP Порту |
PSU-IP-Port |
x |
o |
|||||||||||||||
Колдонуучунун маалыматы |
PSU-Accept |
|
|
x |
|
|
o |
|
||||||||||
|
PSU-Accept- Charset |
|
|
x |
|
|
o |
|
||||||||||
|
PSU-Accept- Encoding |
|
|
x |
|
|
o |
|
||||||||||
|
PSU-Accept- Language |
|
|
x |
|
|
o |
|
||||||||||
|
PSU-Http-Method |
|
|
x |
|
|
o |
|
||||||||||
|
PSU-Device-ID |
|
|
x |
|
|
o |
|
||||||||||
Колдонуучунун агентти |
PSU-User-Agent |
|
|
x |
|
|
o |
|
||||||||||
GEO маалыматы |
PSU-Geo-Location |
|
|
x |
|
|
o |
|
||||||||||
Колдонуучунун эсебинин ID |
accountId |
x |
|
|
|
|
c |
|
||||||||||
Колдонуучунун эсеби |
account |
|
|
|
x |
|
|
m |
||||||||||
Башталган датасы |
dateFrom |
|
x |
|
|
|
c |
|
||||||||||
Бүткөн датасы |
dateTo |
|
x |
|
|
|
c |
|
||||||||||
Транзакция |
entryReferenceFro m |
|
x |
|
|
|
o |
|
||||||||||
Брондоо статусу |
bookingStatus |
|
x |
|
|
|
o |
|
||||||||||
Дельта-интикатор |
deltaList |
|
x |
|
|
|
o |
|
||||||||||
Баланс менен желекчеси |
withBalance |
|
x |
|
|
|
o |
|
||||||||||
Колдонуучунун эсептеринин тизмеси |
Array of accountDetails |
|
|
|
x |
|
|
c |
||||||||||
Колдонуучунун эсептеринин толук маалыматы |
accountDetails |
|
|
|
x |
|
|
c |
||||||||||
Баланс |
balances |
|
|
|
x |
|
|
c |
||||||||||
Транзакция |
transactions |
|
|
|
x |
|
|
c |
||||||||||
Колдонуучунун карта эсеби |
accountDetails |
|
|
|
x |
|
|
c |
||||||||||
Картанын транзакциясы |
cardTransactions |
|
|
|
x |
|
|
c |
Колдонуучунун IP дареги/порту жана колдонуучуга байланыштуу кошумча маалымат
Жогорудагы таблицада колдонуучуга байланышкан кээ бир контексттик маалыматтар көрсөтүлөт. Эгерде колдонуу милдеттүү болбосо, алар мындан ары окуу жеңилдиги үчүн төмөнкү толук аныктамаларда келтирилбейт.
10.3. Эсеп боюнча маалымат үчүн мультивалюталык эсептин өзгөчөлүктөрү
Эсеп боюнча маалымат үчүн мультивалюталык эсептердин ыкмалары эсептердин топтому каралып жаткандыгына байланыштуу интерфейсте айырмаланат. Төмөнкү айырмачылыктар абстракттуу деңгээлде көрсөтүлөт. Субэсептер валютасын ачык кошуу менен, атайын субэсептер катары да каралышы мүмкүн. Бул учур мындан ары атайын белгиленбейт.
Эсептерди же эсеп боюнча маалыматты окуудагы мультивалюталык эсептер
ASPSP ишке ашырууда мультивалюталык эсептин маалыматтарынан агрегация жана субэсеп деңгээлинде же субэсеп деңгээлинде гана пайдалануу мүмкүнчүлүгүн берүү жөнүндө чечим кабыл алат.
Агрегация деңгээлинде баланстарды окуудагы мультивалюталык эсептер
Бул функциянын натыйжасы болуп, эгерде мультивалюталык эсеп агрегация деңгээлинде каралса, бардык субэсептердин баланстарынын массиви кайтарылып берилиши саналат. Тиешелүү субэсептин валютасы баланста элементтин валютасы balanceAmount катары кыйыр түрдө көрсөтүлөт.
Агрегация деңгээлинде транзакцияларды окуудагы мультивалюталык эсептер
Бул функциянын натыйжасы катары, эгерде мультивалюталык эсеп агрегация деңгээлинде каралса, транзакциялардын тизмеси бардык субэсептердин бардык транзакцияларын камтышы саналат. Бул учурда, отчетто камтылган төлөм операциялары ар кандай транзакция валюталарына ээ болушу мүмкүн.
10.4 Эсеп боюнча маалымат сурамдарын окуу
Төмөнкү бөлүмдөрдө учурдагы эсептерде окуу мүмкүнчүлүгү көрсөтүлөт.
1) Эсептердин тизмесин окуу
Суроо-талап
GET /v2/accounts {query-parameters}
Зарылдыгына жараша, калдыктарды көрсөтүү менен учурдагы эсептердин тизмесин окуйт. Мында колдонуучунун пайдалануу мүмкүнчүлүгүн берүүгө макулдугу жана ASPSP системасында сакталгандыгы болжолдонууда. Ошентип, даректелген эсептердин тизмеси колдонуучунун идентификаторуна жана consentId тарабынан даректелген сакталган макулдукка, тиешелүүлүгүнө жараша, OAuth2 токенине жараша болот.
Эскертүү: Эгер макулдук даректүү эсептердин тизмесин көрсөтүү үчүн гана берилсе, эсеп маалыматы азыраак көрсөтүлөт. Атап айтканда, бул учурда баланстарга же транзакциянын акыркы чекиттерине гипершилтемелер көрсөтүлбөөгө тийиш.
Эскертүү: Бул чалууда (суроо-талапта) «ccountDetails», «balances», «transactions» же «ais» ыйгарым укуктары менен кайтарылган маалымат жетишсиз болсо, кошумча маалыматты /accounts/{account-id} акыркы чекитине жетүү аркылуу алууга болот.
Суроо-талаптын параметрлери
Атрибуту |
Tиби |
Шарты |
Баяндалышы |
withBalance |
Boolean |
Милдеттүү эмес |
Эгер бар болсо, бул функция колдонуучу тарабынан тиешелүү макулдук менен берилсе жана ASPSP үчүн жеткиликтүү болсо, балансты кошо алганда, жеткиликтүү төлөм эсептеринин тизмесин окуйт. Бул параметр ASPSP тарабынан эске алынбашы мүмкүн. |
Суроо-талаптын аталышы
Атрибуту |
Tиби |
Шарты |
Баяндалышы |
X-Request-ID |
UUID |
Милдеттүү түрдө |
Суроо үчүн уникалдуу суроо-талаптын идентификатору, муну демилгелеген тарап аныктайт. |
Consent-ID |
Max70Text |
Милдеттүү түрдө |
Бул API аркылуу мурда аткарылган «Эсептик жазуу жөнүндө маалыматка макулдук берүүнүн» натыйжасында. |
PSU-IP-Address |
String |
Шарттуу түрдө |
Даректелген IP-даректин аталышынын талаасы колдонуучу менен TPP ортосундагы HTTP суроо-талабынын тиешелүү IP-дарек талаасынан турат. Ал колдонуучу тарабынан жигердүү демилгеленген учурда гана камтылууга тийиш. |
Authorization |
String |
Шарттуу түрдө |
Эгерде OAuth2 негизиндеги аутентификация алдын ала этапта аткарылса же OAuth2 негизиндеги SCA аутентификациясы тиешелүү макулдук авторизациясы менен аткарылса гана камтылат. |
Суроо-талаптын маалыматы
Суроо-талаптын маалыматы жок
Жооп коду
HTTP жооп коду 200гө барабар.
Жооптун аталышы
Атрибуту |
Tиби |
Шарты |
Баяндалышы |
X-Request-ID |
UUID |
Сөзсүз |
Суроо үчүн уникалдуу суроо-талаптын идентификатору, муну демилгелеген тарап аныктайт. |
Жооп маалыматы
Атрибуту |
Tиби |
Шарты |
Баяндалышы |
accounts |
Array of Account Details |
Милдеттүү түрдө |
Эгерде эч бир эсептик жазуу жеткиликтүү болбосо, ASPSP бош массивди кайтарат. Бул да оң жооп деп эсептелгендиктен, жооп коду мурдагыдай эле 200 болушу керек. |
2) Эсеп жөнүндө маалыматты көрүү
Суроо-талап
GET /v2/accounts/{account-id} {query-parameters}
Бул процесс учурдагы эсеп маалыматын, анын ичинде керек болсо баланстарды алууга мүмкүндүк берет. Мында, төлөм кызматын пайдалануучунун кирүү үчүн макулдугу алынгандыгы жана төлөм инфраструктурасынын кызмат көрсөтүүлөрү сунуштоочунун системасында (ASPSP) сакталгандыгы болжолдонууда. Кабыл алынган эсеп жөнүндө маалымат макулдук идентификаторуна (consentId) же тиешелүүлүгүнө жараша, OAuth2 токен мүмкүндүгүнө жараша болот.
Эскертүү: Каттоо эсебинин идентификатору маалыматтардын коопсуздугун камсыз кылуу үчүн белгилениши мүмкүн, анткени жол боюнча маалымат ASPSP инфраструктурасындагы аралык серверлерде жазылышы мүмкүн. Бул каттоо эсебинин идентификаторун «GET Account List» ыкмасынын суроо-талабы аркылуу же ага байланышкан макулдук булагынан алса болот.
Эскертүү: Эсеп идентификатору мультивалюталык эсепти көрсөтүшү мүмкүн. Бул учурда валюта коду «XXX» деп коюлат.
Жол параметрлери
Атрибуту |
Tиби |
Баяндалышы |
account-id |
Max70Text |
Бул идентификация көрсөтүлгөн эсепти түшүндүрөт. Account-id «Read Account List» суроо-талабы аркылуу алынат. Account-id эсеп түзүмүнүн «resourceId» атрибуту болуп саналат. Анын мааниси, жок эле дегенде, берилген макулдуктун бүткүл циклинде туруктуу болуп эсептелет. |
Суроо-талап параметрлери
Атрибуту |
Tиби |
Шарты |
Баяндалышы |
withBalans |
Boolean |
Милдеттүү эмес |
Эгер бар болсо, бул функция колдонуучунун макулдугу менен берилсе жана ASPSP тарабынан колдоого алынса, даректелген эсеп маалыматын, анын ичинде балансты окуйт. Бул маалымат элементи ASPSP тарабынан эске алынбай калышы мүмкүн. |
Суроо-талаптын аталышы
Атрибуту |
Tиби |
Шарты |
Баяндалышы |
X-Request-ID |
UUID |
Милдеттүү түрдө |
Суроо үчүн уникалдуу суроо-талаптын идентификатору, муну демилгелеген тарап аныктайт. |
Consent-ID |
Max70Text |
Милдеттүү түрдө |
|
PSU-IP-Address |
String |
Шарттуу түрдө |
Даректелген IP-даректин аталышынын талаасы колдонуучу менен TPP ортосундагы HTTP суроо-талабынын тиешелүү IP-дарек талаасынан турат. Ал колдонуучу тарабынан жигердүү демилгеленген учурда гана камтылууга тийиш. |
Authorization |
String |
Шарттуу түрдө |
Эгерде OAuth2 негизиндеги аутентификация алдын ала этапта аткарылса же OAuth2 негизиндеги SCA аутентификациясы тиешелүү макулдук авторизациясы менен аткарылса гана камтылат. |
Жооп маалыматы
Атрибуту |
Tиби |
Шарты |
Баяндалышы |
account |
Account Details |
Милдеттүү түрдө |
|
3) Баланс жөнүндө маалыматтарды окуу
Суроо-талап
GET /v2/accounts/{account-id}/balances
«Account-id» параметри менен аныкталган, көрсөтүлгөн эсеп боюнча баланс жөнүндө маалыматтарды окуу.
Жол параметрлери
Атрибуту |
Tиби |
Баяндалышы |
account-id |
Max70Text |
Бул идентификация көрсөтүлгөн эсепти түшүндүрөт. Account-id «Read Account List» суроо-талабы аркылуу алынат. Account-id эсеп түзүмүнүн «resourceId» атрибуту болуп саналат. Анын мааниси, жок эле дегенде, берилген макулдуктун бүткүл циклинде туруктуу болуп эсептелет. |
Суроо-талаптын параметрлери
Суроо-талаптын атайын параметрлери жок.
Жооп коду
Жооп коду
HTTP жооп коду 200гө барабар
Жооптун аталышы
Атрибуту |
Tиби |
Шарты |
Баяндалышы |
X-Request- ID |
UUID |
Милдеттүү түрдө |
Суроо үчүн уникалдуу суроо-талаптын идентификатору, муну демилгелеген тарап аныктайт. |
X-Request-ID |
UUID |
Шарттуу түрдө |
Даректелген IP-даректин аталышынын талаасы колдонуучу менен TPP ортосундагы HTTP суроо-талабынын тиешелүү IP-дарек талаасынан турат. Ал колдонуучу тарабынан жигердүү демилгеленген учурда гана камтылууга тийиш. |
PSU-IP-Address |
String |
Милдеттүү түрдө |
|
Consent-ID |
String |
Шарттуу түрдө |
Эгерде OAuth2 негизиндеги аутентификация алдын ала этапта аткарылса же OAuth2 негизиндеги SCA аутентификациясы тиешелүү макулдук авторизациясы менен аткарылса гана камтылат. |
Суроо-талаптын маалыматы
Суроо-талаптын маалыматы жок
Жооптун аталышы
Атрибуту |
Tиби |
Шарты |
Баяндалышы |
X-Request- ID |
UUID |
Милдеттүү түрдө |
Суроо үчүн уникалдуу суроо-талаптын идентификатору, муну демилгелеген тарап аныктайт. |
Жооп маалыматы
Атрибуту |
Tиби |
Шарты |
Баяндалышы |
account |
Account Reference |
Милдеттүү түрдө |
Даректелген эсептин идентификатору |
balances |
Array of Balance |
Милдеттүү түрдө |
Бул эсеп боюнча калдыктардын тизмеси, мисалы, учурдагы баланс, акыркы чегерилген калдык. |
4) Транзакциялар тизмесин окуу
Суроо-талап
GET /v2/accounts/{account-id}/transactions {query-parameters}
«Account-id» параметри менен аныкталган көрсөтүлгөн эсеп боюнча транзакция маалыматтарын сурайт. Бул өткөрүлгөн (booked) жана күтүлүп жаткан транзакциялар (pending), ошондой эле туруктуу төлөм тапшырмаларынын тизмеси жана транзакциялар жөнүндө башка кошумча маалымат болушу мүмкүн.
Эскертүү: ASPSP жооп үчүн тиркеменин деңгээлинде маалыматтардын көлөмүн кичирейтүүнүн стандарттуу ыкмаларын колдонушу мүмкүн, бул content-encoding аталышында көрсөтүлөт. camt.05x форматтары кайтарылган учурда, бир эле жоопто бир нече camt.05x файлдары камтылат. Айрым ASPSP, мисалы, camt.05x файлдарын онлайн-каналдарда колдонулгандай эле, бухгалтердик жазуулардын күндөрү боюнча бөлүшү мүмкүн.
Эскертүү: Пагинацияны колдонууда көрсөтүлгөн баракчаларга шилтемелер боюнча суроо-талап жолду пагинациянын шилтемесинде көрсөтүлгөн жолго алмаштыруу менен ушул эле суроо-талап үчүн белгиленген талаптарды сактайт.
Эскертүү: Көңүл буруңуз, жолдун бардык параметрлери _links чакан талаасында «Эсептер тизмесин окуу» (Read Account List) суроо-талабына берилген жоопто так көрсөтүлбөгөн болушу мүмкүн.
Жол параметрлери
Атрибуту |
Тиби |
Баяндалышы |
account-id |
String |
Бул идентификация көрсөтүлгөн эсепти түшүндүрөт. Account-id «Read Account List» суроо-талабы аркылуу алынат. Account-id эсеп түзүмүнүн «resourceId» атрибуту болуп саналат. Анын мааниси, жок эле дегенде, берилген макулдуктун бүткүл циклинде туруктуу болуп эсептелет. |
Суроо-талап параметрлери
Атрибуту |
Тиби |
Шарты |
Баяндалышы |
dateFrom |
ISODate |
Шарттуу түрдө |
Транзакциялар тизмесинин башталган күнү (анын ичинде dateFrom датасы), эгер дельтаны пайдалануу мүмкүнчүлүгү талап кылынбаса жана bookingStatus «information» барабар болбосо, талап кылынат. Дельта функциясы колдонулса же bookingStatus «information» барабар болсо, эске алынбай калышы мүмкүн.
Брондолгон транзакциялар үчүн тиешелүү дата брондоо күнү болуп саналат. Күтүүдөгү транзакциялар үчүн тиешелүү дата бул API же башка ASPSP каналдарында ачык-айкын болбошу мүмкүн болгон кирүү күнү болуп саналат.
Эгерде bookingStatus «all» болсо, бул дата bookingStatus «маалыматы» шилтеме кылган бардык транзакциялар үчүн эске алынбай калышы мүмкүн. |
dateTo |
ISODate |
Милдеттүү эмес |
Транзакциялар тизмесинин аяктоочу датасы (анын ичинде dateTo датасы), эгер көрсөтүлбөсө, демейки «бүгүн» болуп саналат. Дельта функциясы колдонулса, көңүл бурулбай калышы мүмкүн.
Брондолгон транзакциялар үчүн тиешелүү дата брондоо күнү болуп саналат. Күтүүдөгү транзакциялар үчүн тиешелүү дата бул API же башка ASPSP каналдарында ачык-айкын болбошу мүмкүн болгон кирүү күнү болуп саналат.
Эгерде bookingStatus «all» болсо, бул дата bookingStatus «information» шилтеме кылган бардык транзакциялар үчүн эске алынбай калышы мүмкүн. |
entryReferenceFrom |
Max35Text |
API сунуштоочусу тарабынан колдоого алынса, милдеттүү эмес |
Бул маалымат атрибуту AISP жогоруда аныкталган мөөнөткө альтернатива катары entryReference entryReferenceFrom идентификациясы менен транзакциядан кийин бардык транзакцияларды алууну көздөй тургандыгын көрсөтүп турат. Бул - дельта мүмкүнчүлүгүн ишке ашыруу.
Эгерде бул маалымат элементи камтылган болсо, «dateFrom» жана «dateTo» жазуулары ASPSP тарабынан эске алынбай калышы мүмкүн, эгерде дельта отчет колдоого алынса. |
pageSize |
Integer |
API сунуштоочусу тарабынан колдоого алынса, милдеттүү эмес |
Бул суроо-талап параметри өркүндөтүлгөн кызматтар үчүн алынышы зарыл болгон суроо-талап транзакциясынын жазууларын аныктайт.
Эгер колдоого алынбаса, суроо-талап четке кагылат.
Эгерде ASPSP тарабынан колдоого алынса жана мааниси анын документтеринде ASPSP аныктагандай maxPageSize ашса, анда суроо-талап четке кагылат. |
bookingStatus |
Max35Text |
API сунуштоочусу тарабынан колдоого алынса, милдеттүү эмес |
Уруксат берилген коддору: «booked», «pending», «both», «information» жана «all».
«Booked» ASPSP тарабынан колдоого алынышы керек. «Pending» функциясын колдоо ASPSP үчүн талап болуп саналат. ASPSP онлайн каналдары колдонуучуга күтүлүүчү транзакцияларды берсе талап кылынат. Колдоого алынбаса, катанын коду чыгат. «Both» функциясын колдоо ASPSP үчүн милдеттүү эмес, эгер колдоого алынбаса, катанын коду чыгат. Эгер колдоого алынса, «both», «pending» же «booked» деген bookingStatus транзакцияларынын тизмесин суроону билдирет. «Information» функциясын колдоо ASPSP үчүн милдеттүү эмес. Учурда «information» брондоо статусу туруктуу буйрутмаларды гана камтыйт. Колдоого алынбаса, катанын коду чыгат. «All» функциясын колдоо ASPSP үчүн милдеттүү эмес, эгер колдоого алынбаса, катанын коду чыгат. Колдоого алынса, «all» каалаган bookingStatus транзакцияларынын тизмелерин суроону билдирет («pending», «booked» же «information»). |
deltaList |
Boolean |
API сунуштоочусу тарабынан колдоого алынса, милдеттүү эмес |
Бул маалымат атрибуту AISP даректелген эсеп боюнча бул колдонуучу үчүн акыркы пайдалануу боюнча отчетунан кийин бардык транзакцияларды алууну колдой тургандыгын көрсөтөт. Бул айырмасы пайдалануу боюнча отчетту дагы бир ишке ашыруу.
Эгерде бул функция колдоого алынбаса, бул айырма көрсөткүчү ASPSP тарабынан четке кагылышы мүмкүн.
Бул маалымат элементи камтылган болсо, айырмасы бар отчет колдоого алынган учурда, «dateFrom» жана «dateTo» жазуулары ASPSP тарабынан эске алынбашы мүмкүн. |
withBalance |
Boolean |
Милдеттүү эмес |
Эгерде бар болсо, колдонуучу тарабынан тиешелүү макулдугу менен берилсе жана ASPSP үчүн жеткиликтүү болсо, бул функция транзакциялардын тизмесин, анын ичинде брондоо балансын окуйт. Бул параметр ASPSP тарабынан эске алынбашы мүмкүн. |
Эскертүү: Эгерде bookingStatus «information» маанисине ээ болсо, dateFrom, dateTo, withBalance, deltaList жана entryReferenceFrom суроо-талап параметрлери эске алынбайт жана натыйжага эч кандай таасирин тийгизбейт.
Суроо-талаптын аталышы
Атрибуту |
Тиби |
Шарты |
Баяндалышы |
X-Request-ID |
UUID |
Милдеттүү түрдө |
Суроо үчүн уникалдуу суроо-талаптын идентификатору, муну демилгелеген тарап аныктайт. |
PSU-IP-Address |
String |
Шарттуу түрдө |
Даректелген IP-даректин аталышынын талаасы колдонуучу менен TPP ортосундагы HTTP суроо-талабынын тиешелүү IP-дарек талаасынан турат. Ал колдонуучу тарабынан жигердүү демилгеленген учурда гана камтылууга тийиш. |
Consent-ID |
Max70Text |
Милдеттүү түрдө |
|
Authorization |
String |
Шарттуу түрдө |
Эгерде OAuth2 негизиндеги аутентификация алдын ала этапта аткарылса же OAuth2 негизиндеги SCA аутентификациясы тиешелүү макулдук авторизациясы менен аткарылса гана камтылат. |
Accept |
String |
Милдеттүү эмес |
TPP HTTP аталышы аныкталгандан кийин артыкчылык менен бирге колдоого алынган эсептер боюнча отчеттордун форматын көрсөтө алат. Бул спецификация тарабынан колдоого алынган форматтар: • xml • JSON • text |
Эскертүү: Колдонуучуга жеткиликтүү ар кандай эсеп боюнча отчеттордун форматтарын, мисалы корпоративдик контекстте эске алуу үчүн, camt.05x жана MT94x форматтары үчүн accept атрибутундагы vnd-entries маанисин колдонуу пландаштырылууда. Бул учурда, башка сунуштоочу, мисалы, мындай деп билдириши мүмкүн: «Мен camt.054 караштырам, бирок ал жок болсо, camt.053 алам». Бул чечим анын толук спецификациясына чейин эң мыкты тажрыйба катары сунушталат.
Суроо-талаптын маалыматы
Суроо-талаптын маалыматы жок
Жооп коду
HTTP жооп коду 200гө барабар.
Суроо-талаптын аталышы
Атрибуту |
Тиби |
Шарты |
Баяндалышы |
Content-Type |
String |
Милдеттүү түрдө |
Мүмкүн маанилери:
• application/json • application/xml • text/plain |
X-Request-ID |
UUID |
Милдеттүү түрдө |
Суроо үчүн уникалдуу суроо-талаптын идентификатору, муну демилгелеген тарап аныктайт. |
Жооп маалыматы
Эгерде ASPSP camt.05x форматындагы XML структурасын кайтарса, анда жооп маалыматы camt.052 же camt.053 форматынан турат. camt.052 форматы күтүлүүчү (аткарыла элек) төлөмдөрдү камтышы мүмкүн. Форматты тандоо тандалган параметрлердин, өзгөчө суроо-талаптын убактысына карата көрсөтүлгөн даталардын негизинде, ASPSP сунуштоочусунан көз каранды болот. Мындан тышкары, ASPSP, мисалы, корпоративдик чөйрөдө, camt.054x структурасын сунуштай алат.
Эгерде ASPSP MT94x форматындагы мазмунду кайтарса, анда жооп маалыматы текст структурасында MT940 же MT942 форматынан турат. MT942 форматы күтүлүүчү (өткөрүлбөгөн) төлөмдөрдү камтышы мүмкүн. Форматты тандоо тандалган параметрлердин, атап айтканда суроо-талаптын убактысына карата көрсөтүлгөн даталардын негизинде ASPSP сунуштоочусунан да көз каранды болот.
JSON форматындагы жооп төмөнкүчө аныкталат:
Атрибуту |
Tиби |
Шарты |
Баяндалышы |
account |
Account Reference |
Милдеттүү түрдө |
Даректелген эсептин идентификатору. |
transactions |
Account Report |
Милдеттүү эмес |
JSON негизинде эсеп боюнча отчет.
Бул эсеп отчету суроо-талап параметрлеринен келип чыккан транзакцияларды камтыйт.
Эскертүү: Бул жерде транзакциянын реквизиттеринде эле эмес, маалыматтын өткөрүп берилиши жөнүндө атрибуттарды берүү сунушталат. Бул ишке ашыруу API кардарларына транзакциянын чоо-жайын өтө көп колдонуудан сактайт. |
balances |
Array of Balance |
Милдеттүү эмес |
Учурдагы калдык менен чектелиши мүмкүн болгон бул эсеп боюнча калдыктардын тизмеси. |
_links |
Links |
Милдеттүү эмес |
TPP тааный турган гипершилтемелердин тизмеси.
Бул жоопто уруксат берилген шилтемелердин түрү:
«D-ownload»: транзакциялардын тизмеси көлөмдүү болсо, транзакциялардын тизмесин жүктөп ала турган булакка шилтеме.
Эскертүү: Бул функция суралып жаткан camt-маалыматтардын көлөмү чоң болсо гана колдонулушу керек. |
5) Транзакция боюнча маалыматты окуу үчүн суроо-талап
Суроо-талап GET /v2/accounts/{account-id}/transactions/{transactionId}
«account-id» параметри менен идентификацияланган, көрсөтүлгөн эсеп үчүн «transactionId» параметри менен идентификацияланган транзакция боюнча маалымат сурайт. Бул суроо-талап JSON форматында көрсөтүлгөн транзакциялар үчүн гана жеткиликтүү.
Эскертүү: Көңүл буруңуз, жолдун бардык параметрлери _links чакан талаасында «Эсептер тизмесин окуу» (Read Account List) суроо-талабына берилген жоопто так көрсөтүлбөгөн болушу мүмкүн.
Жол параметрлери:
Атрибуту |
Түрү |
Баяндалышы |
account-id |
String |
Бул идентификация транзакция өткөрүлгөн эсептин дарегин көрсөтөт. |
transactionId |
String |
Бул идентификация транзакциялар тизмесинин тиешелүү жазуусунун transactionId атрибуту менен аныкталат. |
Суроо-талаптын параметрлери
Суроо-талаптын параметрлери жок
Суроо-талаптын аталышы
Атрибуту |
Tиби |
Шарты |
Баяндалышы |
X-Request-ID |
UUID |
Милдеттүү түрдө |
Суроо үчүн уникалдуу суроо-талаптын идентификатору, муну демилгелеген тарап аныктайт. |
PSU-IP-Address |
String |
Шарттуу түрдө |
Даректелген IP-даректин аталышынын талаасы колдонуучу менен TPP ортосундагы HTTP суроо-талабынын тиешелүү IP-дарек талаасынан турат. Ал колдонуучу тарабынан жигердүү демилгеленген учурда гана камтылууга тийиш. |
Consent-ID |
String |
Милдеттүү түрдө |
|
Authorization |
String |
Шарттуу түрдө |
Эгерде OAuth2 негизиндеги аутентификация алдын ала этапта аткарылса же OAuth2 негизиндеги SCA аутентификациясы тиешелүү макулдук авторизациясы менен аткарылса гана камтылат. |
Суроо-талаптын маалыматы
Суроо-талаптын маалыматы жок
Жооп коду
HTTP жооп коду 200гө барабар
Жооптун аталышы
Атрибуту |
Тиби |
Шарты |
Баяндалышы |
Content-Type |
String |
Милдеттүү түрдө |
Мүмкүн болгон маанилер:
• application/json |
X-Request-ID |
UUID |
Милдеттүү түрдө |
Суроо үчүн уникалдуу суроо-талаптын идентификатору, муну демилгелеген тарап аныктайт. |
Жооп маалыматы
Атрибуту |
Tиби |
Шарты |
Баяндалышы |
transactionsDetails |
Transactions |
Милдеттүү эмес |
|
10.5. Банктык төлөм карталары жөнүндө маалыматтарды суроо
1) Карта эсептеринин тизмесин окуу үчүн суроо-талап
GET /v2/card-accounts/{account-id}/balances
Карта боюнча операцияларды баланс маалыматы сыяктуу кошумча маалымат менен макулдашуу үчүн эсептердин тизмесин сурайт. Бул колдонуучунун пайдаланууга макулдугу буга чейин ASPSP системасында берилген жана сакталган деп болжолдонууда. Эсептердин түзүлүүчү тизмеси пайдалануучунун идентификаторуна жана параметр consentId менен идентификацияланган сакталган макулдукка же пайдалануу токенине OAuth2 жараша болот.
Суроо-талаптын параметрлери
Суроо-талаптын параметрлери үчүн колдоо жок.
Суроо-талаптын аталышы
Атрибуту |
Тиби |
Шарты |
Баяндалышы |
X-Request-ID |
UUID |
Милдеттүү түрдө |
Суроо үчүн уникалдуу суроо-талаптын идентификатору, муну демилгелеген тарап аныктайт. |
PSU-IP-Address |
String |
Шарттуу түрдө |
Даректелген IP-даректин аталышынын талаасы колдонуучу менен TPP ортосундагы HTTP суроо-талабынын тиешелүү IP-дарек талаасынан турат. Ал колдонуучу тарабынан жигердүү демилгеленген учурда гана камтылууга тийиш. |
Consent-ID |
String |
Милдеттүү түрдө |
Бул API аркылуу мурда аткарылган «Эсепке алуу маалыматтарынын транзакциясына макулдукту берүү» натыйжасында. |
Authorization |
String |
Шарттуу түрдө |
Эгерде OAuth2 негизиндеги аутентификация алдын ала этапта аткарылса же OAuth2 негизиндеги SCA аутентификациясы тиешелүү макулдук авторизациясы менен аткарылса гана камтылат. |
Суроо-талаптын маалыматы
Суроо-талаптын маалыматы жок
Жооп коду
HTTP жооп коду 200гө барабар
Жооптун аталышы
Атрибуту |
Tиби |
Шарты |
Баяндалышы |
X-Request-ID |
UUID |
Милдеттүү түрдө |
Чалуу үчүн уникалдуу суроо идентификатору, баштапкы тарап аныктайт. |
Жооп маалыматы
Атрибуту |
Тиби |
Шарты |
Баяндалышы |
cardAccounts |
Array of Card Account Details |
Милдеттүү түрдө |
Эгерде картанын бир да эсеби жеткиликтүү болбосо, ASPSP бош массивди кайтарууга тийиш. Бул да оң жооп деп эсептелгендиктен, жооп коду дагы 200 болушу керек. |
2) Карта эсеби тууралуу толук маалыматты көрүү үчүн суроо-талап
GET /v2/card-accounts/{account-id}
Карта боюнча операцияларды макулдашуу үчүн эсеп тууралуу толук маалымат сурайт. Бул колдонуучунун пайдаланууга макулдугу буга чейин ASPSP системасында берилген жана сакталган деп болжолдонууда. Эсеп тууралуу алынган толук маалымат параметр contentId менен идентификацияланган сакталган макулдукка же пайдалануу токенине OAuth2 жараша болот.
Жол параметрлери:
Атрибуту |
Тиби |
Баяндалышы |
account-id |
String |
Бул идентификация көрсөтүлгөн эсеп картасын түшүндүрөт. Account-id «Read Account List» суроо-талабы аркылуу алынат. Account-id эсеп түзүмүнүн «resourceId» атрибуту болуп саналат. Анын мааниси, жок эле дегенде, берилген макулдуктун бүткүл циклинде туруктуу болуп эсептелет. |
Суроо-талап параметрлери
Суроо-талап параметрлери аныкталган эмес.
Суроо-талаптын аталышы
Атрибуту |
Тиби |
Шарты |
Баяндалышы |
X-Request-ID |
UUID |
Милдеттүү түрдө |
Суроо үчүн уникалдуу суроо-талаптын идентификатору, муну демилгелеген тарап аныктайт. |
PSU-IP-Address |
String |
Шарттуу түрдө |
Даректелген IP-даректин аталышынын талаасы колдонуучу менен TPP ортосундагы HTTP суроо-талабынын тиешелүү IP-дарек талаасынан турат. Ал колдонуучу тарабынан жигердүү демилгеленген учурда гана камтылууга тийиш. |
Consent-ID |
String |
Милдеттүү түрдө |
Колдонуучу тарабынан пайдаланууга берилген макулдуктун идентификациясы. |
Authorization |
String |
Шарттуу түрдө |
Эгерде OAuth2 негизиндеги аутентификация алдын ала этапта аткарылса же OAuth2 негизиндеги SCA аутентификациясы тиешелүү макулдук авторизациясы менен аткарылса гана камтылат. |
Суроо-талаптын маалыматы
Суроо-талаптын маалыматы жок
Жооп коду
HTTP жооп коду 200гө барабар.
Жооптун аталышы
Атрибуту |
Тиби |
Шарты |
Баяндалышы |
X-Request- ID |
UUID |
Милдеттүү түрдө |
Суроо үчүн уникалдуу суроо-талаптын идентификатору, муну демилгелеген тарап аныктайт. |
Жооп маалыматы
Атрибуту |
Тиби |
Шарты |
Баяндалышы |
cardAccount |
Card Account Details |
Милдеттүү түрдө |
|
3) Банктык төлөм карталары боюнча эсеп балансын көрүү үчүн суроо-талап
GET /v2/card-accounts/{account-id}/balances
«account-id» параметри менен идентификацияланган көрсөтүлгөн карта эсеби үчүн баланс жөнүндө маалыматты сурайт.
Эскертүү: Маалыматты коргоо үчүн account-id токендештирилген идентификатору болушу мүмкүн, анткени жол жөнүндө маалымат ASPSP чөйрөсүндөгү аралык серверлерде катталышы мүмкүн. Бул account-id «GET Card Account List» суроо-талабы аркылуу же ага байланыштуу макулдук ресурсунан алса болот.
Жол параметрлери:
· account-id: Баланс жөнүндө маалыматы суралып жаткан карта эсебинин идентификатору.
Атрибуту |
Тиби |
Баяндалышы |
account-id |
String |
Бул идентификация каралып жаткан карта эсебин көрсөтөт. Аccount-id «Read Account List» суроо-талабы аркылуу алынат. Account-id - эсеп түзүмүнүн «resourceId» атрибуту. Анын мааниси, жок дегенде, берилген макулдуктун бүткүл циклинде туруктуу. |
Суроо-талап параметрлери
Суроо-талаптын белгилүү бир параметрлери жок.
Коддун жообу
HTTP жооп коду 200гө барабар.
Суроо-талаптын аталышы
Атрибуту |
Тиби |
Шарты |
Баяндалышы |
X-Request-ID |
UUID |
Милдеттүү түрдө |
Суроо үчүн уникалдуу суроо-талаптын идентификатору, муну демилгелеген тарап аныктайт. |
PSU-IP-Address |
String |
Шарттуу түрдө |
Даректелген IP-даректин аталышынын талаасы колдонуучу менен TPP ортосундагы HTTP суроо-талабынын тиешелүү IP-дарек талаасынан турат. Бул суроо-талап колдонуучу тарабынан активдүү демилгеленген учурда гана камтылууга тийиш. |
Consent-ID |
String |
Милдеттүү түрдө |
Колдонуучу тарабынан берилген тиешелүү макулдукту көрсөтүү. |
Authorization |
String |
Шарттуу түрдө |
Эгерде OAuth2 негизиндеги аутентификация алдын ала этапта аткарылса же OAuth2 негизиндеги SCA аутентификациясы тиешелүү макулдук авторизациясы менен аткарылса гана камтылат. |
Суроо-талаптын маалыматы
Суроо-талаптын маалыматы жок
Жооптун аталышы
Атрибуту |
Тиби |
Шарты |
Баяндалышы |
X-Request- ID |
UUID |
Милдеттүү түрдө |
Суроо үчүн уникалдуу суроо-талаптын идентификатору, муну демилгелеген тарап аныктайт. |
Жооп маалыматы
Атрибуту |
Тиби |
Шарты |
Баяндалышы |
cardAccount |
Account Reference |
Милдеттүү түрдө |
Даректелген картанын эсебинин идентификатору |
debitAccounting |
Boolean |
Милдеттүү эмес |
Эгерде true болсо, дебет суммалары калдыктар үчүн тиешелүү жыйынтыктары менен отчёттордо оң катары көрсөтүлөт. Эгерде false болсо, отчёттордогу дебеттик суммалар терс катары көрсөтүлөт. |
balances |
Array of Balance |
Милдеттүү түрдө |
Бул карта эсеби боюнча калдыктардын тизмеси, мисалы, учурдагы калдык, акыркы сакталган калдык. |
4) Банктык төлөм картасынын эсеби боюнча транзакциялардын тизмесин көрүү үчүн суроо-талап
GET /v2/card-accounts/{account-id}/transactions {query-parameters}
«account-id» параметри менен идентификацияланган көрсөтүлгөн карта эсеби үчүн баланс жөнүндө маалыматты сурайт.
Эскертүү: Маалыматты коргоо үчүн account-id токендештирилген идентификатору болушу мүмкүн, анткени жол жөнүндө маалымат ASPSP чөйрөсүндөгү аралык серверлерде катталышы мүмкүн. Бул account-id «GET Card Account List» суроо-талабы аркылуу же ага байланыштуу макулдук ресурсунан алса болот.
«account-id» параметри менен аныкталган карта эсеби боюнча транзакция маалыматтарын сурайт.
Эскертүү: Маалыматтарды коргоо үчүн аккаунттун идентификатору токенизацияланган идентификатор болуп саналат, анткени жол маалыматы ASPSP чөйрөсүндөгү аралык серверлерде катталышы мүмкүн. Бул эсеп идентификаторун «GET Card Account List» чалуу аркылуу алса болот.
Эскертүү: ASPSP жооп үчүн тиркеменин деңгээлинде маалыматтардын көлөмүн кичирейтүүнүн стандарттуу ыкмаларын колдонушу мүмкүн, бул content-encoding аталышында көрсөтүлөт.
Эскертүү: Көңүл буруңуз, жолдун бардык параметрлери _links чакан талаасында «Эсептер тизмесин окуу» (Read Account List) суроо-талабына берилген жоопто так көрсөтүлбөгөн болушу мүмкүн.
Жол параметрлери:
Атрибуту |
Тиби |
Баяндалышы |
аccount-id |
String |
Бул идентификация каралып жаткан карта эсебин көрсөтөт. Аccount-id «Read Account List» суроо-талабы аркылуу алынат. Account-id - эсеп түзүмүнүн «resourceId» атрибуту. Анын мааниси, жок дегенде, берилген макулдуктун бүткүл циклинде туруктуу. |
Суроо-талап параметрлери
Атрибуту |
Тиби |
Шарты |
Баяндалышы |
dateFrom |
ISODate |
Шарттуу түрдө |
Транзакциялар тизмесинин баштапкы датасы (анын ичинде dateFrom датасын кошо алганда), эгерде Delta-пайдалануу талап кылынбаса, талап кылынат. |
dateTo |
ISODate |
Милдеттүү эмес |
Транзакциялар тизмесинин аяктоочу датасы (анын ичинде датасыToday), эгерде башкасы көрсөтүлбөсө, алдын ала белгиленген «бүгүн» болуп саналат. |
pageSize |
Integer |
API сунуштоочусу тарабынан колдоого алынса, милдеттүү эмес |
Бул суроо-талап параметри өркүндөтүлгөн кызматтар үчүн алынышы зарыл болгон суроо-талап транзакциясынын жазууларын аныктайт.
Эгер колдоого алынбаса, суроо-талап четке кагылат.
Эгерде ASPSP колдоого алынса жана анын документтеринде ASPSP тарабынан аныкталгандай маани maxPageSize ашса, анда четке кагылат. |
bookingStatus |
String |
Милдеттүү түрдө |
Уруксат берилген коддор «booked», «pending», «both», «information» жана «all» ASPSP тарабынан колдоого алынышы керек.
«Pending» жана «both» функцияларын колдоо ASPSP үчүн милдеттүү болуп саналбайт, ката коду онлайн банкинг интерфейсинде колдоого алынбайт. |
deltaList |
Boolean |
API сунуштоочусу тарабынан колдоого алынса, милдеттүү эмес |
Бул маалымат атрибуту AISP даректелген эсеп боюнча бул колдонуучу үчүн пайдалануу боюнча акыркы отчетунан кийин бардык транзакцияларды кабыл алууга милдеттүү экенин көрсөтүп турат.
Эгерде бул функция колдоого алынбаса, дельтанын бул индикатору ASPSP тарабынан четке кагылышы мүмкүн. |
Суроо-талаптын аталышы
Атрибуту |
Тиби |
Шарты |
Баяндалышы |
X-Request-ID |
UUID |
Милдеттүү түрдө |
Суроо үчүн уникалдуу суроо-талаптын идентификатору, муну демилгелеген тарап аныктайт. |
PSU-IP-Address |
String |
Шарттуу түрдө |
Даректелген IP-даректин аталышынын талаасы колдонуучу менен TPP ортосундагы HTTP суроо-талабынын тиешелүү IP-дарек талаасынан турат. Ал колдонуучу тарабынан жигердүү демилгеленген учурда гана камтылууга тийиш. |
Consent-ID |
String |
Милдеттүү түрдө |
Колдонуучу тарабынан пайдаланууга берилген макулдуктун идентификациясы. |
Authorization |
String |
Шарттуу түрдө |
Эгерде OAuth2 негизиндеги аутентификация алдын ала этапта аткарылса же OAuth2 негизиндеги SCA аутентификациясы тиешелүү макулдук авторизациясы менен аткарылса гана камтылат. |
Суроо-талаптын маалыматы
Суроо-талаптын маалыматы жок.
Жооп коду
HTTP жооп коду 200гө барабар.
Жооптун аталышы
Атрибуту |
Тиби |
Шарты |
Баяндалышы |
X-Request- ID |
UUID |
Милдеттүү түрдө |
Суроо үчүн уникалдуу суроо-талаптын идентификатору, муну демилгелеген тарап аныктайт. |
Жооп маалыматы
Атрибуту |
Тиби |
Шарты |
Баяндалышы |
cardAccount |
Account Reference |
Милдеттүү түрдө |
Даректелген картанын эсебинин идентификатору |
debitAccounting |
Boolean |
Милдеттүү эмес |
Эгерде true болсо, дебет суммалары калдыктар үчүн тиешелүү жыйынтыктары менен отчёттордо оң катары көрсөтүлөт. Эгерде false болсо, отчёттордогу дебеттик суммалар терс катары көрсөтүлөт. |
cardTransactions |
Card Account Report |
Милдеттүү эмес |
JSON негизинде эсеп боюнча отчёт. |
balances |
Array of Balance |
Милдеттүү эмес |
Учурдагы калдык менен чектелиши мүмкүн болгон бул эсеп боюнча калдыктардын тизмеси. |
_links |
Links |
Милдеттүү эмес |
TPP тааный турган гипершилтемелердин тизмеси. Бул жоопто уруксат берилген шилтемелердин түрү:
«download»: транзакциялардын тизмеси чоң өлчөмдө болгон учурда, транзакциялардын тизмесин жүктөп ала турган ресурска шилтеме. |