Open Banking aggregation API v1
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
This API provides possibility to fetch account information and initiate payments on behalf of end users within a number of account servicing providers (i.e. banks and similar financial institutions).
Base URLs:
Authentication
HTTP authentication, scheme: bearer
In order to get access to this API you need to:
- Generate a private RSA key and a self-signed certificate;
- Upload the certificate to the service and get application ID;
- Construct JWT with the data described below and signed with your private key;
- Send the JWT in the Authorization header.
Private key and certificate generation
Generating private RSA key
openssl genrsa -out private.key 4096
OpenSSL CLI can be used for generation of a private key and self-signed certificate.
Make sure you keep the private key in secret (e.g. don't expose it to client, share with anyone nor embed into mobile or other apps intalled to user devices).
Generating self-signed certificate
openssl req -new -x509 -days 365 -key private.key -out public.crt -subj "/C=FI/ST=Uusima/L=Helsinki/O=ExampleOrganisation/CN=www.bigorg.com"
You should replace values under -subj with appropriate values.
JWT format and signature
JWT example
eyJ0eXAiOiAiSldUIiwgImFsZyI6ICJSUzI1NiIsICJraWQiOiAiY2Y1ODliZTMtMzc1NS00NjViLWE4ZGYtYTkwYTE2YTMxNDAzIn0.eyJpc3MiOiAiZW5hYmxlYmFua2luZy5jb20iLCAiYXVkIjogImFwaS50aWxpc3kuY29tIiwgImlhdCI6IDE2MDE0NTY3NjgsICJleHAiOiAxNjAxNTQzMTY4fQ.daO3ENSYIA3ud7Ay7uGQ0xxqq9r4_WLcM5SbrN_6_fqsFZXFdoGQA5nKiyP8Ot4nWdYcZvaNWxEAOIodUFndOP8pjihF9-rMXuNGEjde1cq2WjYzKwiIeodUej8okDWdB--szcgurzGMd8RRMjqr951PWqnXS-PbrRsavDHp8l2q4YBjh2m80nRruKnQCAn0dtm4A5G9rZaEowo9z-c8HJU101jKddyOpHhl9UvxVrERzHtyO4LdidiP4rP1hmaVMWybSbcIMI_h30qjqWP21kYRH9ENITTttbf0uZIa8s74jKYxNIdiiDyRaq9WjoPolrHI_ZxcMjp8mmCKX-N-1w
You can read more about JWT here: https://jwt.io/introduction/
JWT header must contain following fields:
- "typ": "JWT" (always the same)
- "alg": "RS256" (always the same, only RS256 is supported)
- "kid": "<application_id>" (application id obtained after certificate upload)
JWT body must contain following fields:
- "iss": "enablebanking.com" (always the same)
- "aud": "tpp.local" (always the same)
- "iat": 1601456603 (timestamp when the token is being created)
- "exp": 1601460262 (timestamp when the token expires)
Maximum allowed time-to-live for token is 3600 seconds (1 hour). Tokens created with longer TTL are not accepted by the API.
Send request with JWT provided
Example request
GET https://tpp.local/api/v1/application HTTP/1.1
Host: tpp.local
Authorization: Bearer eyJ0eXAiOiAiSldUIiwgImFsZyI6ICJSUzI1NiIsICJraWQiOiAiY2Y1ODliZTMtMzc1NS00NjViLWE4ZGYtYTkwYTE2YTMxNDAzIn0.eyJpc3MiOiAiZW5hYmxlYmFua2luZy5jb20iLCAiYXVkIjogImFwaS50aWxpc3kuY29tIiwgImlhdCI6IDE2MDE0NTY3NjgsICJleHAiOiAxNjAxNTQzMTY4fQ.daO3ENSYIA3ud7Ay7uGQ0xxqq9r4_WLcM5SbrN_6_fqsFZXFdoGQA5nKiyP8Ot4nWdYcZvaNWxEAOIodUFndOP8pjihF9-rMXuNGEjde1cq2WjYzKwiIeodUej8okDWdB--szcgurzGMd8RRMjqr951PWqnXS-PbrRsavDHp8l2q4YBjh2m80nRruKnQCAn0dtm4A5G9rZaEowo9z-c8HJU101jKddyOpHhl9UvxVrERzHtyO4LdidiP4rP1hmaVMWybSbcIMI_h30qjqWP21kYRH9ENITTttbf0uZIa8s74jKYxNIdiiDyRaq9WjoPolrHI_ZxcMjp8mmCKX-N-1w
In order to authenticate your application, you need to provide JWT in the "Authorization" header of your request.
Account information
Get account balances
Code samples
GET https://tpp.local/api/v1/accounts/{accountId}/balances HTTP/1.1
Host: tpp.local
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.e30.ZRrHA1JJJW8opsbCGfG_HACGpVUMN_a9IV7pAx_Zmeo
PSU-IP-Address: string
PSU-User-Agent: string
PSU-Referer: string
PSU-Accept: string
PSU-Accept-Charset: string
PSU-Accept-Encoding: string
PSU-Accept-language: string
PSU-Geo-Location: string
GET /api/v1/accounts/{accountId}/balances
This operation is used to fetch available account balances by provided account id
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountId | path | string | true | Identifier of an account previously made available within a session |
| Authorization | header | string | true | Application JWT |
| PSU-IP-Address | header | string | false | PSU IP address |
| PSU-User-Agent | header | string | false | PSU browser User Agent |
| PSU-Referer | header | string | false | PSU Referer |
| PSU-Accept | header | string | false | PSU Accept header |
| PSU-Accept-Charset | header | string | false | PSU charset |
| PSU-Accept-Encoding | header | string | false | PSU accept encoding |
| PSU-Accept-language | header | string | false | PSU accept language |
| PSU-Geo-Location | header | string | false | Comma separated latitude and longitude coordinates without spaces |
Example responses
200 Response
{
"balances": [
{
"balanceAmount": {
"currency": "string",
"amount": "string"
},
"creditDebitIndicator": "CRDT",
"balanceType": "CLBD",
"referenceDate": "2019-08-24"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | GetAccountBalancesResponse |
Get account transactions
Code samples
GET https://tpp.local/api/v1/accounts/{accountId}/transactions HTTP/1.1
Host: tpp.local
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.e30.ZRrHA1JJJW8opsbCGfG_HACGpVUMN_a9IV7pAx_Zmeo
PSU-IP-Address: string
PSU-User-Agent: string
PSU-Referer: string
PSU-Accept: string
PSU-Accept-Charset: string
PSU-Accept-Encoding: string
PSU-Accept-language: string
PSU-Geo-Location: string
GET /api/v1/accounts/{accountId}/transactions
This operation is used to fetch available account transactions by provided account id
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountId | path | string | true | Identifier of an account previously made available within a session |
| dateFrom | query | string | false | Initial date of the data range being requested |
| dateTo | query | string | false | Final date of the data range being requested |
| continuationKey | query | string | false | Key allowing to iterate over multiple pages of transactions |
| Authorization | header | string | true | Application JWT |
| PSU-IP-Address | header | string | false | PSU IP address |
| PSU-User-Agent | header | string | false | PSU browser User Agent |
| PSU-Referer | header | string | false | PSU Referer |
| PSU-Accept | header | string | false | PSU Accept header |
| PSU-Accept-Charset | header | string | false | PSU charset |
| PSU-Accept-Encoding | header | string | false | PSU accept encoding |
| PSU-Accept-language | header | string | false | PSU accept language |
| PSU-Geo-Location | header | string | false | Comma separated latitude and longitude coordinates without spaces |
Example responses
200 Response
{
"transactions": [
{
"transactionAmount": {
"currency": "string",
"amount": "string"
},
"creditDebitIndicator": "CRDT",
"status": "string",
"entryReference": "string",
"remittanceInformation": [
"string"
],
"referenceNumber": "string",
"bookingDate": "2019-08-24",
"transactionDate": "2019-08-24",
"valueDate": "2019-08-24",
"creditor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"creditorAccount": {
"identification": "string",
"schemeName": "string"
},
"debtor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"debtorAccount": {
"identification": "string",
"schemeName": "string"
},
"merchantCategoryCode": "string"
}
],
"continuationKey": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | GetAccountTransactionsResponse |
Start user authorization
Code samples
POST https://tpp.local/api/v1/auth HTTP/1.1
Host: tpp.local
Content-Type: application/json
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.e30.ZRrHA1JJJW8opsbCGfG_HACGpVUMN_a9IV7pAx_Zmeo
POST /api/v1/auth
This operation is used to initiate PSU authorization in a chosen ASPSPs
Body parameter
{
"access": {
"accounts": [
{
"identification": "string",
"schemeName": "string"
}
],
"balances": true,
"transactions": true,
"validUntil": "string"
},
"aspsp": {
"name": "string",
"country": "string"
},
"psuType": "BUSINESS",
"redirectUri": "string",
"state": "string",
"authMethod": "string",
"credentials": {
"property1": "string",
"property2": "string"
},
"language": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Application JWT |
| body | body | StartAuthorizationRequest | true | Data necessary for starting end user authorization and account information consent |
Example responses
200 Response
{
"authorizationUri": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | StartAuthorizationResponse |
Authorize user session
Code samples
POST https://tpp.local/api/v1/sessions HTTP/1.1
Host: tpp.local
Content-Type: application/json
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.e30.ZRrHA1JJJW8opsbCGfG_HACGpVUMN_a9IV7pAx_Zmeo
POST /api/v1/sessions
This operation is used to authorize user session by provided authorization code
Body parameter
{
"code": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Application JWT |
| body | body | AuthorizeSessionRequest | true | Data necessary for authorization of end user session |
Example responses
200 Response
{
"sessionId": "string",
"aspsp": {
"name": "string",
"country": "string"
},
"psuType": "BUSINESS",
"access": {
"accounts": [
{
"identification": "string",
"schemeName": "string"
}
],
"balances": true,
"transactions": true,
"validUntil": "string"
},
"accounts": [
{
"accountId": "string",
"identificationHash": "string",
"identifications": [
{
"identification": "string",
"schemeName": "string"
}
],
"currency": "string",
"cashAccountType": "CACC",
"holder": "string",
"details": "string",
"product": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | AuthorizeSessionResponse |
Get session data
Code samples
GET https://tpp.local/api/v1/sessions/{sessionId} HTTP/1.1
Host: tpp.local
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.e30.ZRrHA1JJJW8opsbCGfG_HACGpVUMN_a9IV7pAx_Zmeo
GET /api/v1/sessions/{sessionId}
This operation is used to retrieve session data by session id
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| sessionId | path | string | true | Identifier of a previously authorized session |
| Authorization | header | string | true | Application JWT |
Example responses
200 Response
{
"status": "INVALID",
"aspsp": {
"name": "string",
"country": "string"
},
"accounts": [
{
"accountId": "string",
"identificationHash": "string",
"identifications": [
{
"identification": "string",
"schemeName": "string"
}
],
"currency": "string",
"cashAccountType": "CACC",
"holder": "string",
"details": "string",
"product": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | GetSessionResponse |
Delete session
Code samples
DELETE https://tpp.local/api/v1/sessions/{sessionId} HTTP/1.1
Host: tpp.local
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.e30.ZRrHA1JJJW8opsbCGfG_HACGpVUMN_a9IV7pAx_Zmeo
PSU-IP-Address: string
PSU-User-Agent: string
PSU-Referer: string
PSU-Accept: string
PSU-Accept-Charset: string
PSU-Accept-Encoding: string
PSU-Accept-language: string
PSU-Geo-Location: string
DELETE /api/v1/sessions/{sessionId}
This operation is used to delete session. PSU's consent will be revoked if possible
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| sessionId | path | string | true | Identifier of a previously authorized session |
| Authorization | header | string | true | Application JWT |
| PSU-IP-Address | header | string | false | PSU IP address |
| PSU-User-Agent | header | string | false | PSU browser User Agent |
| PSU-Referer | header | string | false | PSU Referer |
| PSU-Accept | header | string | false | PSU Accept header |
| PSU-Accept-Charset | header | string | false | PSU charset |
| PSU-Accept-Encoding | header | string | false | PSU accept encoding |
| PSU-Accept-language | header | string | false | PSU accept language |
| PSU-Geo-Location | header | string | false | Comma separated latitude and longitude coordinates without spaces |
Example responses
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
Response Schema
Misc
Get application
Code samples
GET https://tpp.local/api/v1/application HTTP/1.1
Host: tpp.local
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.e30.ZRrHA1JJJW8opsbCGfG_HACGpVUMN_a9IV7pAx_Zmeo
GET /api/v1/application
This operation is used to get details of an application associated with provided JWT key id
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Application JWT |
Example responses
200 Response
{
"active": true,
"description": "string",
"environment": "production",
"kid": "string",
"name": "string",
"redirectUris": [
"string"
],
"countries": [
"string"
],
"services": [
"string"
],
"paymentTypes": [
"DOMESTIC"
],
"applicationSettings": {
"skipPsuConsentScreen": true
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | GetApplicationResponse |
Get list of ASPSPs
Code samples
GET https://tpp.local/api/v1/aspsps?country=string&service=string HTTP/1.1
Host: tpp.local
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.e30.ZRrHA1JJJW8opsbCGfG_HACGpVUMN_a9IV7pAx_Zmeo
GET /api/v1/aspsps
This operation is used to get list of ASPSPs with their meta information
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| country | query | string | true | Country code to filter results |
| service | query | string | true | Service to be provided (AIS or PIS) |
| Authorization | header | string | true | Application JWT |
Example responses
200 Response
{
"aspsps": [
{
"name": "string",
"country": "string",
"logo": "string",
"services": [
"string"
],
"psuTypes": [
"string"
],
"authMethods": [
{
"name": "string",
"title": "string",
"psuType": "string",
"credentials": [
{
"name": "string",
"title": "string",
"required": true,
"description": "string",
"template": "string"
}
],
"approach": "string",
"hiddenMethod": true
}
],
"paymentTypes": [
{
"name": "DOMESTIC",
"currencies": [
"string"
],
"debtorAccountRequired": true,
"debtorAccountSchemes": [
"string"
],
"debtorCurrencyRequired": true,
"creditorAccountSchemes": [
"string"
],
"creditorCountryRequired": true,
"creditorNameRequired": true,
"creditorPostalAddressRequired": true,
"creditorAgentBicFiRequired": true,
"remittanceInformationRequired": true,
"priorityCodes": [
"HIGH"
],
"chargeBearerCodes": [
"SLEV"
],
"allowedAuthMethods": [
"string"
],
"debtorContactEmailRequired": true,
"debtorContactPhoneRequired": true,
"creditorAgentClearingSystemMemberIdRequired": true,
"regulatoryReportingCodeRequired": true,
"regulatoryReportingCodes": [
{
"value": "string",
"description": "string"
}
],
"remittanceInformationLines": [
{
"minLength": 0,
"maxLength": 0,
"pattern": "string"
}
],
"referenceNumberSupported": true
}
],
"languages": [
"string"
]
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | GetAspspsResponse |
Payment initiation
Initiate payment
Code samples
POST https://tpp.local/api/v1/payments HTTP/1.1
Host: tpp.local
Content-Type: application/json
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.e30.ZRrHA1JJJW8opsbCGfG_HACGpVUMN_a9IV7pAx_Zmeo
POST /api/v1/payments
This operation initiates payment in a chosen ASPSP with a given payment details (i.e. debtor and creditor account numbers, creditor name, etc).
Body parameter
{
"paymentType": "DOMESTIC",
"payment": {
"creditTransferTransaction": [
{
"instructedAmount": {
"currency": "string",
"amount": "string"
},
"paymentId": {
"instructionId": "string",
"endToEndId": "string"
},
"beneficiary": {
"creditorAccount": {
"identification": "string",
"schemeName": "string"
},
"creditor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"creditorAgent": {
"bicFi": "string",
"clearingSystemMemberId": {
"clearingSystemId": "string",
"memberId": "string"
},
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
},
"creditorCurrency": "string"
},
"regulatoryReporting": [
{
"authority": {
"country": "string",
"name": "string"
},
"details": {
"amount": {
"currency": "string",
"amount": "string"
},
"code": "string",
"information": "string"
}
}
],
"referenceNumber": "string",
"remittanceInformation": [
"string"
],
"requestedExecutionDate": "string",
"frequency": "WEEK"
}
],
"debtor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"debtorAccount": {
"identification": "string",
"schemeName": "string"
},
"debtorAgent": {
"bicFi": "string",
"clearingSystemMemberId": {
"clearingSystemId": "string",
"memberId": "string"
},
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
},
"debtorCurrency": "string",
"chargeBearer": "SLEV",
"paymentTypeInformation": {
"instructionPriority": "HIGH",
"serviceLevel": "BKTR",
"categoryPurpose": "BONU",
"localInstrument": "string"
}
},
"aspsp": {
"name": "string",
"country": "string"
},
"psuType": "BUSINESS",
"redirectUri": "string",
"state": "string",
"authMethod": "string",
"credentials": {
"property1": "string",
"property2": "string"
},
"language": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Application JWT |
| body | body | InitiatePaymentRequest | true | Data necessary for payment initiation |
Example responses
200 Response
{
"paymentId": "string",
"confirmationUri": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | InitiatePaymentResponse |
Get payment data
Code samples
GET https://tpp.local/api/v1/payments/{paymentId} HTTP/1.1
Host: tpp.local
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.e30.ZRrHA1JJJW8opsbCGfG_HACGpVUMN_a9IV7pAx_Zmeo
PSU-IP-Address: string
PSU-User-Agent: string
PSU-Referer: string
PSU-Accept: string
PSU-Accept-Charset: string
PSU-Accept-Encoding: string
PSU-Accept-language: string
PSU-Geo-Location: string
GET /api/v1/payments/{paymentId}
This operation retrieves details about previously initiated payment.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| paymentId | path | string | true | Identifier of a previously initiated payment |
| Authorization | header | string | true | Application JWT |
| PSU-IP-Address | header | string | false | PSU IP address |
| PSU-User-Agent | header | string | false | PSU browser User Agent |
| PSU-Referer | header | string | false | PSU Referer |
| PSU-Accept | header | string | false | PSU Accept header |
| PSU-Accept-Charset | header | string | false | PSU charset |
| PSU-Accept-Encoding | header | string | false | PSU accept encoding |
| PSU-Accept-language | header | string | false | PSU accept language |
| PSU-Geo-Location | header | string | false | Comma separated latitude and longitude coordinates without spaces |
Example responses
200 Response
{
"payment": {
"creditTransferTransaction": [
{
"instructedAmount": {
"currency": "string",
"amount": "string"
},
"paymentId": {
"instructionId": "string",
"endToEndId": "string"
},
"beneficiary": {
"creditorAccount": {
"identification": "string",
"schemeName": "string"
},
"creditor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"creditorAgent": {
"bicFi": "string",
"clearingSystemMemberId": {
"clearingSystemId": "string",
"memberId": "string"
},
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
},
"creditorCurrency": "string"
},
"regulatoryReporting": [
{
"authority": {
"country": "string",
"name": "string"
},
"details": {
"amount": {
"currency": "string",
"amount": "string"
},
"code": "string",
"information": "string"
}
}
],
"referenceNumber": "string",
"remittanceInformation": [
"string"
],
"requestedExecutionDate": "string",
"frequency": "WEEK"
}
],
"debtor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"debtorAccount": {
"identification": "string",
"schemeName": "string"
},
"debtorAgent": {
"bicFi": "string",
"clearingSystemMemberId": {
"clearingSystemId": "string",
"memberId": "string"
},
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
},
"debtorCurrency": "string",
"chargeBearer": "SLEV",
"paymentTypeInformation": {
"instructionPriority": "HIGH",
"serviceLevel": "BKTR",
"categoryPurpose": "BONU",
"localInstrument": "string"
}
},
"paymentType": "DOMESTIC",
"paymentStatus": "ACCC",
"paymentStatusReason": {
"code": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | GetPaymentResponse |
Confirm payment
Code samples
PUT https://tpp.local/api/v1/payments/{paymentId} HTTP/1.1
Host: tpp.local
Content-Type: application/json
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.e30.ZRrHA1JJJW8opsbCGfG_HACGpVUMN_a9IV7pAx_Zmeo
PSU-IP-Address: string
PSU-User-Agent: string
PSU-Referer: string
PSU-Accept: string
PSU-Accept-Charset: string
PSU-Accept-Encoding: string
PSU-Accept-language: string
PSU-Geo-Location: string
PUT /api/v1/payments/{paymentId}
This operation confirms previously initiated payment. This is optional operation; it needs to called only in case the payment authorization factor (code) is submitted by a PSU through an application using this API rather than the UI used to facilitate authorisation of the PSU. The operation can be also used to just confirm that the PSU has succesfully returned to the app, which initiated the payment.
Body parameter
false
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| paymentId | path | string | true | Identifier of a previously initiated payment |
| Authorization | header | string | true | Application JWT |
| PSU-IP-Address | header | string | false | PSU IP address |
| PSU-User-Agent | header | string | false | PSU browser User Agent |
| PSU-Referer | header | string | false | PSU Referer |
| PSU-Accept | header | string | false | PSU Accept header |
| PSU-Accept-Charset | header | string | false | PSU charset |
| PSU-Accept-Encoding | header | string | false | PSU accept encoding |
| PSU-Accept-language | header | string | false | PSU accept language |
| PSU-Geo-Location | header | string | false | Comma separated latitude and longitude coordinates without spaces |
Example responses
200 Response
{
"payment": {
"creditTransferTransaction": [
{
"instructedAmount": {
"currency": "string",
"amount": "string"
},
"paymentId": {
"instructionId": "string",
"endToEndId": "string"
},
"beneficiary": {
"creditorAccount": {
"identification": "string",
"schemeName": "string"
},
"creditor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"creditorAgent": {
"bicFi": "string",
"clearingSystemMemberId": {
"clearingSystemId": "string",
"memberId": "string"
},
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
},
"creditorCurrency": "string"
},
"regulatoryReporting": [
{
"authority": {
"country": "string",
"name": "string"
},
"details": {
"amount": {
"currency": "string",
"amount": "string"
},
"code": "string",
"information": "string"
}
}
],
"referenceNumber": "string",
"remittanceInformation": [
"string"
],
"requestedExecutionDate": "string",
"frequency": "WEEK"
}
],
"debtor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"debtorAccount": {
"identification": "string",
"schemeName": "string"
},
"debtorAgent": {
"bicFi": "string",
"clearingSystemMemberId": {
"clearingSystemId": "string",
"memberId": "string"
},
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
},
"debtorCurrency": "string",
"chargeBearer": "SLEV",
"paymentTypeInformation": {
"instructionPriority": "HIGH",
"serviceLevel": "BKTR",
"categoryPurpose": "BONU",
"localInstrument": "string"
}
},
"paymentType": "DOMESTIC",
"paymentStatus": "ACCC",
"paymentStatusReason": {
"code": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | ConfirmPaymentResponse |
Schemas
Access
{
"accounts": [
{
"identification": "string",
"schemeName": "string"
}
],
"balances": true,
"transactions": true,
"validUntil": "string"
}
Scope of access requested from ASPSP and confirmed by PSU
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| accounts | [AccountIdentification] | false | List of accounts access to which is requested. If not set PSU will be allowed to choose accounts, which will be accessed. |
| balances | boolean | true | Request consent with balances access |
| transactions | boolean | true | Request consent with transactions access |
| validUntil | string | true | This parameter is requesting a valid until date for the requested consent. The value shall be in RFC3339 date, e.g. 2021-01-01. The value might get adjusted to fullfil ASPSP requirements. |
Account
{
"accountId": "string",
"identificationHash": "string",
"identifications": [
{
"identification": "string",
"schemeName": "string"
}
],
"currency": "string",
"cashAccountType": "CACC",
"holder": "string",
"details": "string",
"product": "string"
}
List of accounts made available within the session
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| accountId | string | true | Internal account identifier (used for fetching account balances and transactions) |
| identificationHash | string | true | Account identification hash used to uniquely identify accounts accross multiple sessions |
| identifications | [AccountIdentification] | true | All account numbers provided by ASPSPs |
| currency | string | true | Identification of the currency in which the account is held. |
| cashAccountType | string | true | Specifies the type of the account. |
| holder | string | false | Account holder(s) name(s) |
| details | string | false | Account description set by PSU or provided by ASPSP. |
| product | string | false | Product Name used by the ASPSP for this account. |
Enumerated Values
| Property | Value |
|---|---|
| cashAccountType | CACC |
| cashAccountType | CASH |
| cashAccountType | CARD |
| cashAccountType | LOAN |
| cashAccountType | SVGS |
| cashAccountType | OTHR |
AccountIdentification
{
"identification": "string",
"schemeName": "string"
}
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| identification | string | true | Account identification |
| schemeName | string | true | Scheme name |
Amount
{
"currency": "string",
"amount": "string"
}
Amount of money to be reported. If not provided the total instructed amount of the transaction is assumed
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| currency | string | true | A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 “Codes for the representation of currencies and funds” |
| amount | string | true | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. |
ApplicationSettings
{
"skipPsuConsentScreen": true
}
List of application related settings
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| skipPsuConsentScreen | boolean | false | none |
Aspsp
{
"name": "string",
"country": "string"
}
ASPSP in which the session was authorized
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | true | Name of a financial institution servicing the Accounts of the PSU |
| country | string | true | Country in which a financial institution resides |
AspspData
{
"name": "string",
"country": "string",
"logo": "string",
"services": [
"string"
],
"psuTypes": [
"string"
],
"authMethods": [
{
"name": "string",
"title": "string",
"psuType": "string",
"credentials": [
{
"name": "string",
"title": "string",
"required": true,
"description": "string",
"template": "string"
}
],
"approach": "string",
"hiddenMethod": true
}
],
"paymentTypes": [
{
"name": "DOMESTIC",
"currencies": [
"string"
],
"debtorAccountRequired": true,
"debtorAccountSchemes": [
"string"
],
"debtorCurrencyRequired": true,
"creditorAccountSchemes": [
"string"
],
"creditorCountryRequired": true,
"creditorNameRequired": true,
"creditorPostalAddressRequired": true,
"creditorAgentBicFiRequired": true,
"remittanceInformationRequired": true,
"priorityCodes": [
"HIGH"
],
"chargeBearerCodes": [
"SLEV"
],
"allowedAuthMethods": [
"string"
],
"debtorContactEmailRequired": true,
"debtorContactPhoneRequired": true,
"creditorAgentClearingSystemMemberIdRequired": true,
"regulatoryReportingCodeRequired": true,
"regulatoryReportingCodes": [
{
"value": "string",
"description": "string"
}
],
"remittanceInformationLines": [
{
"minLength": 0,
"maxLength": 0,
"pattern": "string"
}
],
"referenceNumberSupported": true
}
],
"languages": [
"string"
]
}
List of available ASPSPs
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | true | Name of a financial institution servicing the Accounts of the PSU |
| country | string | true | Two-letter country code of the country in which a financial institution resides |
| logo | string | true | Contains ASPSP logo URL. It is possible to transform (e.g. resize) the logo by adding special suffixes at the end of the URL. For example, -/resize/500x/. For full list of possible transformations, please refer to https://uploadcare.com/docs/transformations/image_transformations/ |
| services | [string] | true | List of ASPSP supported services: AIS - account information service, PIS - payment initiation service |
| psuTypes | [string] | true | List of PSU types supported by ASPSP: business - corporate users, personal - private users |
| authMethods | [AuthMethod] | true | List of available authentication methods. |
| paymentTypes | [PaymentType] | true | List of available payment types and their properties |
| languages | [string] | false | List of available languages for SCA authorization |
AuthDataDto
{
"type": "string",
"value": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| type | string | false | none |
| value | string | false | none |
AuthInfoDto
{
"credentials": [
{
"name": "string",
"title": "string",
"required": true,
"description": "string",
"template": "string",
"value": "string"
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| credentials | [CredentialDto] | false | none |
AuthMethod
{
"name": "string",
"title": "string",
"psuType": "string",
"credentials": [
{
"name": "string",
"title": "string",
"required": true,
"description": "string",
"template": "string"
}
],
"approach": "string",
"hiddenMethod": true
}
List of available authentication methods.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | false | Internal name of the authentication method |
| title | string | false | Human-readable title of the authentication method |
| psuType | string | true | PSU type to which the authentication method is applicable |
| credentials | [Credential] | true | List of credentials which are possible to supply while initiating authorization. |
| approach | string | false | Authentication approach used in the current authentication method: REDIRECT, DECOUPLED or EMBEDDED |
| hiddenMethod | boolean | false | Flag showing whether the current authentication method is hidden from the user. If true then the user will not be able to select this authentication method. It is inly possible to select this authentication method via API. |
AuthorizeSessionRequest
{
"code": "string"
}
Data necessary for authorization of end user session
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| code | string | true | Authorization code returned when redirecting PSU |
AuthorizeSessionResponse
{
"sessionId": "string",
"aspsp": {
"name": "string",
"country": "string"
},
"psuType": "BUSINESS",
"access": {
"accounts": [
{
"identification": "string",
"schemeName": "string"
}
],
"balances": true,
"transactions": true,
"validUntil": "string"
},
"accounts": [
{
"accountId": "string",
"identificationHash": "string",
"identifications": [
{
"identification": "string",
"schemeName": "string"
}
],
"currency": "string",
"cashAccountType": "CACC",
"holder": "string",
"details": "string",
"product": "string"
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| sessionId | string | true | Identifier of the session |
| aspsp | Aspsp | true | ASPSP in which the session was authorized |
| psuType | string | true | PSU type which consent is created for |
| access | Access | true | Scope of access requested from ASPSP and confirmed by PSU |
| accounts | [Account] | true | List of accounts made available within the session |
Enumerated Values
| Property | Value |
|---|---|
| psuType | BUSINESS |
| psuType | PERSONAL |
Balance
{
"balanceAmount": {
"currency": "string",
"amount": "string"
},
"creditDebitIndicator": "CRDT",
"balanceType": "CLBD",
"referenceDate": "2019-08-24"
}
List of account balances
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| balanceAmount | Amount | true | Amount of money to be reported. If not provided the total instructed amount of the transaction is assumed |
| creditDebitIndicator | string | true | Indicates whether the balance is a credit or a debit balance |
| balanceType | string | true | Indicates balance types (these follow the standard ISO 20022 balance type enumerations) |
| referenceDate | string(date) | false | Reference date and time for the balance in case they are provided by ASPSP |
Enumerated Values
| Property | Value |
|---|---|
| creditDebitIndicator | CRDT |
| creditDebitIndicator | DBIT |
| balanceType | CLBD |
| balanceType | FWAV |
| balanceType | ITAV |
| balanceType | ITBD |
| balanceType | OTHR |
| balanceType | VALU |
| balanceType | XPCD |
Beneficiary
{
"creditorAccount": {
"identification": "string",
"schemeName": "string"
},
"creditor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"creditorAgent": {
"bicFi": "string",
"clearingSystemMemberId": {
"clearingSystemId": "string",
"memberId": "string"
},
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
},
"creditorCurrency": "string"
}
Specification of a beneficiary. Required when payment settings for the payment type are not stored in the application. When payment settings for the payment type are stored in the application must not be provided.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| creditorAccount | AccountIdentification | true | Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction |
| creditor | PartyIdentification | false | Information about debtor necessary for execution of the payment. Required fields depend on the payment type and ASPSP executing the payment. |
| creditorAgent | FinancialInstitutionIdentification | false | Unambiguous identification of the financial institution of the debtor to which a debit entry will be made as a result of the transaction |
| creditorCurrency | string | false | Creditor account currency code, as described in the standard ISO 4217 |
ClearingSystemMemberIdentification
{
"clearingSystemId": "string",
"memberId": "string"
}
Information used to identify a member within a clearing system. Used for some specific domestic and cross-border credit transfers in order to identify the beneficiary bank.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| clearingSystemId | string | false | Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed. |
| memberId | string | false | Identification of a member of a clearing system. |
ConfirmAccountSelectionRequest
{
"accountPosition": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| accountPosition | integer(int32) | false | none |
ConfirmPaymentResponse
{
"payment": {
"creditTransferTransaction": [
{
"instructedAmount": {
"currency": "string",
"amount": "string"
},
"paymentId": {
"instructionId": "string",
"endToEndId": "string"
},
"beneficiary": {
"creditorAccount": {
"identification": "string",
"schemeName": "string"
},
"creditor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"creditorAgent": {
"bicFi": "string",
"clearingSystemMemberId": {
"clearingSystemId": "string",
"memberId": "string"
},
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
},
"creditorCurrency": "string"
},
"regulatoryReporting": [
{
"authority": {
"country": "string",
"name": "string"
},
"details": {
"amount": {
"currency": "string",
"amount": "string"
},
"code": "string",
"information": "string"
}
}
],
"referenceNumber": "string",
"remittanceInformation": [
"string"
],
"requestedExecutionDate": "string",
"frequency": "WEEK"
}
],
"debtor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"debtorAccount": {
"identification": "string",
"schemeName": "string"
},
"debtorAgent": {
"bicFi": "string",
"clearingSystemMemberId": {
"clearingSystemId": "string",
"memberId": "string"
},
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
},
"debtorCurrency": "string",
"chargeBearer": "SLEV",
"paymentTypeInformation": {
"instructionPriority": "HIGH",
"serviceLevel": "BKTR",
"categoryPurpose": "BONU",
"localInstrument": "string"
}
},
"paymentType": "DOMESTIC",
"paymentStatus": "ACCC",
"paymentStatusReason": {
"code": "string"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| payment | Payment | true | Payment data |
| paymentType | string | true | Payment data |
| paymentStatus | string | true | Specifies the status of the payment information group |
| paymentStatusReason | PaymentStatusReason | false | Provides detailed information on the status reason |
Enumerated Values
| Property | Value |
|---|---|
| paymentType | DOMESTIC |
| paymentType | SEPA |
| paymentType | CROSSBORDER |
| paymentType | DOMESTIC_SE_GIRO |
| paymentType | INST_SEPA |
| paymentType | BULK_SEPA |
| paymentType | INTERNAL |
| paymentStatus | ACCC |
| paymentStatus | ACCP |
| paymentStatus | ACSC |
| paymentStatus | ACSP |
| paymentStatus | ACTC |
| paymentStatus | ACWC |
| paymentStatus | ACWP |
| paymentStatus | PART |
| paymentStatus | RCVD |
| paymentStatus | PDNG |
| paymentStatus | RJCT |
| paymentStatus | ACPT |
| paymentStatus | ACCR |
| paymentStatus | RJCR |
| paymentStatus | PACR |
| paymentStatus | PDCR |
| paymentStatus | CNCL |
| paymentStatus | NULL |
ContactDetails
{
"emailAddress": "string",
"phoneNumber": "string"
}
Contact information of a party such as e-mail address and phone number.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| emailAddress | string | false | E-mail address |
| phoneNumber | string | false | Phone number |
CountryAuthInfoDto
{
"country": "string",
"method": "string",
"hidden_method": true,
"title": "string",
"info": {
"credentials": [
{
"name": "string",
"title": "string",
"required": true,
"description": "string",
"template": "string",
"value": "string"
}
]
},
"approach": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| country | string | false | none |
| method | string | false | none |
| hidden_method | boolean | false | none |
| title | string | false | none |
| info | AuthInfoDto | false | none |
| approach | string | false | none |
Credential
{
"name": "string",
"title": "string",
"required": true,
"description": "string",
"template": "string"
}
List of credentials which are possible to supply while initiating authorization.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | true | Internal name of the credential. The name is to be used when passing credentials to the "start user authorization" request |
| title | string | true | Title for the credential to be displayed to PSU |
| required | boolean | true | Indication whether the credential is required |
| description | string | false | Description of the credential to be displayed to PSU |
| template | string | false | Perl compatible regular expression used for check of the credential format |
CredentialDto
{
"name": "string",
"title": "string",
"required": true,
"description": "string",
"template": "string",
"value": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | false | none |
| title | string | false | none |
| required | boolean | false | none |
| description | string | false | none |
| template | string | false | none |
| value | string | false | none |
CreditTransferTransaction
{
"instructedAmount": {
"currency": "string",
"amount": "string"
},
"paymentId": {
"instructionId": "string",
"endToEndId": "string"
},
"beneficiary": {
"creditorAccount": {
"identification": "string",
"schemeName": "string"
},
"creditor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"creditorAgent": {
"bicFi": "string",
"clearingSystemMemberId": {
"clearingSystemId": "string",
"memberId": "string"
},
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
},
"creditorCurrency": "string"
},
"regulatoryReporting": [
{
"authority": {
"country": "string",
"name": "string"
},
"details": {
"amount": {
"currency": "string",
"amount": "string"
},
"code": "string",
"information": "string"
}
}
],
"referenceNumber": "string",
"remittanceInformation": [
"string"
],
"requestedExecutionDate": "string",
"frequency": "WEEK"
}
Payment instructions to be executed by the ASPSP from the account chosen by debtor.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| instructedAmount | Amount | true | Amount of money to be reported. If not provided the total instructed amount of the transaction is assumed |
| paymentId | PaymentIdentification | false | Set of elements used to reference a payment instruction. |
| beneficiary | Beneficiary | false | Specification of a beneficiary. Required when payment settings for the payment type are not stored in the application. When payment settings for the payment type are stored in the application must not be provided. |
| regulatoryReporting | [RegulatoryReporting] | false | Information needed due to regulatory and statutory requirements. |
| referenceNumber | string | false | Structured reference to be assigned to a payment instruction. Reference number format depends on the chosen country and the payment type. Information on support of reference numbers is provided in the payment type information for each ASPSP. |
| remittanceInformation | [string] | false | Unstructured message to be assigned to a payment instruction. Number of supported lines and structure of each line depend on the payment type and the chosen ASPSP and is provided in the payment type information. In case values of both remittanceInformation and referenceNumber field are provided, the referenceNumber will be used. |
| requestedExecutionDate | string | false | Date at which the initiating party requests the clearing agent to process the payment. |
| frequency | string | false | Frequency rule for standing orders. However, each ASPSP might restrict these values into a subset |
Enumerated Values
| Property | Value |
|---|---|
| frequency | WEEK |
| frequency | TOWK |
| frequency | MNTH |
| frequency | TOMN |
| frequency | QUTR |
| frequency | SEMI |
| frequency | YEAR |
FinancialInstitutionIdentification
{
"bicFi": "string",
"clearingSystemMemberId": {
"clearingSystemId": "string",
"memberId": "string"
},
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
}
Unambiguous identification of the financial institution of the debtor to which a debit entry will be made as a result of the transaction
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| bicFi | string | false | Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)". |
| clearingSystemMemberId | ClearingSystemMemberIdentification | false | Information used to identify a member within a clearing system. Used for some specific domestic and cross-border credit transfers in order to identify the beneficiary bank. |
| name | string | false | Name of the financial institution. |
| postalAddress | PostalAddress | false | Information that locates and identifies a specific address. |
GetAccountBalancesResponse
{
"balances": [
{
"balanceAmount": {
"currency": "string",
"amount": "string"
},
"creditDebitIndicator": "CRDT",
"balanceType": "CLBD",
"referenceDate": "2019-08-24"
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| balances | [Balance] | true | List of account balances |
GetAccountTransactionsResponse
{
"transactions": [
{
"transactionAmount": {
"currency": "string",
"amount": "string"
},
"creditDebitIndicator": "CRDT",
"status": "string",
"entryReference": "string",
"remittanceInformation": [
"string"
],
"referenceNumber": "string",
"bookingDate": "2019-08-24",
"transactionDate": "2019-08-24",
"valueDate": "2019-08-24",
"creditor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"creditorAccount": {
"identification": "string",
"schemeName": "string"
},
"debtor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"debtorAccount": {
"identification": "string",
"schemeName": "string"
},
"merchantCategoryCode": "string"
}
],
"continuationKey": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| transactions | [Transaction] | true | List of account transactions |
| continuationKey | string | false | Value to retrieve next page of transactions. Null if there are no more pages. Only valid in current session. |
GetAccountsResult
{
"accounts": [
{
"accountId": "string",
"identificationHash": "string",
"identifications": [
{
"identification": "string",
"schemeName": "string"
}
],
"currency": "string",
"cashAccountType": "CACC",
"holder": "string",
"details": "string",
"product": "string"
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| accounts | [Account] | false | [List of accounts made available within the session] |
GetApplicationResponse
{
"active": true,
"description": "string",
"environment": "production",
"kid": "string",
"name": "string",
"redirectUris": [
"string"
],
"countries": [
"string"
],
"services": [
"string"
],
"paymentTypes": [
"DOMESTIC"
],
"applicationSettings": {
"skipPsuConsentScreen": true
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| active | boolean | true | Flag displaying whether application is active |
| description | string | true | Application description |
| environment | string | true | Application enviromnent |
| kid | string | true | Application key id |
| name | string | true | Application name |
| redirectUris | [string] | true | List of allowed redirect URIs |
| countries | [string] | true | List of allowed countries |
| services | [string] | true | List of allowed services (AIS/PIS) |
| paymentTypes | [string] | true | List of allowed paymentTypes |
| applicationSettings | ApplicationSettings | false | List of application related settings |
Enumerated Values
| Property | Value |
|---|---|
| environment | production |
| environment | sandbox |
GetAspspsResponse
{
"aspsps": [
{
"name": "string",
"country": "string",
"logo": "string",
"services": [
"string"
],
"psuTypes": [
"string"
],
"authMethods": [
{
"name": "string",
"title": "string",
"psuType": "string",
"credentials": [
{
"name": "string",
"title": "string",
"required": true,
"description": "string",
"template": "string"
}
],
"approach": "string",
"hiddenMethod": true
}
],
"paymentTypes": [
{
"name": "DOMESTIC",
"currencies": [
"string"
],
"debtorAccountRequired": true,
"debtorAccountSchemes": [
"string"
],
"debtorCurrencyRequired": true,
"creditorAccountSchemes": [
"string"
],
"creditorCountryRequired": true,
"creditorNameRequired": true,
"creditorPostalAddressRequired": true,
"creditorAgentBicFiRequired": true,
"remittanceInformationRequired": true,
"priorityCodes": [
"HIGH"
],
"chargeBearerCodes": [
"SLEV"
],
"allowedAuthMethods": [
"string"
],
"debtorContactEmailRequired": true,
"debtorContactPhoneRequired": true,
"creditorAgentClearingSystemMemberIdRequired": true,
"regulatoryReportingCodeRequired": true,
"regulatoryReportingCodes": [
{
"value": "string",
"description": "string"
}
],
"remittanceInformationLines": [
{
"minLength": 0,
"maxLength": 0,
"pattern": "string"
}
],
"referenceNumberSupported": true
}
],
"languages": [
"string"
]
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| aspsps | [AspspData] | true | List of available ASPSPs |
GetPaymentResponse
{
"payment": {
"creditTransferTransaction": [
{
"instructedAmount": {
"currency": "string",
"amount": "string"
},
"paymentId": {
"instructionId": "string",
"endToEndId": "string"
},
"beneficiary": {
"creditorAccount": {
"identification": "string",
"schemeName": "string"
},
"creditor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"creditorAgent": {
"bicFi": "string",
"clearingSystemMemberId": {
"clearingSystemId": "string",
"memberId": "string"
},
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
},
"creditorCurrency": "string"
},
"regulatoryReporting": [
{
"authority": {
"country": "string",
"name": "string"
},
"details": {
"amount": {
"currency": "string",
"amount": "string"
},
"code": "string",
"information": "string"
}
}
],
"referenceNumber": "string",
"remittanceInformation": [
"string"
],
"requestedExecutionDate": "string",
"frequency": "WEEK"
}
],
"debtor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"debtorAccount": {
"identification": "string",
"schemeName": "string"
},
"debtorAgent": {
"bicFi": "string",
"clearingSystemMemberId": {
"clearingSystemId": "string",
"memberId": "string"
},
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
},
"debtorCurrency": "string",
"chargeBearer": "SLEV",
"paymentTypeInformation": {
"instructionPriority": "HIGH",
"serviceLevel": "BKTR",
"categoryPurpose": "BONU",
"localInstrument": "string"
}
},
"paymentType": "DOMESTIC",
"paymentStatus": "ACCC",
"paymentStatusReason": {
"code": "string"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| payment | Payment | true | Payment data |
| paymentType | string | true | Type of the payment |
| paymentStatus | string | true | Specifies the status of the payment information group |
| paymentStatusReason | PaymentStatusReason | false | Provides detailed information on the status reason |
Enumerated Values
| Property | Value |
|---|---|
| paymentType | DOMESTIC |
| paymentType | SEPA |
| paymentType | CROSSBORDER |
| paymentType | DOMESTIC_SE_GIRO |
| paymentType | INST_SEPA |
| paymentType | BULK_SEPA |
| paymentType | INTERNAL |
| paymentStatus | ACCC |
| paymentStatus | ACCP |
| paymentStatus | ACSC |
| paymentStatus | ACSP |
| paymentStatus | ACTC |
| paymentStatus | ACWC |
| paymentStatus | ACWP |
| paymentStatus | PART |
| paymentStatus | RCVD |
| paymentStatus | PDNG |
| paymentStatus | RJCT |
| paymentStatus | ACPT |
| paymentStatus | ACCR |
| paymentStatus | RJCR |
| paymentStatus | PACR |
| paymentStatus | PDCR |
| paymentStatus | CNCL |
| paymentStatus | NULL |
GetSessionResponse
{
"status": "INVALID",
"aspsp": {
"name": "string",
"country": "string"
},
"accounts": [
{
"accountId": "string",
"identificationHash": "string",
"identifications": [
{
"identification": "string",
"schemeName": "string"
}
],
"currency": "string",
"cashAccountType": "CACC",
"holder": "string",
"details": "string",
"product": "string"
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| status | string | true | Current status of the session |
| aspsp | Aspsp | true | ASPSP in which the session was authorized |
| accounts | [Account] | true | List of accounts made available within the session |
Enumerated Values
| Property | Value |
|---|---|
| status | INVALID |
| status | PENDING_AUTHORIZATION |
| status | RETURNED_FROM_BANK |
| status | AUTHORIZED |
| status | CLOSED |
InitiatePaymentRequest
{
"paymentType": "DOMESTIC",
"payment": {
"creditTransferTransaction": [
{
"instructedAmount": {
"currency": "string",
"amount": "string"
},
"paymentId": {
"instructionId": "string",
"endToEndId": "string"
},
"beneficiary": {
"creditorAccount": {
"identification": "string",
"schemeName": "string"
},
"creditor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"creditorAgent": {
"bicFi": "string",
"clearingSystemMemberId": {
"clearingSystemId": "string",
"memberId": "string"
},
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
},
"creditorCurrency": "string"
},
"regulatoryReporting": [
{
"authority": {
"country": "string",
"name": "string"
},
"details": {
"amount": {
"currency": "string",
"amount": "string"
},
"code": "string",
"information": "string"
}
}
],
"referenceNumber": "string",
"remittanceInformation": [
"string"
],
"requestedExecutionDate": "string",
"frequency": "WEEK"
}
],
"debtor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"debtorAccount": {
"identification": "string",
"schemeName": "string"
},
"debtorAgent": {
"bicFi": "string",
"clearingSystemMemberId": {
"clearingSystemId": "string",
"memberId": "string"
},
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
},
"debtorCurrency": "string",
"chargeBearer": "SLEV",
"paymentTypeInformation": {
"instructionPriority": "HIGH",
"serviceLevel": "BKTR",
"categoryPurpose": "BONU",
"localInstrument": "string"
}
},
"aspsp": {
"name": "string",
"country": "string"
},
"psuType": "BUSINESS",
"redirectUri": "string",
"state": "string",
"authMethod": "string",
"credentials": {
"property1": "string",
"property2": "string"
},
"language": "string"
}
Data necessary for payment initiation
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| paymentType | string | true | Type of the payment being initiated |
| payment | Payment | true | Payment data |
| aspsp | Aspsp | true | ASPSP in which the session was authorized |
| psuType | string | true | PSU type which consent is created for |
| redirectUri | string | true | URL that PSU will be redirected to after authorization |
| state | string | true | Arbitrary string. Same string will be returned in query parameter when redirecting to the URL passed via redirect_url parameter |
| authMethod | string | false | Desired authorization method (in case ASPSP supports multiple). Supported methods are listed for each ASPSP in the authMethods |
| credentials | object | false | PSU credentials (User ID, company ID etc.) If not provided, then those are going to be asked from a PSU during authorization. Supported credentials provided for each ASPSP and its auth method |
| » additionalProperties | string | false | PSU credentials (User ID, company ID etc.) If not provided, then those are going to be asked from a PSU during authorization. Supported credentials provided for each ASPSP and its auth method |
| language | string | false | ISO 639-1 code of the preferred language when redirecting to an ASPSP |
Enumerated Values
| Property | Value |
|---|---|
| paymentType | DOMESTIC |
| paymentType | SEPA |
| paymentType | CROSSBORDER |
| paymentType | DOMESTIC_SE_GIRO |
| paymentType | INST_SEPA |
| paymentType | BULK_SEPA |
| paymentType | INTERNAL |
| psuType | BUSINESS |
| psuType | PERSONAL |
InitiatePaymentResponse
{
"paymentId": "string",
"confirmationUri": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| paymentId | string | true | An identifier for retrieving details of the payment or confirming it |
| confirmationUri | string | false | URL to be presented to the end user on which behalf the payment is being initiated |
PartyIdentification
{
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
}
Information about debtor necessary for execution of the payment. Required fields depend on the payment type and ASPSP executing the payment.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | false | Name by which a party is known and which is usually used to identify that party. |
| postalAddress | PostalAddress | false | Information that locates and identifies a specific address. |
| contactDetails | ContactDetails | false | Contact information of a party such as e-mail address and phone number. |
Payment
{
"creditTransferTransaction": [
{
"instructedAmount": {
"currency": "string",
"amount": "string"
},
"paymentId": {
"instructionId": "string",
"endToEndId": "string"
},
"beneficiary": {
"creditorAccount": {
"identification": "string",
"schemeName": "string"
},
"creditor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"creditorAgent": {
"bicFi": "string",
"clearingSystemMemberId": {
"clearingSystemId": "string",
"memberId": "string"
},
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
},
"creditorCurrency": "string"
},
"regulatoryReporting": [
{
"authority": {
"country": "string",
"name": "string"
},
"details": {
"amount": {
"currency": "string",
"amount": "string"
},
"code": "string",
"information": "string"
}
}
],
"referenceNumber": "string",
"remittanceInformation": [
"string"
],
"requestedExecutionDate": "string",
"frequency": "WEEK"
}
],
"debtor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"debtorAccount": {
"identification": "string",
"schemeName": "string"
},
"debtorAgent": {
"bicFi": "string",
"clearingSystemMemberId": {
"clearingSystemId": "string",
"memberId": "string"
},
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
},
"debtorCurrency": "string",
"chargeBearer": "SLEV",
"paymentTypeInformation": {
"instructionPriority": "HIGH",
"serviceLevel": "BKTR",
"categoryPurpose": "BONU",
"localInstrument": "string"
}
}
Payment data
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| creditTransferTransaction | [CreditTransferTransaction] | true | Payment instructions to be executed by the ASPSP from the account chosen by debtor. |
| debtor | PartyIdentification | false | Information about debtor necessary for execution of the payment. Required fields depend on the payment type and ASPSP executing the payment. |
| debtorAccount | AccountIdentification | false | Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction |
| debtorAgent | FinancialInstitutionIdentification | false | Unambiguous identification of the financial institution of the debtor to which a debit entry will be made as a result of the transaction |
| debtorCurrency | string | false | Debtor account currency code, as described in the standard ISO 4217 |
| chargeBearer | string | false | Specifies which party/parties will bear the charges associated with the processing of the payment transaction |
| paymentTypeInformation | PaymentTypeInformation | false | Set of elements used to further specify how the payment transaction should be executed. |
Enumerated Values
| Property | Value |
|---|---|
| chargeBearer | SLEV |
| chargeBearer | SHAR |
| chargeBearer | DEBT |
| chargeBearer | CRED |
PaymentIdentification
{
"instructionId": "string",
"endToEndId": "string"
}
Set of elements used to reference a payment instruction.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| instructionId | string | false | Unique identification shared between the PISP and the ASPSP |
| endToEndId | string | false | Unique identification shared between the merchant and the PSU |
PaymentStatusReason
{
"code": "string"
}
Provides detailed information on the status reason
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| code | string | false | Rejection codes accoring to ISO20022 |
PaymentType
{
"name": "DOMESTIC",
"currencies": [
"string"
],
"debtorAccountRequired": true,
"debtorAccountSchemes": [
"string"
],
"debtorCurrencyRequired": true,
"creditorAccountSchemes": [
"string"
],
"creditorCountryRequired": true,
"creditorNameRequired": true,
"creditorPostalAddressRequired": true,
"creditorAgentBicFiRequired": true,
"remittanceInformationRequired": true,
"priorityCodes": [
"HIGH"
],
"chargeBearerCodes": [
"SLEV"
],
"allowedAuthMethods": [
"string"
],
"debtorContactEmailRequired": true,
"debtorContactPhoneRequired": true,
"creditorAgentClearingSystemMemberIdRequired": true,
"regulatoryReportingCodeRequired": true,
"regulatoryReportingCodes": [
{
"value": "string",
"description": "string"
}
],
"remittanceInformationLines": [
{
"minLength": 0,
"maxLength": 0,
"pattern": "string"
}
],
"referenceNumberSupported": true
}
List of available payment types and their properties
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | true | Internal identifier of the payment type |
| currencies | [string] | true | List of supported currencies |
| debtorAccountRequired | boolean | true | States if debtor account is required during payment initiation request. |
| debtorAccountSchemes | [string] | true | List of supported debtor account schemes |
| debtorCurrencyRequired | boolean | true | States if debtor currency is required |
| creditorAccountSchemes | [string] | true | List of supported creditor account schemes |
| creditorCountryRequired | boolean | true | States if creditor country is required |
| creditorNameRequired | boolean | true | States if creditor name is required |
| creditorPostalAddressRequired | boolean | true | States if creditor structured postal address is required |
| creditorAgentBicFiRequired | boolean | true | States if creditor agent bicFi required |
| remittanceInformationRequired | boolean | true | States if remittance information is required |
| priorityCodes | [string] | false | List of supported priority codes |
| chargeBearerCodes | [string] | false | List of supported charge bearer codes |
| allowedAuthMethods | [string] | false | List of supported auth methods for this payment type |
| debtorContactEmailRequired | boolean | false | States if debtor's contact email is required when a payment this type is being initiated |
| debtorContactPhoneRequired | boolean | false | States if debtor's contact phone is required when a payment this type is being initiated |
| creditorAgentClearingSystemMemberIdRequired | boolean | false | States if creditor agent clearing system member ID is required |
| regulatoryReportingCodeRequired | boolean | false | States if regulatory reporting shall be provided for credit transfer transactions. |
| regulatoryReportingCodes | [RegulatoryReportingCode] | false | List of supported codes for regulatory reporting details |
| remittanceInformationLines | [RemittanceInformationLineInfo] | false | Properties of remittance information. Each item of the array correspond to the remittance information line with the same index. When provided, the number of lines in the remittance information should be the same as the length of this array. |
| referenceNumberSupported | boolean | false | States if reference numbers are supported for this payment type |
Enumerated Values
| Property | Value |
|---|---|
| name | DOMESTIC |
| name | SEPA |
| name | CROSSBORDER |
| name | DOMESTIC_SE_GIRO |
| name | INST_SEPA |
| name | BULK_SEPA |
| name | INTERNAL |
PaymentTypeInformation
{
"instructionPriority": "HIGH",
"serviceLevel": "BKTR",
"categoryPurpose": "BONU",
"localInstrument": "string"
}
Set of elements used to further specify how the payment transaction should be executed.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| instructionPriority | string | false | Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. |
| serviceLevel | string | false | Agreement under which or rules under which the transaction should be processed. Specifies a pre-agreed service or level of service between the parties, as published in an external service level code list. |
| categoryPurpose | string | false | Specifies the high level purpose of the instruction based on a set of pre-defined categories. This is used by the initiating party to provide information concerning the processing of the payment. It is likely to trigger special processing by any of the agents involved in the payment chain. |
| localInstrument | string | false | User community specific instrument. This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. |
Enumerated Values
| Property | Value |
|---|---|
| instructionPriority | HIGH |
| instructionPriority | NORM |
| instructionPriority | EXPR |
| serviceLevel | BKTR |
| serviceLevel | G001 |
| serviceLevel | G002 |
| serviceLevel | G003 |
| serviceLevel | G004 |
| serviceLevel | NUGP |
| serviceLevel | NURG |
| serviceLevel | PRPT |
| serviceLevel | SDVA |
| serviceLevel | SEPA |
| serviceLevel | SVDE |
| serviceLevel | URGP |
| serviceLevel | URNS |
| categoryPurpose | BONU |
| categoryPurpose | CASH |
| categoryPurpose | CBLK |
| categoryPurpose | CCRD |
| categoryPurpose | CORT |
| categoryPurpose | DCRD |
| categoryPurpose | DIVI |
| categoryPurpose | DVPM |
| categoryPurpose | EPAY |
| categoryPurpose | FCOL |
| categoryPurpose | GOVT |
| categoryPurpose | HEDG |
| categoryPurpose | ICCP |
| categoryPurpose | IDCP |
| categoryPurpose | INTC |
| categoryPurpose | INTE |
| categoryPurpose | LOAN |
| categoryPurpose | MP2B |
| categoryPurpose | MP2P |
| categoryPurpose | OTHR |
| categoryPurpose | PENS |
| categoryPurpose | RPRE |
| categoryPurpose | RRCT |
| categoryPurpose | RVPM |
| categoryPurpose | SALA |
| categoryPurpose | SECU |
| categoryPurpose | SSBE |
| categoryPurpose | SUPP |
| categoryPurpose | TAXS |
| categoryPurpose | TRAD |
| categoryPurpose | TREA |
| categoryPurpose | VATX |
| categoryPurpose | WHLD |
PostSessionRequest
{
"redirect_uri": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| redirect_uri | string | false | none |
PostalAddress
{
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
}
Information that locates and identifies a specific address.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| country | string | true | Two-letter country code |
| countrySubDivision | string | false | Identifies a subdivision of a country such as state, region, county. |
| townName | string | false | Name of a built-up area, with defined boundaries, and a local government |
| postCode | string | false | Information that locates and identifies delivery address |
| streetName | string | false | Name of a street or thoroughfare |
| buildingNumber | string | false | Number that identifies the position of a building on a street |
| department | string | false | Identification of a division of a large organisation or building |
| subDepartment | string | false | Identification of a sub-division of a large organisation or building |
RegulatoryAuthority
{
"country": "string",
"name": "string"
}
Regulatory authority to which reporting shall be made.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| country | string | false | Country in which the regulatory authority operates |
| name | string | true | Name of the regulatory authority |
RegulatoryReporting
{
"authority": {
"country": "string",
"name": "string"
},
"details": {
"amount": {
"currency": "string",
"amount": "string"
},
"code": "string",
"information": "string"
}
}
Information needed due to regulatory and statutory requirements.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| authority | RegulatoryAuthority | false | Regulatory authority to which reporting shall be made. |
| details | RegulatoryReportingDetails | true | Details to provide on the regulatory reporting information. |
RegulatoryReportingCode
{
"value": "string",
"description": "string"
}
List of supported codes for regulatory reporting details
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| value | string | true | Value of the code, i.e. what needs to be passed as a code when filling in regulatory reporting details |
| description | string | false | Regulatory authority to which reporting shall be made |
RegulatoryReportingDetails
{
"amount": {
"currency": "string",
"amount": "string"
},
"code": "string",
"information": "string"
}
Details to provide on the regulatory reporting information.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| amount | Amount | false | Amount of money to be reported. If not provided the total instructed amount of the transaction is assumed |
| code | string | false | A code specifying the nature, purpose, and/or reason for the transaction. Codes to be used depend on the regulatory authority, to which they are being reported |
| information | string | false | Additional details that cater for specific domestic regulatory requirements |
RemittanceInformationLineInfo
{
"minLength": 0,
"maxLength": 0,
"pattern": "string"
}
Properties of remittance information. Each item of the array correspond to the remittance information line with the same index. When provided, the number of lines in the remittance information should be the same as the length of this array.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| minLength | integer(int32) | true | Minimum possible length of the remittance information line |
| maxLength | integer(int32) | true | Maximum possible length of the remittance information line |
| pattern | string | false | Perl compatible regular expression used for check of the remittance information line format |
StartAuthorizationRequest
{
"access": {
"accounts": [
{
"identification": "string",
"schemeName": "string"
}
],
"balances": true,
"transactions": true,
"validUntil": "string"
},
"aspsp": {
"name": "string",
"country": "string"
},
"psuType": "BUSINESS",
"redirectUri": "string",
"state": "string",
"authMethod": "string",
"credentials": {
"property1": "string",
"property2": "string"
},
"language": "string"
}
Data necessary for starting end user authorization and account information consent
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| access | Access | true | Scope of access requested from ASPSP and confirmed by PSU |
| aspsp | Aspsp | true | ASPSP in which the session was authorized |
| psuType | string | true | PSU type which consent is created for |
| redirectUri | string | true | URL that PSU will be redirected to after authorization |
| state | string | true | Arbitrary string. Same string will be returned in query parameter when redirecting to the URL passed via redirectUri parameter |
| authMethod | string | false | Desired authorization method (in case ASPSP supports multiple). Supported methods are listed for each ASPSP in the authMethods |
| credentials | object | false | PSU credentials (User ID, company ID etc.) If not provided, then those are going to be asked from a PSU during authorization. Supported credentials provided for each ASPSP and its auth method |
| » additionalProperties | string | false | PSU credentials (User ID, company ID etc.) If not provided, then those are going to be asked from a PSU during authorization. Supported credentials provided for each ASPSP and its auth method |
| language | string | false | ISO 639-1 code of the preferred language when redirecting to an ASPSP |
Enumerated Values
| Property | Value |
|---|---|
| psuType | BUSINESS |
| psuType | PERSONAL |
StartAuthorizationResponse
{
"authorizationUri": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| authorizationUri | string | false | URL to be presented to the end user being authorized |
Transaction
{
"transactionAmount": {
"currency": "string",
"amount": "string"
},
"creditDebitIndicator": "CRDT",
"status": "string",
"entryReference": "string",
"remittanceInformation": [
"string"
],
"referenceNumber": "string",
"bookingDate": "2019-08-24",
"transactionDate": "2019-08-24",
"valueDate": "2019-08-24",
"creditor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"creditorAccount": {
"identification": "string",
"schemeName": "string"
},
"debtor": {
"name": "string",
"postalAddress": {
"country": "string",
"countrySubDivision": "string",
"townName": "string",
"postCode": "string",
"streetName": "string",
"buildingNumber": "string",
"department": "string",
"subDepartment": "string"
},
"contactDetails": {
"emailAddress": "string",
"phoneNumber": "string"
}
},
"debtorAccount": {
"identification": "string",
"schemeName": "string"
},
"merchantCategoryCode": "string"
}
List of account transactions
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| transactionAmount | Amount | true | Amount of money to be reported. If not provided the total instructed amount of the transaction is assumed |
| creditDebitIndicator | string | true | Accounting flow of the transaction |
| status | string | true | Indicates a state that the transaction is currently in |
| entryReference | string | true | Unique transaction identifier provided by ASPSP. This identifier is both unique and immutable and can be used for matching transactions across multiple PSU authentication sessions. Usually the same identifier is available for transactions in ASPSP's online/mobile interface and is called archive ID or similarly. |
| remittanceInformation | [string] | true | Payment details. For credit transfers may contain free text, reference number or both at the same time (in case Extended Remittance Information is supported). When it is known that remittance information contains a reference number (either based on ISO 11649 or a local scheme), the reference number is also available via the reference_number field. |
| referenceNumber | string | false | Credit transfer reference number (also known as the creditor reference or the structured creditor reference). The value is set when it is known that the transaction data contains a reference number (in either ISO 11649 or a local format). |
| bookingDate | string(date) | false | Booking date of the transaction on the account |
| transactionDate | string(date) | false | Date used for specific purposes: - for card transaction: date of the transaction; - for credit transfer: acquiring date of the transaction; - for direct debit: receiving date of the transaction |
| valueDate | string(date) | false | Value date of the transaction on the account |
| creditor | PartyIdentification | false | Information about debtor necessary for execution of the payment. Required fields depend on the payment type and ASPSP executing the payment. |
| creditorAccount | AccountIdentification | false | Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction |
| debtor | PartyIdentification | false | Information about debtor necessary for execution of the payment. Required fields depend on the payment type and ASPSP executing the payment. |
| debtorAccount | AccountIdentification | false | Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction |
| merchantCategoryCode | string | false | Merchant Category Code in case transaction made using a card. Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction |
Enumerated Values
| Property | Value |
|---|---|
| creditDebitIndicator | CRDT |
| creditDebitIndicator | DBIT |