{"openapi":"3.0.0","info":{"description":"","title":"Business-Account-Insight-Balances","version":"1.1.37","x-api-id":"192e4b71-e222-4074-b6f6-27d5613973d3","x-ibm-name":"business-account-insight-balances"},"servers":[{"url":"https://api.rabobank.nl/openapi/payments/insight","description":"Production server"},{"url":"https://api-sandbox.rabobank.nl/openapi/sandbox/payments/insight","description":"Sandbox server"}],"paths":{"/accounts/{account-id}/balances":{"get":{"parameters":[{"description":"This is the internal id of the particular IBAN and present in the response of the Read Account List call. Its value is constant throughout the lifecycle of a given consent.","example":"Wp-xhZMGEWRIIgVjPwTC1aKJJ0VCRZ_4bScUVXof7e0 AND hBS4MQ0Oc4LLJRiUiE_R94_-zoU4B2vwnPkXmsGh_b","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":"Signature-Certificate","required":false,"schema":{"format":"byte","type":"string"}},{"description":"ID of the request, unique to the call, as determined by the initiating party.","example":"594d27d0-26d7-47dc-9d62-c307616220b6","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=z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+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=\"ckfJsOBu3DRPVQzqIpwte8tUMxg6Mb6ThuA7hH3LuvZtjr8DS4OIKCRPTuC0IgyoCsUciD4CIa2hOWTZHf5tdQsXpruyem7GldFUA2zQFErC9wtAFxGSRs4f+sIKiX5knY//snxlq7xrZVtLc/jqBOBvy/X771SE2GIjtODVO3dcjXR5lnFIc+7uQBSXji9q13JhdJrkNJQt+XlbE0Z5FDTWsu1ZfLa+5Ky7S7+RGANyI02nCekHYc3Un8qdv3g46zw1TubL+HtZyao9mUor576jGiI/gBu9in/IXbZ7typ9kaAmN9iNR1Cw/9sbPJUtydTt1TWn0JWifPtr/+FjBQ==\"","in":"header","name":"Signature","required":true,"schema":{"type":"string"}},{"description":"Standard https header element with date, time and timezone.","example":"Tue, 15 Nov 2020 08:12:31 GMT","in":"header","name":"Date","required":true,"schema":{"type":"string"}},{"description":"Reference date to receive historical closingBooked balances from yesterday up to 15 months in the past.","example":"2024-10-30","in":"query","name":"closingBookedReferenceDate","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/balanceResponse"}}},"description":"OK","headers":{"X-RateLimit-Limit":{"description":"Maximum number of allowed requests","schema":{"type":"string"},"x-example":"100"},"X-RateLimit-Remaining":{"description":"Remaining count","schema":{"type":"string"},"x-example":"44"},"X-RateLimit-Reset":{"description":"Expiry time in seconds","schema":{"type":"string"},"x-example":"10"},"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","schema":{"format":"uuid","type":"string"},"x-example":"594d27d0-26d7-47dc-9d62-c307616220b6"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tppMessages"}}},"description":"Bad Request","headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","schema":{"format":"uuid","type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tppMessages"}}},"description":"Unauthorized","headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","schema":{"format":"uuid","type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tppMessages"}}},"description":"Forbidden","headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","schema":{"format":"uuid","type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tppMessages"}}},"description":"Not found","headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","schema":{"format":"uuid","type":"string"}}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tppMessages"}}},"description":"Method Not Allowed","headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","schema":{"format":"uuid","type":"string"}}}},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tppMessages"}}},"description":"Not Acceptable","headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","schema":{"format":"uuid","type":"string"}}}},"408":{"description":"Request Timeout","headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","schema":{"format":"uuid","type":"string"}}}},"415":{"description":"Unsupported Media Type","headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","schema":{"format":"uuid","type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tppMessages"}}},"description":"Too Many Requests","headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","schema":{"format":"uuid","type":"string"}}}},"500":{"description":"Internal Server Error","headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","schema":{"format":"uuid","type":"string"}}}},"503":{"description":"Service Unavailable","headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","schema":{"format":"uuid","type":"string"}}}}},"description":"Delivers the actual and Interim Booked Balance and end of day balance for a specific consented payment account and delivers the actual and end of day balance for a specific consented saving account.","operationId":"getBalances","summary":"Read balance"}}},"components":{"parameters":{"Date":{"description":"Standard https header element with date, time and timezone.","example":"Tue, 15 Nov 2020 08:12:31 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=z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg==","in":"header","name":"Digest","required":true,"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=\"ckfJsOBu3DRPVQzqIpwte8tUMxg6Mb6ThuA7hH3LuvZtjr8DS4OIKCRPTuC0IgyoCsUciD4CIa2hOWTZHf5tdQsXpruyem7GldFUA2zQFErC9wtAFxGSRs4f+sIKiX5knY//snxlq7xrZVtLc/jqBOBvy/X771SE2GIjtODVO3dcjXR5lnFIc+7uQBSXji9q13JhdJrkNJQt+XlbE0Z5FDTWsu1ZfLa+5Ky7S7+RGANyI02nCekHYc3Un8qdv3g46zw1TubL+HtZyao9mUor576jGiI/gBu9in/IXbZ7typ9kaAmN9iNR1Cw/9sbPJUtydTt1TWn0JWifPtr/+FjBQ==\"","in":"header","name":"Signature","required":true,"schema":{"type":"string"}},"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":"Signature-Certificate","required":false,"schema":{"format":"byte","type":"string"}},"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","example":"594d27d0-26d7-47dc-9d62-c307616220b6","in":"header","name":"X-Request-ID","required":true,"schema":{"format":"uuid","type":"string"}},"account-id":{"description":"This is the internal id of the particular IBAN and present in the response of the Read Account List call. Its value is constant throughout the lifecycle of a given consent.","example":"Wp-xhZMGEWRIIgVjPwTC1aKJJ0VCRZ_4bScUVXof7e0 AND hBS4MQ0Oc4LLJRiUiE_R94_-zoU4B2vwnPkXmsGh_b","in":"path","name":"account-id","required":true,"schema":{"type":"string"}},"closingBookedReferenceDate":{"description":"Reference date to receive historical closingBooked balances from yesterday up to 15 months in the past.","example":"2024-10-30","in":"query","name":"closingBookedReferenceDate","required":false,"schema":{"format":"date","type":"string"}}},"schemas":{"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"}},"type":"object"},"amount":{"example":{"amount":"10","currency":"EUR"},"properties":{"amount":{"$ref":"#/components/schemas/amountValue"},"currency":{"$ref":"#/components/schemas/currencyCode"}},"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":"2023-02-01T14:07:17.000Z","type":"string"},"referenceDate":{"example":"2023-01-31","type":"string"}},"type":"object"},"balanceList":{"description":"A list of balances regarding this account e.g. the expected balance, interim booked balance and the last booked balance.\nThe list might be restricted to the expected balance and interim booked balance.\n","items":{"$ref":"#/components/schemas/balance"},"type":"array"},"balanceResponse":{"description":"Body of the response for a successful read balance request.","properties":{"account":{"$ref":"#/components/schemas/accountReferenceIban"},"balances":{"$ref":"#/components/schemas/balanceList"},"piggyBanks":{"$ref":"#/components/schemas/piggyBankList"}},"type":"object"},"balanceType":{"enum":["closingBooked","expected","interimBooked"],"example":"expected","type":"string"},"currencyCode":{"description":"ISO 4217 Alpha 3 currency code","example":"EUR","pattern":"[A-Z]{3}","type":"string"},"iban":{"description":"IBAN of an account","example":"NL52RABO0125618484","pattern":"[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}","type":"string"},"messageCodeText":{"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","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"},"piggyBank":{"properties":{"piggyBankBalance":{"example":"1000.00","type":"string"},"piggyBankName":{"example":"Vacation","type":"string"}},"type":"object"},"piggyBankList":{"description":"Optional list of piggy banks, it will only appear when piggy banks exist and correct consent is present.\n","items":{"$ref":"#/components/schemas/piggyBank"},"type":"array"},"tppMessageCategory":{"description":"Category of the message","enum":["ERROR","WARNING"],"example":"ERROR","type":"string"},"tppMessageGeneric":{"properties":{"category":{"$ref":"#/components/schemas/tppMessageCategory"},"code":{"$ref":"#/components/schemas/messageCodeText"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/tppMessageText"}},"type":"object"},"tppMessageText":{"description":"Additional text.","example":"Header X-Request-ID is required","maxLength":512,"type":"string"},"tppMessages":{"description":"Messages on operational issues.","properties":{"tppMessages":{"items":{"$ref":"#/components/schemas/tppMessageGeneric"},"type":"array"}},"type":"object"}},"securitySchemes":{"clientId":{"description":"ClientId as provided by the Rabobank developer portal.","in":"header","name":"X-IBM-Client-Id","type":"apiKey"},"oauth2_premium_access_code_flow_bai-balances":{"description":"NOTE Please use the Authorization and Token URL as provided by the oAuth2 Services. Scope: bai.accountinformation.read, bai.piggybanks.read","flows":{"authorizationCode":{"authorizationUrl":"https://oauth.rabobank.nl/openapi/oauth2-premium/authorize","scopes":{"bai.accountinformation.read":"Allow read from Business Account Insight services","bai.piggybanks.read":"Allow read for Piggy Banks from Business Account Insight services"},"tokenUrl":"https://oauth.rabobank.nl/openapi/oauth2-premium/token"}},"type":"oauth2","x-ibm-oauth-provider":"access-authorization-1-0-0-8e24"}}},"security":[{"clientId":[],"oauth2_premium_access_code_flow_bai-balances":["bai.accountinformation.read"]},{"clientId":[],"oauth2_premium_access_code_flow_bai-balances":["bai.piggybanks.read"]}],"x-readme":{"explorer-enabled":false,"proxy-enabled":false}}