A streamlined service for real-time verification of account balances.
Funds Confirmation Service
A streamlined service for real-time verification of account balances.
Get authorisation sub-resources request
Will deliver an array of resource identifications of all generated authorisation sub-resources.
/piis/{apiGroupVersion}/consents/funds-confirmations/{consent-id}/authorisations
RESPONSES
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
Responses
200
400
401
403
404
405
406
415
429
{
"Valid Response": {
"value": {
"authorisationsIds": [
123321
]
}
}
}Start authorisation process
Starts an authorisation process in for establishing account information consent data on the server.
/piis/{apiGroupVersion}/consents/funds-confirmations/{consent-id}/authorisations
RESPONSES
201
Created
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
Responses
201
400
401
403
404
405
406
415
429
{
"Valid Response": {
"value": {
"scaStatus": "received",
"_links": {
"scaRedirect": {
"href": "https://bank.com/sca"
}
}
}
}
}Get Funds Confirmation Consent Request
Returns the content of an funds confirmation consent object.
/piis/{apiGroupVersion}/consents/funds-confirmations/{consent-id}
RESPONSES
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
Responses
200
400
401
403
404
405
406
415
429
{
"Valid Request": {
"value": {
"access": {
"payments": [
{
"account": {
"iban": "XX80BANK0000435195001",
"currency": "EUR"
},
"rights": [
"fundsConfirmations"
]
}
]
},
"consentType": "detailed",
"recurringIndicator": true,
"validTo": "12.12.2012",
"consentStatus": "valid"
}
}
}Delete an Confirmation of Funds Service Object
The TPP can delete a confirmation of funds consent object.
/piis/{apiGroupVersion}/consents/funds-confirmations/{consent-id}
RESPONSES
204
No Content
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
Responses
204
400
401
403
404
405
406
415
429
Get Status Request
Can check the status of an funds confirmation consent resource.
/piis/{apiGroupVersion}/consents/funds-confirmations/{consent-id}/status
RESPONSES
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
Responses
200
400
401
403
404
405
406
415
429
{
"Valid Response": {
"value": {
"consentStatus": "received"
}
}
}Get SCA status request
Checks the SCA status of a authorisation sub-resource.
/piis/{apiGroupVersion}/consents/funds-confirmations/{consent-id}/authorisations/{authorisation-id}
RESPONSES
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
Responses
200
400
401
403
404
405
406
415
429
{
"Valid Response": {
"value": {
"scaStatus": "received",
"_links": {
"scaRedirect": {
"href": "https://bank.com/sca"
}
}
}
}
}Confirmation of Funds Request
Creates a confirmation of funds request at the ASPSP. If no card number, but the PSU account identifier is contained: check on default account registered by customer. If no card number but the PSU and the account identifier with currency is contained: check the availability of funds on the corresponding sub-account. If card number and the PSU account identifier is contained:: check on sub-account addressed by card, if the addressed card is registered with one of the sub-accounts. If the card number is not registered for any of the accounts, the card number is ignored.
/piis/{apiGroupVersion}/funds-confirmations
RESPONSES
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
{
"cardNumber": "123123123213",
"account": {
"iban": "XX80BANK0000435195001",
"currency": "EUR"
},
"payee": "customer name",
"instructedAmount": {
"currency": "EUR",
"amount": "12.32"
}
}Responses
200
400
401
403
404
405
406
415
429
{
"Valid Request": {
"value": {
"fundsAvailable": true
}
}
}Establish Funds Confirmation Consent Transaction
Creates an funds confirmation consent resource at the ASPSP regarding access to make funds confirmation to specified accounts in this request.
/piis/{apiGroupVersion}/consents/funds-confirmations
RESPONSES
201
Created
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
Request
{
"access": {
"payments": [
{
"account": {
"iban": "XX80BANK0000435195001",
"currency": "EUR"
},
"rights": [
"fundsConfirmations"
]
}
]
},
"consentType": "detailed",
"recurringIndicator": true,
"validTo": "2017-10-30"
}Responses
201
400
401
403
404
405
406
415
429
{
"Valid Request": {
"value": {
"access": {
"payments": [
{
"account": {
"iban": "XX80BANK0000435195001",
"currency": "EUR"
},
"rights": [
"fundsConfirmations"
]
}
]
},
"consentType": "detailed",
"recurringIndicator": true,
"validTo": "12.12.2012",
"consentStatus": "received",
"_links": {
"scaRedirect": {
"href": "https://bank.com/sca"
}
}
}
}
}