openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 359 kB
JSON
{"openapi":"3.0.1","servers":[{"description":"Sandbox Server","url":"https://apis.nbg.gr/sandbox/uk.openbanking.accountinfo/oauth2/v3.1.5"},{"description":"Production Server","url":"https://services.nbg.gr/apis/open-banking/v3.1.5/aisp"}],"info":{"contact":{"email":"developer@nbg.gr","name":"NBG","url":"https://developer.nbg.gr/"},"description":"## Functionality at a glance\r\n\r\nThe NBG \"UK OPB - Account and Transaction v3.1.5\" API follows the [UK Open Banking Specification\r\n v3.1.5](https://openbankinguk.github.io/read-write-api-site3/v3.1.5/profiles/account-and-transaction-api-profile.html)\r\n\r\nThis Account and Transaction API Specification describes the flows and payloads for retrieving a list of accounts and their transactions.\r\n\r\nThe API endpoints described here allow a AISP to: \r\n\r\n* Create the Consent with the appropriate permissions in order to be able to access the API Endpoints\r\n\r\n* Retrieve the list of accounts\r\n\r\n* Retrieve an account's details\r\n\r\n* Retrieve an account's balances\r\n\r\n* Retrieve an account's transactions\r\n\r\n* Retrieve an account's beneficiaries\r\n\r\n* Retrieve an account's standing orders\r\n\r\n* Retrieve an account's party\r\n\r\n* Retrieve an account's scheduled payments\r\n\r\n* Retrieve an account's statements\r\n\r\n\r\n\r\n## Quick Getting Started\r\n\r\n\r\n1. **Login/Register** to the NBG Technology HUB\r\n\r\n2. Go to **\"APPS\"**\r\n\r\n3. Select your Organization and go to step 4. If you want to create a new Organization click **\\\"CREATE AN ORGANIZATION\\\"** and follow the steps below:\r\n\t1. Enter the title of your Organization\r\n\t2. Enter a short description of your Organization (optional)\r\n\t3. Click **\"SUBMIT\"**\r\n\r\n4. Select the Organization of choice and click **\"ADD AN APPLICATION\"** \r\n\t 1. Fill in the forms (title and short description)\r\n\t 2. Check **\\\"Authorization Code\\\" and \\\"Client Credentials\\\"** \r\n\t 3. Enter the **OAuth Redirect and Post Logout URIs** (these are the URIs that we will redirect the user upon logging in and logging out respectively)\r\n\t\t \r\n\t\t You can use the following redirect URL to easily test the API through the portal: *https://developer.nbg.gr/oauth2/redoc-callback*\r\n\t 4. Click **\"SUBMIT\"**\r\n\t 5. Store the APPs **\"Client ID\"** and **\"Client Secret\"**\r\n5. Go to **\"API PRODUCTS\"** and select the **ACCOUNT INFORMATION - UK OPEN BANKING API**\r\n\r\n6. Click **\\\"START USING THIS API\\\"**, choose your app and click\r\n**\"SUBSCRIBE\"**\r\n\r\n7. Get an Access Token using the Access Token Flow and the API scopes provided in the Authentication and Authorization (OAuth2) section below\r\n\r\n8. Create a Sandbox\r\n\r\n9. Play with the API \r\n\r\n\r\n### Sandbox Flow\r\n\r\nThe Sandbox Flow matches the Production Flow. The difference lies into the Data used. Instead of live\r\ndata, the Sandbox flow uses mocked data.\r\n\r\n\r\n### Production Flow \r\n\r\nThe Production Flow is described in the [UK Open Banking v3.1.5\r\nSpecification](https://openbankinguk.github.io/read-write-api-site3/v3.1.5/profiles/account-and-transaction-api-profile.html)\r\n\r\nMore details about the implementation specifics followed, please visit section **UK OPB Implementation\r\nSpecifics**\r\n\r\n\r\n## Authentication and Authorization (OAuth2)\r\n\r\nThis API version uses the OAuth2 protocol for authentication and authorization, which means that a\r\nBearer (access token) should be acquired. An access token can be retrieved using the client_id and\r\nclient_secret of the APP that you created and subscribed in this API, and your own credentials\r\n(username, password) that you use to sign in the NBG Technology HUB. The scopes are defined below:\r\n\r\n**Authorization Endpoint:** \r\n\r\n\t https://my.nbg.gr/identity/connect/authorize\r\n\r\n\r\n**Token Endpoint:** \r\n\r\n\t https://my.nbg.gr/identity/connect/token\r\n\r\n### Authorization Code ###\r\n\r\n**Sandbox Scopes:** \r\n\r\n\t sandbox-uk-account-info-api-v1 offline_access\r\n\r\n\r\n**Production Scopes:** \r\n\r\n\t accounts offline_access\r\n\r\n### Client Credentials ###\r\n\r\n**Sandbox Scopes:** \r\n\r\n\t sandbox-uk-account-info-api-v1\r\n\r\n\r\n**Production Scopes:** \r\n\r\n\t accounts\r\n\r\n\r\nSee more [here](https://developer.nbg.gr/oauth-document)\r\n\r\n## QWAC Certificates\r\n\r\nTPPs are required to present a QWAC certificate during API consumption. The API checks that this certificate has been provided and is valid. In sandbox mode the certificate validations are optional. To validate your certificate in sandbox implementation, please send us your QWAC certificate at developer@nbg.gr and set the HTTP Header **\\\"x-sandbox-qwac-certificate-check\\\"** with the value **\\\"true\\\"** in your requests. \r\n\r\n## SMS Challenge (One Time Password)\r\n\r\nIn order to successfully authorize an Accounts Access you will need to provide the SMS OTP (One Time Password) in the corresponding Accounts Consent UI Screen.\r\n\r\nBy default the SMS OTP will be sent to the mobile number declared upon singing up in the NBG Technology HUB. \r\n\r\n\r\n\r\n## Create your Sandbox\r\n\r\nCreate a new Sandbox application by invoking the POST /sandbox. This call will generate a new Sandbox\r\nwith a unique sandbox-id.\r\n\r\n\r\n__Important!__ Before proceeding save the sandbox id you just created.\r\n\r\n\r\nWhen you create a sandbox, users and sandbox specific data are generated as sample data.\r\n\r\n\r\n## Start Testing\r\n\r\nOnce you have your sandbox-id, you can start invoking the rest of the operations by providing the\r\nmandatory http header **sandbox-id** and the http headers described below.\r\n\r\n\r\n## Important notes\r\n\r\n\r\n**Request headers**\r\n\r\n\r\nThe following HTTP header parameters are required for every call:\r\n\r\n\r\n1. Authorization. The Auth2 Token\r\n\r\n2. sandbox-id. Your Sandbox ID\r\n\r\n\r\n**Consent**\r\n\r\n\r\nIn order to be able to effectively start using the Endpoints the appropriate Consent needs to be\r\ncreated and set to the 'Authorised' status. \r\n\r\n\r\nIn order to create the Consent you need to at least set the required **permissions** and the **Risk**\r\nsections. \r\n\r\n\r\nOptionally you may set the \r\n\r\n\r\n1. ExpirationDateTime. When the Consent expires \r\n\r\n\r\n2. TransactionFromDateTime. Start Date to retrieve the transactions \r\n\r\n\r\n3. TransactionToDateTime. End Date to retrieve the transactions \r\n\r\n**Not Implemented Endpoints**\r\n\r\nThe following endpoints are not implemented in the API\r\n\r\n1. GET /balances\r\n2. GET /transactions\r\n3. GET /beneficiaries\r\n4. GET /accounts/\\{AccountId\\}/direct-debits\r\n5. GET /direct-debits\r\n6. GET /standing-orders\r\n7. GET /accounts/\\{AccountId\\}/product\r\n8. GET /products\r\n9. GET /accounts/\\{AccountId\\}/offers\r\n10. GET /offers\r\n11. GET /scheduled-payments\r\n12. GET /statements\r\n\r\n\r\n## Error Codes\r\n\r\nThe error codes and their description can be found\r\n[here](https://openbankinguk.github.io/read-write-api-site3/v3.1.5/profiles/read-write-data-api-profile.html#error-response-structure)\r\n\r\n\r\n# UK OPB Implementation Specifics \r\n\r\nBelow you may find more specific information & limitations regarding the implementation followed in the Production API.\r\n\r\n\r\n## Token Endpoint Client Authentication\r\n\r\nAt this point the supported __Client Authentication__ method is \"__Client Secret Basic__\" - usage of \"Client ID\" & \"Client Secret\".\r\n\r\n\r\n## Consent Authorization\r\n\r\nFor a PSU to Authorize a Consent, they need to be redirected to the appropriate Consent UI.\r\n\r\nFor this redirection to take place the TPP needs to follow the Authorization Endpoint by amending the generated \"Consent ID\", like this: https://my.nbg.gr/identity/connect/authorize?consent_id={{consent_id}}&client_id={{client_id}}&scope={{scope}}&redirect_uri={{redirect_uri}}&response_type=code\r\n\r\nOnce the PSU is redirected to the Consent Authorization Screen, they need to enter their IBank (Production) or Developer Portal (Sandbox) Credentials and either Authorize or Reject the Consent.\r\n\r\nAt this point the Consent is binded with the PSU.\r\n\r\n\r\n## Debtor Account\r\nCurrently, only the \"UK.OBIE.IBAN\" scheme is supported.\r\n\r\n\r\n\r\n# Feedback and Questions\r\n\r\nWe would love to hear your feedback and answer your questions. Send us at\r\n[developer@nbg.gr](developer@nbg.gr)\r\n\r\n\r\nCheck out our [Sandbox Postman\r\nCollection](https://github.com/NBG-Developer-Portal/Account-Information-UK-Open-Banking)!\r\n\r\n\r\n________________________________________\r\n\r\nCreated by [**NBG**](https://www.nbg.gr/).\n\n # Entities \n\n Below, the main entities are documented.\n <a name=OBExternalPermissions1Code></a> \n## OBExternalPermissions1Code \n### Attributes \n\n| Type| Description| Example| Values|\n| -----| -----| -----| -----|\n| enum| Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.| <ul style=\"padding-left: 0\"><li>ReadAccountsBasic</li><li>ReadAccountsDetail</li><li>ReadBalances</li><li>ReadBeneficiariesBasic</li><li>ReadBeneficiariesDetail</li><li>ReadDirectDebits</li><li>ReadOffers</li><li>ReadPAN</li><li>ReadParty</li><li>ReadPartyPSU</li><li>ReadProducts</li><li>ReadScheduledPaymentsBasic</li><li>ReadScheduledPaymentsDetail</li><li>ReadStandingOrdersBasic</li><li>ReadStandingOrdersDetail</li><li>ReadStatementsBasic</li><li>ReadStatementsDetail</li><li>ReadTransactionsBasic</li><li>ReadTransactionsCredits</li><li>ReadTransactionsDebits</li><li>ReadTransactionsDetail</li></ul>|\n\n <a name=OBReadData1></a> \n## OBReadData1 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Permissions| Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.| array[[OBExternalPermissions1Code](#OBExternalPermissions1Code)]|\n| ExpirationDateTime| Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00| string|\n| TransactionFromDateTime| Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00| string|\n| TransactionToDateTime| Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00| string|\n\n <a name=OBRisk2></a> \n## OBRisk2 \nThe Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info. \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n\n <a name=OBReadConsent1></a> \n## OBReadConsent1 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Data | Entity | <details><summary>[OBReadData1](#OBReadData1)</summary><ul><li>Permissions [array[[OBExternalPermissions1Code](#OBExternalPermissions1Code)]]</li> <li>ExpirationDateTime [string]</li> <li>TransactionFromDateTime [string]</li> <li>TransactionToDateTime [string]</li> </ul></details> | \n| Risk | Entity | <details><summary>[OBRisk2](#OBRisk2)</summary><ul></ul></details> | \n\n <a name=ErrorCode></a> \n## ErrorCode \n### Attributes \n\n| Type| Description| Example| Values|\n| -----| -----| -----| -----|\n| enum| This is Data Type gives a low level textual error code to help categorise an error response. The applicable HTTP response code is also given.| <ul style=\"padding-left: 0\"><li>UK.OBIE.Field.Expected</li><li>UK.OBIE.Field.Invalid</li><li>UK.OBIE.Field.InvalidDate</li><li>UK.OBIE.Field.Missing</li><li>UK.OBIE.Field.Unexpected</li><li>UK.OBIE.Header.Invalid</li><li>UK.OBIE.Header.Missing</li><li>UK.OBIE.Resource.ConsentMismatch</li><li>UK.OBIE.Resource.InvalidConsentStatus</li><li>UK.OBIE.Resource.InvalidFormat</li><li>UK.OBIE.Resource.NotFound</li><li>UK.OBIE.Rules.AfterCutOffDateTime</li><li>UK.OBIE.Rules.DuplicateReference</li><li>UK.OBIE.Signature.Invalid</li><li>UK.OBIE.Signature.InvalidClaim</li><li>UK.OBIE.Signature.MissingClaim</li><li>UK.OBIE.Signature.Malformed</li><li>UK.OBIE.Signature.Missing</li><li>UK.OBIE.Signature.Unexpected</li><li>UK.OBIE.Unsupported.AccountIdentifier</li><li>UK.OBIE.Unsupported.AccountSecondaryIdentifier</li><li>UK.OBIE.Unsupported.Currency</li><li>UK.OBIE.Unsupported.EventType</li><li>UK.OBIE.Unsupported.Frequency</li><li>UK.OBIE.Unsupported.LocalInstrument</li><li>UK.OBIE.Unsupported.Scheme</li><li>UK.OBIE.Reauthenticate</li><li>UK.OBIE.Rules.ResourceAlreadyExists</li><li>UK.OBIE.UnexpectedError</li></ul>|\n\n <a name=OBError1></a> \n## OBError1 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| ErrorCode | Entity | <details><summary>[ErrorCode](#ErrorCode)</summary><ul></ul></details> | \n| Message| A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'OBIE doesn't standardise this field| string|\n| Path| Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency| string|\n\n <a name=OBErrorResponse1></a> \n## OBErrorResponse1 \nAn array of detail error codes, and messages, and URLs to documentation to help remediation. \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Code| High level textual error code, to help categorize the errors.| string|\n| Id| A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.| string|\n| Message| Brief Error message, e.g., 'There is something wrong with the request parameters provided'| string|\n| Errors| Gets or Sets Errors| array[[OBError1](#OBError1)]|\n\n <a name=OBExternalRequestStatus1Code></a> \n## OBExternalRequestStatus1Code \n### Attributes \n\n| Type| Description| Example| Values|\n| -----| -----| -----| -----|\n| enum| Specifies the status of consent resource in code form.| <ul style=\"padding-left: 0\"><li>Authorised</li><li>AwaitingAuthorisation</li><li>Rejected</li><li>Revoked</li></ul>|\n\n <a name=OBReadDataConsentResponse1></a> \n## OBReadDataConsentResponse1 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| ConsentId| Unique identification as assigned to identify the account access consent resource.| string|\n| CreationDateTime| Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00| string|\n| Status | Entity | <details><summary>[OBExternalRequestStatus1Code](#OBExternalRequestStatus1Code)</summary><ul></ul></details> | \n| StatusUpdateDateTime| Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00| string|\n| Permissions| Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.| array[[OBExternalPermissions1Code](#OBExternalPermissions1Code)]|\n| ExpirationDateTime| Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00| string|\n| TransactionFromDateTime| Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00| string|\n| TransactionToDateTime| Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00| string|\n\n <a name=Links></a> \n## Links \nLinks relevant to the payload \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Self| -| string|\n| First| -| string|\n| Prev| -| string|\n| Next| -| string|\n| Last| -| string|\n\n <a name=Meta></a> \n## Meta \nMeta Data relevant to the payload \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| TotalPages| -| integer|\n| FirstAvailableDateTime| All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone.An example is below: 2017-04-05T10:43:07+00:00| string|\n| LastAvailableDateTime| All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone.An example is below: 2017-04-05T10:43:07+00:00| string|\n\n <a name=OBReadConsentResponse1></a> \n## OBReadConsentResponse1 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Data | Entity | <details><summary>[OBReadDataConsentResponse1](#OBReadDataConsentResponse1)</summary><ul><li>ConsentId [string]</li> <li>CreationDateTime [string]</li> <li><details><summary>Status [[OBExternalRequestStatus1Code](#OBExternalRequestStatus1Code)]</summary><ul></ul></details></li><li>StatusUpdateDateTime [string]</li> <li>Permissions [array[[OBExternalPermissions1Code](#OBExternalPermissions1Code)]]</li> <li>ExpirationDateTime [string]</li> <li>TransactionFromDateTime [string]</li> <li>TransactionToDateTime [string]</li> </ul></details> | \n| Risk | Entity | <details><summary>[OBRisk2](#OBRisk2)</summary><ul></ul></details> | \n| Links | Entity | <details><summary>[Links](#Links)</summary><ul><li>Self [string]</li> <li>First [string]</li> <li>Prev [string]</li> <li>Next [string]</li> <li>Last [string]</li> </ul></details> | \n| Meta | Entity | <details><summary>[Meta](#Meta)</summary><ul><li>TotalPages [integer]</li> <li>FirstAvailableDateTime [string]</li> <li>LastAvailableDateTime [string]</li> </ul></details> | \n\n <a name=OBExternalAccountType1Code></a> \n## OBExternalAccountType1Code \n### Attributes \n\n| Type| Description| Example| Values|\n| -----| -----| -----| -----|\n| enum| -| <ul style=\"padding-left: 0\"><li>Business</li><li>Personal</li></ul>|\n\n <a name=OBExternalAccountSubType1Code></a> \n## OBExternalAccountSubType1Code \n### Attributes \n\n| Type| Description| Example| Values|\n| -----| -----| -----| -----|\n| enum| -| <ul style=\"padding-left: 0\"><li>ChargeCard</li><li>CreditCard</li><li>CurrentAccount</li><li>EMoney</li><li>Loan</li><li>Mortgage</li><li>PrePaidCard</li><li>Savings</li></ul>|\n\n <a name=OBCashAccount5></a> \n## OBCashAccount5 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| SchemeName| Name of the identification scheme, in a coded form as published in an external list.| string|\n| Identification| Identification assigned by an institution to identify an account. This identification is known by the account owner.| string|\n| Name| The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.| string|\n| SecondaryIdentification| This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number(in addition to a sort code and account number combination).| string|\n\n <a name=OBBranchAndFinancialInstitutionIdentification5></a> \n## OBBranchAndFinancialInstitutionIdentification5 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| SchemeName| Name of the identification scheme, in a coded form as published in an external list.| string|\n| Identification| Unique and unambiguous identification of the servicing institution.| string|\n\n <a name=OBAccount6></a> \n## OBAccount6 \nUnambiguous identification of the account to which credit and debit entries are made. \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| AccountId| A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.| string|\n| Currency| Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.| string|\n| AccountType | Entity | <details><summary>[OBExternalAccountType1Code](#OBExternalAccountType1Code)</summary><ul></ul></details> | \n| AccountSubType | Entity | <details><summary>[OBExternalAccountSubType1Code](#OBExternalAccountSubType1Code)</summary><ul></ul></details> | \n| Description| Specifies the description of the account type.| string|\n| Nickname| The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.| string|\n| OpeningDate| Date on which the account and related basic services are effectively operational for the account owner.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00| string|\n| Account| Provides the details to identify an account.| array[[OBCashAccount5](#OBCashAccount5)]|\n| Servicer | Entity | <details><summary>[OBBranchAndFinancialInstitutionIdentification5](#OBBranchAndFinancialInstitutionIdentification5)</summary><ul><li>SchemeName [string]</li> <li>Identification [string]</li> </ul></details> | \n\n <a name=OBReadDataAccount5></a> \n## OBReadDataAccount5 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Account| Unambiguous identification of the account to which credit and debit entries are made.| array[[OBAccount6](#OBAccount6)]|\n\n <a name=OBReadAccount5></a> \n## OBReadAccount5 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Data | Entity | <details><summary>[OBReadDataAccount5](#OBReadDataAccount5)</summary><ul><li>Account [array[[OBAccount6](#OBAccount6)]]</li> </ul></details> | \n| Links | Entity | <details><summary>[Links](#Links)</summary><ul><li>Self [string]</li> <li>First [string]</li> <li>Prev [string]</li> <li>Next [string]</li> <li>Last [string]</li> </ul></details> | \n| Meta | Entity | <details><summary>[Meta](#Meta)</summary><ul><li>TotalPages [integer]</li> <li>FirstAvailableDateTime [string]</li> <li>LastAvailableDateTime [string]</li> </ul></details> | \n\n <a name=OBCreditDebitCode></a> \n## OBCreditDebitCode \n### Attributes \n\n| Type| Description| Example| Values|\n| -----| -----| -----| -----|\n| enum| -| <ul style=\"padding-left: 0\"><li>Credit</li><li>Debit</li></ul>|\n\n <a name=OBBalanceType1Code></a> \n## OBBalanceType1Code \n### Attributes \n\n| Type| Description| Example| Values|\n| -----| -----| -----| -----|\n| enum| -| <ul style=\"padding-left: 0\"><li>ClosingAvailable</li><li>ClosingBooked</li><li>ClosingCleared</li><li>Expected</li><li>ForwardAvailable</li><li>Information</li><li>InterimAvailable</li><li>InterimBooked</li><li>InterimCleared</li><li>OpeningAvailable</li><li>OpeningBooked</li><li>OpeningCleared</li><li>PreviouslyClosedBooked</li></ul>|\n\n <a name=OBActiveOrHistoricCurrencyAndAmount></a> \n## OBActiveOrHistoricCurrencyAndAmount \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Amount| A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.| string|\n| Currency| 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\".| string|\n\n <a name=OBExternalLimitType1Code></a> \n## OBExternalLimitType1Code \n### Attributes \n\n| Type| Description| Example| Values|\n| -----| -----| -----| -----|\n| enum| -| <ul style=\"padding-left: 0\"><li>Available</li><li>Credit</li><li>Emergency</li><li>Pre-Agreed</li><li>Temporary</li></ul>|\n\n <a name=OBCreditLine1></a> \n## OBCreditLine1 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Included| Indicates whether or not the credit line is included in the balance of the account. Usage: If not present, credit line is not included in the balance amount of the account.| boolean|\n| Type | Entity | <details><summary>[OBExternalLimitType1Code](#OBExternalLimitType1Code)</summary><ul></ul></details> | \n| Amount | Entity | <details><summary>[OBActiveOrHistoricCurrencyAndAmount](#OBActiveOrHistoricCurrencyAndAmount)</summary><ul><li>Amount [string]</li> <li>Currency [string]</li> </ul></details> | \n\n <a name=OBCashBalance1></a> \n## OBCashBalance1 \nSet of elements used to define the balance details. \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| AccountId| A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.| string|\n| CreditDebitIndicator | Entity | <details><summary>[OBCreditDebitCode](#OBCreditDebitCode)</summary><ul></ul></details> | \n| Type | Entity | <details><summary>[OBBalanceType1Code](#OBBalanceType1Code)</summary><ul></ul></details> | \n| DateTime| Indicates the date (and time) of the balance.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00| string|\n| Amount | Entity | <details><summary>[OBActiveOrHistoricCurrencyAndAmount](#OBActiveOrHistoricCurrencyAndAmount)</summary><ul><li>Amount [string]</li> <li>Currency [string]</li> </ul></details> | \n| CreditLine| Set of elements used to provide details on the credit line.| array[[OBCreditLine1](#OBCreditLine1)]|\n\n <a name=OBReadDataBalance1></a> \n## OBReadDataBalance1 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Balance| Set of elements used to define the balance details.| array[[OBCashBalance1](#OBCashBalance1)]|\n\n <a name=OBReadBalance1></a> \n## OBReadBalance1 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Data | Entity | <details><summary>[OBReadDataBalance1](#OBReadDataBalance1)</summary><ul><li>Balance [array[[OBCashBalance1](#OBCashBalance1)]]</li> </ul></details> | \n| Links | Entity | <details><summary>[Links](#Links)</summary><ul><li>Self [string]</li> <li>First [string]</li> <li>Prev [string]</li> <li>Next [string]</li> <li>Last [string]</li> </ul></details> | \n| Meta | Entity | <details><summary>[Meta](#Meta)</summary><ul><li>TotalPages [integer]</li> <li>FirstAvailableDateTime [string]</li> <li>LastAvailableDateTime [string]</li> </ul></details> | \n\n <a name=OBBeneficiaryType1Code></a> \n## OBBeneficiaryType1Code \n### Attributes \n\n| Type| Description| Example| Values|\n| -----| -----| -----| -----|\n| enum| Specifies the Beneficiary Type.| <ul style=\"padding-left: 0\"><li>Trusted</li><li>Ordinary</li></ul>|\n\n <a name=OBBeneficiary5></a> \n## OBBeneficiary5 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| AccountId| A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.| string|\n| BeneficiaryType | Entity | <details><summary>[OBBeneficiaryType1Code](#OBBeneficiaryType1Code)</summary><ul></ul></details> | \n| CreditorAccount | Entity | <details><summary>[OBCashAccount5](#OBCashAccount5)</summary><ul><li>SchemeName [string]</li> <li>Identification [string]</li> <li>Name [string]</li> <li>SecondaryIdentification [string]</li> </ul></details> | \n\n <a name=OBReadDataBeneficiary5></a> \n## OBReadDataBeneficiary5 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Beneficiary| -| array[[OBBeneficiary5](#OBBeneficiary5)]|\n\n <a name=OBReadBeneficiary5></a> \n## OBReadBeneficiary5 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Data | Entity | <details><summary>[OBReadDataBeneficiary5](#OBReadDataBeneficiary5)</summary><ul><li>Beneficiary [array[[OBBeneficiary5](#OBBeneficiary5)]]</li> </ul></details> | \n| Links | Entity | <details><summary>[Links](#Links)</summary><ul><li>Self [string]</li> <li>First [string]</li> <li>Prev [string]</li> <li>Next [string]</li> <li>Last [string]</li> </ul></details> | \n| Meta | Entity | <details><summary>[Meta](#Meta)</summary><ul><li>TotalPages [integer]</li> <li>FirstAvailableDateTime [string]</li> <li>LastAvailableDateTime [string]</li> </ul></details> | \n\n <a name=OBParty2></a> \n## OBParty2 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| PartyId| A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.| string|\n| Name| Name by which a party is known and which is usually used to identify that party.| string|\n\n <a name=OBReadDataParty2></a> \n## OBReadDataParty2 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Party | Entity | <details><summary>[OBParty2](#OBParty2)</summary><ul><li>PartyId [string]</li> <li>Name [string]</li> </ul></details> | \n\n <a name=OBReadParty2></a> \n## OBReadParty2 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Data | Entity | <details><summary>[OBReadDataParty2](#OBReadDataParty2)</summary><ul><li><details><summary>Party [[OBParty2](#OBParty2)]</summary><ul><li>PartyId [string]</li> <li>Name [string]</li> </ul></details></li></ul></details> | \n| Links | Entity | <details><summary>[Links](#Links)</summary><ul><li>Self [string]</li> <li>First [string]</li> <li>Prev [string]</li> <li>Next [string]</li> <li>Last [string]</li> </ul></details> | \n| Meta | Entity | <details><summary>[Meta](#Meta)</summary><ul><li>TotalPages [integer]</li> <li>FirstAvailableDateTime [string]</li> <li>LastAvailableDateTime [string]</li> </ul></details> | \n\n <a name=OBReadDataParty3></a> \n## OBReadDataParty3 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Party| -| array[[OBParty2](#OBParty2)]|\n\n <a name=OBReadParty3></a> \n## OBReadParty3 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Data | Entity | <details><summary>[OBReadDataParty3](#OBReadDataParty3)</summary><ul><li>Party [array[[OBParty2](#OBParty2)]]</li> </ul></details> | \n| Links | Entity | <details><summary>[Links](#Links)</summary><ul><li>Self [string]</li> <li>First [string]</li> <li>Prev [string]</li> <li>Next [string]</li> <li>Last [string]</li> </ul></details> | \n| Meta | Entity | <details><summary>[Meta](#Meta)</summary><ul><li>TotalPages [integer]</li> <li>FirstAvailableDateTime [string]</li> <li>LastAvailableDateTime [string]</li> </ul></details> | \n\n <a name=SandboxRequest></a> \n## SandboxRequest \nRequest to create a new sandbox \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| sandboxId| Sandbox Id| string|\n\n <a name=ErrorResponse></a> \n## ErrorResponse \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| errorMessage| -| string|\n\n <a name=SandboxRetryCacheEntry></a> \n## SandboxRetryCacheEntry \nKeeps the number of calls without x-fapi-customer-ip-address header present \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| cacheKey| Cache key| string|\n| count| Number of retries ( up to 4 )| integer|\n| expirationTimestamp| Expiration timestamp of the entry| string|\n\n <a name=SandboxBankAccountInfo></a> \n## SandboxBankAccountInfo \nGeneral account information \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| currency| Currency (EUR, USD ...)| string|\n| iban| Account's IBAN| string|\n| accountType| Account's type (Business, Personal)| string|\n| accountSubType| Account's sub-type (ChargeCard, CreditCard, CurrentAccount ...)| string|\n| description| Account's description| string|\n| alias| Account's alias| string|\n| openingDate| Account's opening date| string|\n| availableBalance| Account's available balance| number|\n| ledgerBalance| Account's ledger balance| number|\n| overdraftLimit| Account's overdraft limit| number|\n\n <a name=SandboxParty></a> \n## SandboxParty \nConnected party information \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| id| Party id| string|\n| name| Name| string|\n\n <a name=SandboxBeneficiary></a> \n## SandboxBeneficiary \nBeneficiary information \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| name| Beneficiary name| string|\n\n <a name=SandboxStandingOrder></a> \n## SandboxStandingOrder \nStanding order information \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| description| Standing order short description| string|\n| frequency| Standing order frequency| string|\n| firstPaymentDate| Standing order first collection date| string|\n| nextPaymentDate| Standing order next collection date| string|\n| finalPaymentDate| Standing order final collection date| string|\n| lastPaymentDate| Standing order last executed payment date| string|\n| status| Standing order status (Active, Inactive)| string|\n| amount| Standing order amount| number|\n\n <a name=SandboxScheduledPayment></a> \n## SandboxScheduledPayment \nScheduled payment information \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| description| Scheduled payment's short description| string|\n| executionDate| Scheduled payment's execution date| string|\n| amount| Amount| number|\n| senderReference| Debtor / Sender reference| string|\n\n <a name=SandboxStatement></a> \n## SandboxStatement \nStatement information \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| number| Statement number| string|\n| year| Statement year| integer|\n| month| Statement month| integer|\n\n <a name=SandboxTransaction></a> \n## SandboxTransaction \nTransaction information \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| reference| Transaction reference| string|\n| amount| Amount| number|\n| currency| Currency (EUR, USD ...)| string|\n| creditDebit| Credit / Debit indicator| string|\n| valueDateTime| Valeur| string|\n| bookingDateTime| Booking date time| string|\n| description| Description| string|\n| accountingBalance| Balance| number|\n| relatedAccount| Related account| string|\n| relatedName| Related account| string|\n| transactionCode| Transaction code| string|\n\n <a name=SandboxBankAccount></a> \n## SandboxBankAccount \nSandbox bank account \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| info | Entity | <details><summary>[SandboxBankAccountInfo](#SandboxBankAccountInfo)</summary><ul><li>currency [string]</li> <li>iban [string]</li> <li>accountType [string]</li> <li>accountSubType [string]</li> <li>description [string]</li> <li>alias [string]</li> <li>openingDate [string]</li> <li>availableBalance [number]</li> <li>ledgerBalance [number]</li> <li>overdraftLimit [number]</li> </ul></details> | \n| party | Entity | <details><summary>[SandboxParty](#SandboxParty)</summary><ul><li>id [string]</li> <li>name [string]</li> </ul></details> | \n| beneficiaries| List of account's beneficiaries| array[[SandboxBeneficiary](#SandboxBeneficiary)]|\n| standingOrders| List of account's standing orders| array[[SandboxStandingOrder](#SandboxStandingOrder)]|\n| scheduledPayments| List of account's scheduled payments| array[[SandboxScheduledPayment](#SandboxScheduledPayment)]|\n| statements| List of account's statements| array[[SandboxStatement](#SandboxStatement)]|\n| transactions| List of account's transactions| array[[SandboxTransaction](#SandboxTransaction)]|\n\n <a name=SandboxCardInfo></a> \n## SandboxCardInfo \nSandbox card information \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| number| Card number| string|\n| description| Description| string|\n| holderName| Holder name| string|\n| expiration| Expiration date (05/2022)| string|\n| type| Type| string|\n| subType| Sub type| string|\n| availableBalance| Available balance| number|\n| ledgerBalance| Ledger balance| number|\n| creditLimit| Credit limit ( applicable to credit cards )| number|\n\n <a name=SandboxCard></a> \n## SandboxCard \nSandbox card \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| info | Entity | <details><summary>[SandboxCardInfo](#SandboxCardInfo)</summary><ul><li>number [string]</li> <li>description [string]</li> <li>holderName [string]</li> <li>expiration [string]</li> <li>type [string]</li> <li>subType [string]</li> <li>availableBalance [number]</li> <li>ledgerBalance [number]</li> <li>creditLimit [number]</li> </ul></details> | \n| party | Entity | <details><summary>[SandboxParty](#SandboxParty)</summary><ul><li>id [string]</li> <li>name [string]</li> </ul></details> | \n| statements| Card statements| array[[SandboxStatement](#SandboxStatement)]|\n| transactions| Card transactions| array[[SandboxTransaction](#SandboxTransaction)]|\n\n <a name=SandboxUser></a> \n## SandboxUser \nUser data \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| userId| Connected user id| string|\n| retryCacheEntries| Retry cache entries| array[[SandboxRetryCacheEntry](#SandboxRetryCacheEntry)]|\n| accounts| List of accounts| array[[SandboxBankAccount](#SandboxBankAccount)]|\n| cards| List of cards| array[[SandboxCard](#SandboxCard)]|\n\n <a name=Sandbox></a> \n## Sandbox \nSandbox model \n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| sandboxId| Sandbox id| string|\n| users| List of users| array[[SandboxUser](#SandboxUser)]|\n\n <a name=OBExternalScheduleType1Code></a> \n## OBExternalScheduleType1Code \n### Attributes \n\n| Type| Description| Example| Values|\n| -----| -----| -----| -----|\n| enum| -| <ul style=\"padding-left: 0\"><li>Arrival</li><li>Execution</li></ul>|\n\n <a name=OBScheduledPayment3></a> \n## OBScheduledPayment3 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| AccountId| A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.| string|\n| ScheduledPaymentId| A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.| string|\n| ScheduledPaymentDateTime| The date on which the scheduled payment will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone.An example is below: 2017-04-05T10:43:07+00:00| string|\n| ScheduledType | Entity | <details><summary>[OBExternalScheduleType1Code](#OBExternalScheduleType1Code)</summary><ul></ul></details> | \n| Reference| Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.| string|\n| DebtorReference| A reference value provided by the PSU to the PISP while setting up the scheduled payment.| string|\n| InstructedAmount | Entity | <details><summary>[OBActiveOrHistoricCurrencyAndAmount](#OBActiveOrHistoricCurrencyAndAmount)</summary><ul><li>Amount [string]</li> <li>Currency [string]</li> </ul></details> | \n| CreditorAccount | Entity | <details><summary>[OBCashAccount5](#OBCashAccount5)</summary><ul><li>SchemeName [string]</li> <li>Identification [string]</li> <li>Name [string]</li> <li>SecondaryIdentification [string]</li> </ul></details> | \n\n <a name=OBReadDataScheduledPayment3></a> \n## OBReadDataScheduledPayment3 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| ScheduledPayment| -| array[[OBScheduledPayment3](#OBScheduledPayment3)]|\n\n <a name=OBReadScheduledPayment3></a> \n## OBReadScheduledPayment3 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| Data | Entity | <details><summary>[OBReadDataScheduledPayment3](#OBReadDataScheduledPayment3)</summary><ul><li>ScheduledPayment [array[[OBScheduledPayment3](#OBScheduledPayment3)]]</li> </ul></details> | \n| Links | Entity | <details><summary>[Links](#Links)</summary><ul><li>Self [string]</li> <li>First [string]</li> <li>Prev [string]</li> <li>Next [string]</li> <li>Last [string]</li> </ul></details> | \n| Meta | Entity | <details><summary>[Meta](#Meta)</summary><ul><li>TotalPages [integer]</li> <li>FirstAvailableDateTime [string]</li> <li>LastAvailableDateTime [string]</li> </ul></details> | \n\n <a name=OBExternalStandingOrderStatus1Code></a> \n## OBExternalStandingOrderStatus1Code \n### Attributes \n\n| Type| Description| Example| Values|\n| -----| -----| -----| -----|\n| enum| -| <ul style=\"padding-left: 0\"><li>Active</li><li>Inactive</li></ul>|\n\n <a name=OBStandingOrder5></a> \n## OBStandingOrder5 \n\n\n### Attributes \n\n| Name| Description| Values|\n| -----| -----| -----|\n| AccountId| A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.| string|\n| StandingOrderId| A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.| string|\n| Frequency| Individual Definitions: IntrvlMnthDay - An interval specified in months(between 01, 02, 03, 04, 06, 12, 24), specifying the day within the month(01 to 31) Full Regular Expression: ^(IntrvlMnthDay:(0[1,2,3,4,6]|12|24):(0[1-9]|[12] [0-9]|3[01]))$| string|\n| Reference| Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.| string|\n| FirstPaymentDateTime| The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone.An example is below: 2017-04-05T10:43:07+00:00| string|\n| NextPaymentDateTime| The date on which the next payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone.An example is below: 2017-04-05T10:43:07+00:00| string|\n| LastPaymentDateTime| The date on which the last (most recent) payment for a Standing Order schedule was made.All dates in the JSON payloads are represented in ISO 8601 date-time