{"openapi":"3.0.0","info":{"description":"","title":"Balances AIS","version":"4.0.13","x-api-id":"7a4ce71f-805f-4894-8f21-da1742378419","x-ibm-name":"balances-ais"},"servers":[{"url":"https://api.rabobank.nl/openapi/payments/account-information/ais","description":"Production server"},{"url":"https://api-sandbox.rabobank.nl/openapi/sandbox/payments/account-information/ais","description":"Sandbox server"}],"paths":{"/accounts/{account-id}/balances":{"get":{"parameters":[{"description":"This identification is denoting the addressed account.\nThe account-id is retrieved by using a \"Read Account List\" call.\nThe account-id is the \"id\" attribute of the account structure.\nIts value is constant throughout the lifecycle of a given consent.\n","example":"Tkw4MlJBQk8xMTA4MDAzMDAxOkVVUg","in":"path","name":"account-id","required":true,"schema":{"type":"string"}},{"description":"Public certificate of the Initiating Party that corresponds with the signature made by the Initiating Party.","example":"MIIDkDCCAnigAwIBAgIEWs3AJDANBgkqhkiG9w0BAQsFADCBiTELMAkGA1UEBhMCTkwxEDAOBgNVBAgMB1V0cmVjaHQxEDAOBgNVBAcMB1V0cmVjaHQxETAPBgNVBAoMCFJhYm9iYW5rMRwwGgYDVQQLDBNPbmxpbmUgVHJhbnNhY3Rpb25zMSUwIwYDVQQDDBxQU0QyIEFQSSBQSSBTZXJ2aWNlcyBTYW5kYm94MB4XDTE4MDQxMTA3NTgyOFoXDTIzMDQxMTA3NTgyOFowgYkxCzAJBgNVBAYTAk5MMRAwDgYDVQQIDAdVdHJlY2h0MRAwDgYDVQQHDAdVdHJlY2h0MREwDwYDVQQKDAhSYWJvYmFuazEcMBoGA1UECwwTT25saW5lIFRyYW5zYWN0aW9uczElMCMGA1UEAwwcUFNEMiBBUEkgUEkgU2VydmljZXMgU2FuZGJveDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANoAjqGWUgCIm2F+0sBSEwLal+T3u+uldLikpxHCB8iL1GD7FrRjcA+MVsxhvHly7vRsHK+tQyMSaeK782RHpY33qxPLc8LmoQLb2EuiQxXj9POYkYBQ74qkrZnvKVlR3WoyQWeDOXnSY2wbNFfkP8ET4ElwyuIIEriwYhab0OIrnnrO8X82/SPZxHwEd3aQjQ6uhiw8paDspJbS5WjEfuwY16KVVUYlhbtAwGjvc6aK0NBm+LH9fMLpAE6gfGZNy0gzMDorVNbkQK1IoAGD8p9ZHdB0F3FwkILEjUiQW6nK+/fKDNJ0TBbpgZUpY8bR460qzxKdeZ1yPDqX2Cjh6fkCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAYL4iD6noMJAt63kDED4RB2mII/lssvHhcxuDpOm3Ims9urubFWEpvV5TgIBAxy9PBinOdjhO1kGJJnYi7F1jv1qnZwTV1JhYbvxv3+vk0jaiu7Ew7G3ASlzruXyMhN6t6jk9MpaWGl5Uw1T+gNRUcWQRR44g3ahQRIS/UHkaV+vcpOa8j186/1X0ULHfbcVQk4LMmJeXqNs8sBAUdKU/c6ssvj8jfJ4SfrurcBhY5UBTOdQOXTPY85aU3iFloerx7Oi9EHewxInOrU5XzqqTz2AQPXezexVeAQxP27lzqCmYC7CFiam6QBr06VebkmnPLfs76n8CDc1cwE6gUl0rMA==","in":"header","name":"TPP-Signature-Certificate","required":true,"schema":{"format":"byte","type":"string"}},{"description":"The IP Address header field consists of the IP Address value as supplied by the PSU to the TPP in the HTTP request. \nThe IP Address field value should only be provided if the request is initiated by the PSU.\nFor more information, read the Introduction page.\n","example":"34.118.239.68","in":"header","name":"PSU-IP-Address","required":false,"schema":{"type":"string"}},{"description":"ID of the request, unique to the call, as determined by the initiating party. Format is UUID v4.","example":"95126d8f-ae9d-4ac3-ac9e-c357dcd78811","in":"header","name":"X-Request-ID","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The digest is a base64 encoded hash of the body (SHA-512 or SHA-256 is allowed).","example":"sha-512=z4PhNX7vL3xVChQ1m2AB9YgAULVxXcg/SpINs6c5H0NE8XYXysP+DGNKfuwvY7kxvdBeoGlODJ6+SfaPg==","in":"header","name":"Digest","required":true,"schema":{"type":"string"}},{"description":"Signature is made up of the headers - date, digest and x-request-id. For more information see additional documentation in portal..","example":"keyId=\"1523433508\",algorithm=\"rsa-sha512\",headers=\"date digest x-request-id\",signature=\"t7b3deOMrTmOs+mjuY43mMcgpttrIWrkEGRmdEXaiurqrl0BO9hPOk4k+7OKmPWbxqE8nBFFSVSDU7+t84cUdjB3VTsl94rPuPVj/4XKwrqzKcmPHQHZ87ENPHWSFEDuOnub0FrJ4pUImsZpbenkZX+I80MElJQ337jp904JzyA+WKi7SzPjgGTUGlujhRUu3kU4TDNkcLIaBrcok9mXFlJSZQuNaaKfz4kqeaBpG2p3ZjcICnuE1aYFu5VZoniJd3Bi3n0ygVyb/9BaGHYMYvDvKHHtw6So8YGTTO+LnLZmOTgjXKhDIdBOgtJ4PWxvrp0Iid/YaM+BHqZPu4N1bw==\"","in":"header","name":"Signature","required":true,"schema":{"type":"string"}},{"description":"Date header as described in RFC-2616 section 3.3.1.","example":"Tue, 13 Sep 2022 09:51:01 GMT","in":"header","name":"Date","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/readBalanceResponse-200"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_AIS"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_AIS"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_AIS"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_AIS"}}},"description":"Not found"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_AIS"}}},"description":"Method Not Allowed"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_AIS"}}},"description":"Not Acceptable"},"408":{"description":"Request Timeout"},"415":{"description":"Unsupported Media Type"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_AIS"}}},"description":"Too Many Requests"},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable"}},"description":"Delivers the actual and Interim Booked Balance for a specific consented payment account.","operationId":"getBalances","summary":"Read balance"}}},"components":{"parameters":{"Date":{"description":"Date header as described in RFC-2616 section 3.3.1.","example":"Tue, 13 Sep 2022 09:51:01 GMT","in":"header","name":"Date","required":true,"schema":{"type":"string"}},"Digest":{"description":"The digest is a base64 encoded hash of the body (SHA-512 or SHA-256 is allowed).","example":"sha-512=z4PhNX7vL3xVChQ1m2AB9YgAULVxXcg/SpINs6c5H0NE8XYXysP+DGNKfuwvY7kxvdBeoGlODJ6+SfaPg==","in":"header","name":"Digest","required":true,"schema":{"type":"string"}},"PSU-IP-Address":{"description":"The IP Address header field consists of the IP Address value as supplied by the PSU to the TPP in the HTTP request. \nThe IP Address field value should only be provided if the request is initiated by the PSU.\nFor more information, read the Introduction page.\n","example":"34.118.239.68","in":"header","name":"PSU-IP-Address","required":false,"schema":{"type":"string"}},"Signature":{"description":"Signature is made up of the headers - date, digest and x-request-id. For more information see additional documentation in portal..","example":"keyId=\"1523433508\",algorithm=\"rsa-sha512\",headers=\"date digest x-request-id\",signature=\"t7b3deOMrTmOs+mjuY43mMcgpttrIWrkEGRmdEXaiurqrl0BO9hPOk4k+7OKmPWbxqE8nBFFSVSDU7+t84cUdjB3VTsl94rPuPVj/4XKwrqzKcmPHQHZ87ENPHWSFEDuOnub0FrJ4pUImsZpbenkZX+I80MElJQ337jp904JzyA+WKi7SzPjgGTUGlujhRUu3kU4TDNkcLIaBrcok9mXFlJSZQuNaaKfz4kqeaBpG2p3ZjcICnuE1aYFu5VZoniJd3Bi3n0ygVyb/9BaGHYMYvDvKHHtw6So8YGTTO+LnLZmOTgjXKhDIdBOgtJ4PWxvrp0Iid/YaM+BHqZPu4N1bw==\"","in":"header","name":"Signature","required":true,"schema":{"type":"string"}},"TPP-Signature-Certificate":{"description":"Public certificate of the Initiating Party that corresponds with the signature made by the Initiating Party.","example":"MIIDkDCCAnigAwIBAgIEWs3AJDANBgkqhkiG9w0BAQsFADCBiTELMAkGA1UEBhMCTkwxEDAOBgNVBAgMB1V0cmVjaHQxEDAOBgNVBAcMB1V0cmVjaHQxETAPBgNVBAoMCFJhYm9iYW5rMRwwGgYDVQQLDBNPbmxpbmUgVHJhbnNhY3Rpb25zMSUwIwYDVQQDDBxQU0QyIEFQSSBQSSBTZXJ2aWNlcyBTYW5kYm94MB4XDTE4MDQxMTA3NTgyOFoXDTIzMDQxMTA3NTgyOFowgYkxCzAJBgNVBAYTAk5MMRAwDgYDVQQIDAdVdHJlY2h0MRAwDgYDVQQHDAdVdHJlY2h0MREwDwYDVQQKDAhSYWJvYmFuazEcMBoGA1UECwwTT25saW5lIFRyYW5zYWN0aW9uczElMCMGA1UEAwwcUFNEMiBBUEkgUEkgU2VydmljZXMgU2FuZGJveDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANoAjqGWUgCIm2F+0sBSEwLal+T3u+uldLikpxHCB8iL1GD7FrRjcA+MVsxhvHly7vRsHK+tQyMSaeK782RHpY33qxPLc8LmoQLb2EuiQxXj9POYkYBQ74qkrZnvKVlR3WoyQWeDOXnSY2wbNFfkP8ET4ElwyuIIEriwYhab0OIrnnrO8X82/SPZxHwEd3aQjQ6uhiw8paDspJbS5WjEfuwY16KVVUYlhbtAwGjvc6aK0NBm+LH9fMLpAE6gfGZNy0gzMDorVNbkQK1IoAGD8p9ZHdB0F3FwkILEjUiQW6nK+/fKDNJ0TBbpgZUpY8bR460qzxKdeZ1yPDqX2Cjh6fkCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAYL4iD6noMJAt63kDED4RB2mII/lssvHhcxuDpOm3Ims9urubFWEpvV5TgIBAxy9PBinOdjhO1kGJJnYi7F1jv1qnZwTV1JhYbvxv3+vk0jaiu7Ew7G3ASlzruXyMhN6t6jk9MpaWGl5Uw1T+gNRUcWQRR44g3ahQRIS/UHkaV+vcpOa8j186/1X0ULHfbcVQk4LMmJeXqNs8sBAUdKU/c6ssvj8jfJ4SfrurcBhY5UBTOdQOXTPY85aU3iFloerx7Oi9EHewxInOrU5XzqqTz2AQPXezexVeAQxP27lzqCmYC7CFiam6QBr06VebkmnPLfs76n8CDc1cwE6gUl0rMA==","in":"header","name":"TPP-Signature-Certificate","required":true,"schema":{"format":"byte","type":"string"}},"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party. Format is UUID v4.","example":"95126d8f-ae9d-4ac3-ac9e-c357dcd78811","in":"header","name":"X-Request-ID","required":true,"schema":{"format":"uuid","type":"string"}},"account-id":{"description":"This identification is denoting the addressed account.\nThe account-id is retrieved by using a \"Read Account List\" call.\nThe account-id is the \"id\" attribute of the account structure.\nIts value is constant throughout the lifecycle of a given consent.\n","example":"Tkw4MlJBQk8xMTA4MDAzMDAxOkVVUg","in":"path","name":"account-id","required":true,"schema":{"type":"string"}}},"schemas":{"_linksAll":{"additionalProperties":{"$ref":"#/components/schemas/hrefType"},"description":"A _link object with all available link types.\n","properties":{"account":{"$ref":"#/components/schemas/hrefType"},"balances":{"$ref":"#/components/schemas/hrefType"},"download":{"$ref":"#/components/schemas/hrefType"},"first":{"$ref":"#/components/schemas/hrefType"},"last":{"$ref":"#/components/schemas/hrefType"},"next":{"$ref":"#/components/schemas/hrefType"},"previous":{"$ref":"#/components/schemas/hrefType"},"scaStatus":{"$ref":"#/components/schemas/hrefType"},"self":{"$ref":"#/components/schemas/hrefType"},"status":{"$ref":"#/components/schemas/hrefType"},"transactionDetails":{"$ref":"#/components/schemas/hrefType"},"transactions":{"$ref":"#/components/schemas/hrefType"}},"type":"object"},"accountReferenceIban":{"description":"Reference to an account by the Primary Account Number (PAN) of a card,\ncan be tokenised by the ASPSP due to PCI DSS requirements.\n","properties":{"currency":{"$ref":"#/components/schemas/currencyCode"},"iban":{"$ref":"#/components/schemas/iban"}},"required":["iban"],"type":"object"},"amount":{"example":{"amount":"123","currency":"EUR"},"properties":{"amount":{"$ref":"#/components/schemas/amountValue"},"currency":{"$ref":"#/components/schemas/currencyCode"}},"required":["amount","currency"],"type":"object"},"amountValue":{"description":"The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n\n\n  * 1056\n\n  * 5768.2\n\n  * -1.50\n\n  * 5877.78\n","example":"5877.78","pattern":"-?[0-9]{1,14}(\\.[0-9]{1,3})?","type":"string"},"balance":{"description":"A single balance element","properties":{"balanceAmount":{"$ref":"#/components/schemas/amount"},"balanceType":{"$ref":"#/components/schemas/balanceType"},"lastChangeDateTime":{"example":"2018-09-27T10:10:06.000Z","format":"date-time","type":"string"}},"required":["balanceAmount","balanceType"],"type":"object"},"balanceList":{"description":"A list of balances regarding this account containing the expected balance and interim booked balance.\n","items":{"$ref":"#/components/schemas/balance"},"type":"array"},"balanceType":{"enum":["expected","interimBooked"],"example":"expected","type":"string"},"currencyCode":{"description":"ISO 4217 Alpha 3 currency code","example":"EUR","pattern":"[A-Z]{3}","type":"string"},"errorInformationCode":{"description":"Message code to explain the nature of the underlying error","enum":["SESSIONS_NOT_SUPPORTED","ACCESS_EXCEEDED","REQUESTED_FORMATS_INVALID","CERTIFICATE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKED","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","FORMAT_ERROR","PARAMETER_NOT_SUPPORTED","PSU_CREDENTIALS_INVALID","SERVICE_INVALID","SERVICE_BLOCKED","CORPORATE_ID_INVALID","CONSENT_UNKNOWN","CONSENT_INVALID","CONSENT_EXPIRED","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN"],"example":"CERTIFICATE_INVALID","type":"string"},"error_AIS":{"description":"Standardised definition of reporting error information according to [RFC7807]","properties":{"_links":{"$ref":"#/components/schemas/_linksAll"},"additionalErrors":{"description":"Array of Error Information Blocks.\nMight be used if more than one error is to be communicated\n","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","properties":{"code":{"$ref":"#/components/schemas/errorInformationCode"},"detail":{"$ref":"#/components/schemas/tppErrorDetail"},"title":{"$ref":"#/components/schemas/tppErrorTitle"}},"required":["code"],"type":"object"},"type":"array"},"code":{"$ref":"#/components/schemas/errorInformationCode"},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\n","maxLength":512,"type":"string"},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","maxLength":70,"type":"string"},"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n","format":"uri","maxLength":70,"type":"string"}},"required":["code","type"],"type":"object"},"hrefEntry":{"description":"Link to a resource.","example":"/accounts/3fdhzart4fsadsdfg45hdgh/balance","type":"string"},"hrefType":{"description":"Link to a resource.","properties":{"href":{"$ref":"#/components/schemas/hrefEntry"}},"type":"object"},"iban":{"description":"IBAN of an account","example":"NL05RABO0812836782","pattern":"[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}","type":"string"},"readBalanceResponse-200":{"description":"Body of the response for a successful read balance request.","properties":{"account":{"$ref":"#/components/schemas/accountReferenceIban"},"balances":{"$ref":"#/components/schemas/balanceList"}},"required":["balances"],"type":"object"},"tppErrorDetail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\n","maxLength":500,"type":"string"},"tppErrorTitle":{"description":"Short  description of error type.\n","maxLength":70,"type":"string"}},"securitySchemes":{"clientId":{"description":"ClientId as provided by the Rabobank developer portal.","in":"header","name":"X-IBM-Client-Id","type":"apiKey"},"oauth2_access_code_flow_balances-ais":{"description":"NOTE Please use the Authorization and Token URL as provided by the oAuth2 Services","flows":{"authorizationCode":{"authorizationUrl":"https://oauth.rabobank.nl/openapi/oauth2/authorize","scopes":{"ais.balances.read":"Allows the retrieval of the current balance of an account."},"tokenUrl":"https://oauth.rabobank.nl/openapi/oauth2/token"}},"type":"oauth2","x-ibm-oauth-provider":"oauth2-services-3-0-2-de4b"}}},"security":[{"clientId":[],"oauth2_access_code_flow_balances-ais":["ais.balances.read"]}],"x-readme":{"explorer-enabled":false,"proxy-enabled":false}}