| X-Request-ID required | string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 Ідентифікатор запиту, унікальний для виклику, визначений стороною-ініціатором |
| PSU-ID | string Example: UA413220010000026206347644036 Ідентифікатор користувача фізичної особи або ФОП |
| PSU-ID-Type | string Value: "IBAN" Example: IBAN Тип ідентифікатора користувача фізичної особи або ФОП |
| PSU-Corporate-ID | string Example: UA173220010000026002700000121 Ідентифікатор користувача юридичної особи |
| PSU-Corporate-ID-Type | string Value: "IBAN" Example: IBAN Тип ідентифікатора користувача юридичної особи |
| PSU-IP-Address required | string <ipv4> Example: 8.8.8.8 IP-адреса користувача платіжних послуг |
| TPP-Redirect-URI | string <uri> Example: https://example.com/redirect Лінк для повернення користувача у платіжний застосунок TPP |
required | object |
| consentType required | string Enum: "accountList" "detailed" Тип згоди |
| recurringIndicator required | boolean Повторювана згода |
| validTo required | string <date> Дата закінчення дії згоди |
| frequencyPerDay required | integer Кількість запитів на день |
{- "access": {
- "cards": [
- {
- "account": {
- "iban": "UA413220010000026206347644036",
- "currency": "UAH"
}, - "rights": [
- "accountDetails"
]
}
], - "payments": [
- {
- "account": {
- "iban": "UA413220010000026206347644036",
- "currency": "UAH"
}, - "rights": [
- "accountDetails"
]
}
], - "savings": [
- {
- "account": {
- "iban": "UA413220010000026206347644036",
- "currency": "UAH"
}, - "rights": [
- "accountDetails"
]
}
], - "loans": [
- {
- "account": {
- "iban": "UA413220010000026206347644036",
- "currency": "UAH"
}, - "rights": [
- "accountDetails"
]
}
]
}, - "consentType": "detailed",
- "recurringIndicator": true,
- "validTo": "2024-12-31",
- "frequencyPerDay": 4
}{- "consentId": "2409105jHHToBoHe3Lqw",
- "consentStatus": "received",
- "_links": {
- "startAuthorisation": {
}
}
}| consentId required | string Example: 2409105jHHToBoHe3Lqw |
| X-Request-ID required | string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 Ідентифікатор запиту, унікальний для виклику, визначений стороною-ініціатором |
{- "access": {
- "cards": [
- {
- "account": {
- "iban": "UA413220010000026206347644036",
- "currency": "UAH"
}, - "rights": [
- "accountDetails"
]
}
], - "payments": [
- {
- "account": {
- "iban": "UA413220010000026206347644036",
- "currency": "UAH"
}, - "rights": [
- "accountDetails"
]
}
], - "savings": [
- {
- "account": {
- "iban": "UA413220010000026206347644036",
- "currency": "UAH"
}, - "rights": [
- "accountDetails"
]
}
], - "loans": [
- {
- "account": {
- "iban": "UA413220010000026206347644036",
- "currency": "UAH"
}, - "rights": [
- "accountDetails"
]
}
]
}, - "consentType": "detailed",
- "recurringIndicator": true,
- "validTo": "2024-12-31",
- "frequencyPerDay": 4,
- "consentStatus": "received"
}| consentId required | string Example: 2409105jHHToBoHe3Lqw |
| X-Request-ID required | string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 Ідентифікатор запиту, унікальний для виклику, визначений стороною-ініціатором |
{- "apiClientMessages": [
- {
- "category": "ERROR",
- "code": "BAD_REQUEST",
- "text": "Некоректний запит"
}
]
}| consentId required | string Example: 2409105jHHToBoHe3Lqw |
| X-Request-ID required | string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 Ідентифікатор запиту, унікальний для виклику, визначений стороною-ініціатором |
{- "consentStatus": "received"
}| withBalance | boolean Example: withBalance=true Повертати баланси рахунків |
| X-Request-ID required | string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 Ідентифікатор запиту, унікальний для виклику, визначений стороною-ініціатором |
| Consent-ID required | string Example: 2409105jHHToBoHe3Lqw Ідентифікатор згоди |
| PSU-IP-Address | string <ipv4> Example: 8.8.8.8 IP-адреса користувача платіжних послуг |
{- "accounts": [
- {
- "resourceId": "hH1eKFyoPmfLkhAuMB0ynA",
- "iban": "UA413220010000026206347644036",
- "currency": "UAH",
- "product": "platinum",
- "balances": [
- {
- "balanceAmount": {
- "currency": "UAH",
- "amount": "100.02"
}, - "balanceType": "interimAvailable",
- "creditLimitIncluded": true
}
]
}
]
}| accountId required | string Example: hH1eKFyoP Ідентифікатор рахунку |
| X-Request-ID required | string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 Ідентифікатор запиту, унікальний для виклику, визначений стороною-ініціатором |
| Consent-ID required | string Example: 2409105jHHToBoHe3Lqw Ідентифікатор згоди |
| PSU-IP-Address | string <ipv4> Example: 8.8.8.8 IP-адреса користувача платіжних послуг |
{- "account": {
- "iban": "UA413220010000026206347644036",
- "currency": "UAH",
- "product": "platinum"
}, - "balances": [
- {
- "balanceAmount": {
- "currency": "UAH",
- "amount": "100.02"
}, - "balanceType": "interimAvailable",
- "creditLimitIncluded": true
}
]
}| accountId required | string Example: hH1eKFyoP Ідентифікатор рахунку |
| dateFrom | string <date> (ISODate) Example: dateFrom=2024-01-01 Дата початку періоду |
| dateTo | string <date> (ISODate) Example: dateTo=2024-01-01 Дата закінчення періоду |
| pageId | string Example: pageId=Fo-TMxv-PaWyxLfohg5e4keQSQEadWiIEuvZ-xBB0EQMUqKr4r6DcsxpNy2BT0jX99o1fUBtDzaFwzb7PfaKxz Ідентифікатор сторінки |
| bookingStatus required | string Enum: "booked" "pending" "both" Example: bookingStatus=booked Статус транзакції |
| X-Request-ID required | string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 Ідентифікатор запиту, унікальний для виклику, визначений стороною-ініціатором |
| Consent-ID required | string Example: 2409105jHHToBoHe3Lqw Ідентифікатор згоди |
| PSU-IP-Address | string <ipv4> Example: 8.8.8.8 IP-адреса користувача платіжних послуг |
{- "account": {
- "iban": "UA413220010000026206347644036",
- "currency": "UAH",
- "product": "platinum"
}, - "transactions": {
- "booked": [
- {
- "transactionId": "string",
- "bookingDate": "2024-01-01",
- "transactionAmount": {
- "currency": "UAH",
- "amount": "100.02"
}, - "creditor": {
- "name": "Текст до 140 символів"
}, - "debtor": {
- "name": "Текст до 140 символів"
}, - "cardTransaction": {
- "transactionDateTime": "2006-01-02T15:04:05.999999999Z07:00",
- "tradeName": "Текст до 70 символів",
- "merchantCategoryCode": "stri"
}, - "remittanceInformationUnstructured": [
- "Оплата за послуги згідно рахунку 314415"
]
}
], - "_links": {
- "first": {
- "href": "string"
}, - "next": {
- "href": "string"
}
}
}
}| paymentProduct required | string Enum: "credit-transfers" "instant-credit-transfers" Example: credit-transfers Тип платежу |
| TPP-Redirect-URI | string <uri> Example: https://example.com/redirect Лінк для повернення користувача у платіжний застосунок TPP |
| X-Request-ID required | string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 Ідентифікатор запиту, унікальний для виклику, визначений стороною-ініціатором |
| Content-Type required | string Example: application/json |
| PSU-IP-Address required | string <ipv4> Example: 8.8.8.8 IP-адреса користувача платіжних послуг |
| PSU-ID | string Example: UA413220010000026206347644036 Ідентифікатор користувача фізичної особи або ФОП |
| PSU-ID-Type | string Value: "IBAN" Example: IBAN Тип ідентифікатора користувача фізичної особи або ФОП |
| PSU-Corporate-ID | string Example: UA173220010000026002700000121 Ідентифікатор користувача юридичної особи |
| PSU-Corporate-ID-Type | string Value: "IBAN" Example: IBAN Тип ідентифікатора користувача юридичної особи |
required | object Сума платежу |
required | object Рахунок отримувача |
required | object Отримувач |
| remittanceInformationUnstructured | Array of strings (max140Text) = 1 items [ items <= 140 characters ] Неструктурована інформація про платіж |
required | object Інформація про рахунок |
{- "instructedAmount": {
- "currency": "UAH",
- "amount": "100.02"
}, - "creditorAccount": {
- "iban": "UA413220010000026206347644036",
- "currency": "UAH"
}, - "creditor": {
- "name": "Текст до 140 символів",
- "creditorId": "string"
}, - "remittanceInformationUnstructured": [
- "Оплата за послуги згідно рахунку 314415"
], - "debtorAccount": {
- "iban": "UA413220010000026206347644036",
- "currency": "UAH"
}
}{- "transactionStatus": "RCVD",
- "paymentId": "Текст до 70 символів",
- "_links": {
- "startAuthorisation": {
- "href": "string"
}
}
}| paymentProduct required | string Enum: "credit-transfers" "instant-credit-transfers" Example: credit-transfers Тип платежу |
| paymentId required | string (max70Text) <= 70 characters Example: 241212472HToBoHe3Lq1 Ідентифікатор платежу |
| X-Request-ID required | string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 Ідентифікатор запиту, унікальний для виклику, визначений стороною-ініціатором |
{- "transactionStatus": "RCVD"
}| paymentProduct required | string Enum: "credit-transfers" "instant-credit-transfers" Example: credit-transfers Тип платежу |
| paymentId required | string (max70Text) <= 70 characters Example: 241212472HToBoHe3Lq1 Ідентифікатор платежу |
| X-Request-ID required | string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 Ідентифікатор запиту, унікальний для виклику, визначений стороною-ініціатором |
{- "transactionStatus": "RCVD",
- "paymentId": "Текст до 70 символів",
- "instructedAmount": {
- "currency": "UAH",
- "amount": "100.02"
}, - "creditorAccount": {
- "iban": "UA413220010000026206347644036",
- "currency": "UAH"
}, - "creditor": {
- "name": "Текст до 140 символів",
- "creditorId": "string"
}, - "debtorAccount": {
- "iban": "UA413220010000026206347644036",
- "currency": "UAH"
}
}| paymentProduct required | string Enum: "credit-transfers" "instant-credit-transfers" Example: credit-transfers Тип платежу |
| paymentId required | string (max70Text) <= 70 characters Example: 241212472HToBoHe3Lq1 Ідентифікатор платежу |
| X-Request-ID required | string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 Ідентифікатор запиту, унікальний для виклику, визначений стороною-ініціатором |
{- "apiClientMessages": [
- {
- "category": "ERROR",
- "code": "BAD_REQUEST",
- "text": "Некоректний запит"
}
]
}