","operationId":"API-BUILDERb1-getTemplate","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TemplateJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}}},"definitions":{"ErrorHostnameNotSpecified":{"properties":{"message":{"type":"string","example":"OBP-00001: Hostname not specified. Could not get hostname from Props. Please edit your props file. Here are some example settings: hostname=http://127.0.0.1:8080 or hostname=https://www.example.com"}}},"ErrorDataImportDisabled":{"properties":{"message":{"type":"string","example":"OBP-00002: Data import is disabled for this API instance."}}},"ErrorTransactionDisabled":{"properties":{"message":{"type":"string","example":"OBP-00003: Transaction Requests is disabled in this API instance."}}},"ErrorServerAddDataError":{"properties":{"message":{"type":"string","example":"OBP-00004: Server error: could not add message"}}},"ErrorPublicViewsNotAllowedOnThisInstance":{"properties":{"message":{"type":"string","example":"OBP-00005: Public views not allowed on this instance. Please set allow_public_views = true in props files. "}}},"ErrorRemoteDataSecretMatchError":{"properties":{"message":{"type":"string","example":"OBP-00006: Remote data secret cannot be matched! Check OBP-API and OBP-Storage Props values for remotedata.hostname, remotedata.port and remotedata.secret."}}},"ErrorRemoteDataSecretObtainError":{"properties":{"message":{"type":"string","example":"OBP-00007: Remote data secret cannot be obtained! Check OBP-API and OBP-Storage Props values for remotedata.hostname, remotedata.port and remotedata.secret."}}},"ErrorApiVersionNotSupported":{"properties":{"message":{"type":"string","example":"OBP-00008: The API version you called is not enabled on this server. Please contact your API administrator or use another version."}}},"ErrorFirehoseViewsNotAllowedOnThisInstance":{"properties":{"message":{"type":"string","example":"OBP-00009: Firehose views not allowed on this instance. Please set allow_firehose_views = true in props files. "}}},"ErrorMissingPropsValueAtThisInstance":{"properties":{"message":{"type":"string","example":"OBP-00010: Missing props value at this API instance - "}}},"ErrorNoValidElasticsearchIndicesConfigured":{"properties":{"message":{"type":"string","example":"OBP-00011: No elasticsearch indices are allowed on this instance. Please set es.warehouse.allowed.indices = index1,index2 (or = ALL for all). "}}},"ErrorInvalidJsonFormat":{"properties":{"message":{"type":"string","example":"OBP-10001: Incorrect json format."}}},"ErrorInvalidNumber":{"properties":{"message":{"type":"string","example":"OBP-10002: Invalid Number. Could not convert value to a number."}}},"ErrorInvalidISOCurrencyCode":{"properties":{"message":{"type":"string","example":"OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code. "}}},"ErrorFXCurrencyCodeCombinationsNotSupported":{"properties":{"message":{"type":"string","example":"OBP-10004: ISO Currency code combination not supported for FX. Please modify the FROM_CURRENCY_CODE or TO_CURRENCY_CODE. "}}},"ErrorInvalidDateFormat":{"properties":{"message":{"type":"string","example":"OBP-10005: Invalid Date Format. Could not convert value to a Date."}}},"ErrorInvalidCurrency":{"properties":{"message":{"type":"string","example":"OBP-10006: Invalid Currency Value."}}},"ErrorIncorrectRoleName":{"properties":{"message":{"type":"string","example":"OBP-10007: Incorrect Role name: "}}},"ErrorCouldNotTransformJsonToInternalModel":{"properties":{"message":{"type":"string","example":"OBP-10008: Could not transform Json to internal model."}}},"ErrorCountNotSaveOrUpdateResource":{"properties":{"message":{"type":"string","example":"OBP-10009: Could not save or update resource."}}},"ErrorNotImplemented":{"properties":{"message":{"type":"string","example":"OBP-10010: Not Implemented "}}},"ErrorInvalidFutureDateValue":{"properties":{"message":{"type":"string","example":"OBP-10011: future_date has to be in future."}}},"ErrormaximumLimitExceeded":{"properties":{"message":{"type":"string","example":"OBP-10012: Invalid value. Maximum number is 10000."}}},"ErrorattemptedToOpenAnEmptyBox":{"properties":{"message":{"type":"string","example":"OBP-10013: Attempted to open an empty Box."}}},"ErrorcannotDecryptValueOfProperty":{"properties":{"message":{"type":"string","example":"OBP-10014: Could not decrypt value of property "}}},"ErrorAllowedValuesAre":{"properties":{"message":{"type":"string","example":"OBP-10015: Allowed values are: "}}},"ErrorInvalidFilterParameterFormat":{"properties":{"message":{"type":"string","example":"OBP-10016: Incorrect filter Parameters in URL. "}}},"ErrorInvalidUrl":{"properties":{"message":{"type":"string","example":"OBP-10017: Incorrect URL Format. "}}},"ErrorTooManyRequests":{"properties":{"message":{"type":"string","example":"OBP-10018: Too Many Requests."}}},"ErrorInvalidBoolean":{"properties":{"message":{"type":"string","example":"OBP-10019: Invalid Boolean. Could not convert value to a boolean type."}}},"ErrorInvalidUri":{"properties":{"message":{"type":"string","example":"OBP-404: 404 Not Found. The server has not found anything matching the Request-URI.Check your URL and the headers. NOTE: when it is POST or PUT api, the Content-Type must be `application/json`. OBP only support the json format body."}}},"ErrorFilterSortDirectionError":{"properties":{"message":{"type":"string","example":"OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC!"}}},"ErrorFilterOffersetError":{"properties":{"message":{"type":"string","example":"OBP-10024: wrong value for obp_offset parameter. Please send a positive integer (=>0)!"}}},"ErrorFilterLimitError":{"properties":{"message":{"type":"string","example":"OBP-10025: wrong value for obp_limit parameter. Please send a positive integer (=>1)!"}}},"ErrorFilterDateFormatError":{"properties":{"message":{"type":"string","example":"OBP-10026: Failed to parse date string. Please use this format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'!"}}},"ErrorFilterAnonFormatError":{"properties":{"message":{"type":"string","example":"OBP-10028: anon parameter can only take two values: TRUE or FALSE!"}}},"ErrorFilterDurationFormatError":{"properties":{"message":{"type":"string","example":"OBP-10029: wrong value for `duration` parameter. Please send a positive integer (=>0)!"}}},"ErrorInvalidApiVersionString":{"properties":{"message":{"type":"string","example":"OBP-00027: Invalid API Version string. We could not find the version specified."}}},"ErrorIncorrectTriggerName":{"properties":{"message":{"type":"string","example":"OBP-10028: Incorrect Trigger name: "}}},"ErrorUserNotLoggedIn":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"ErrorDirectLoginMissingParameters":{"properties":{"message":{"type":"string","example":"OBP-20002: These DirectLogin parameters are missing: "}}},"ErrorDirectLoginInvalidToken":{"properties":{"message":{"type":"string","example":"OBP-20003: This DirectLogin token is invalid or expired: "}}},"ErrorInvalidLoginCredentials":{"properties":{"message":{"type":"string","example":"OBP-20004: Invalid login credentials. Check username/password."}}},"ErrorUserNotFoundById":{"properties":{"message":{"type":"string","example":"OBP-20005: User not found. Please specify a valid value for USER_ID."}}},"ErrorUserHasMissingRoles":{"properties":{"message":{"type":"string","example":"OBP-20006: User is missing one or more roles: "}}},"ErrorUserNotFoundByEmail":{"properties":{"message":{"type":"string","example":"OBP-20007: User not found by email."}}},"ErrorInvalidConsumerKey":{"properties":{"message":{"type":"string","example":"OBP-20008: Invalid Consumer Key."}}},"ErrorInvalidConsumerCredentials":{"properties":{"message":{"type":"string","example":"OBP-20009: Invalid consumer credentials"}}},"ErrorInvalidValueLength":{"properties":{"message":{"type":"string","example":"OBP-20010: Value too long"}}},"ErrorInvalidValueCharacters":{"properties":{"message":{"type":"string","example":"OBP-20011: Value contains invalid characters"}}},"ErrorInvalidDirectLoginParameters":{"properties":{"message":{"type":"string","example":"OBP-20012: Invalid direct login parameters"}}},"ErrorUsernameHasBeenLocked":{"properties":{"message":{"type":"string","example":"OBP-20013: The account has been locked, please contact administrator !"}}},"ErrorInvalidConsumerId":{"properties":{"message":{"type":"string","example":"OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID."}}},"ErrorUserNoPermissionUpdateConsumer":{"properties":{"message":{"type":"string","example":"OBP-20015: Only the developer that created the consumer key should be able to edit it, please login with the right user."}}},"ErrorUnexpectedErrorDuringLogin":{"properties":{"message":{"type":"string","example":"OBP-20016: An unexpected login error occurred. Please try again."}}},"ErrorUserNoPermissionAccessView":{"properties":{"message":{"type":"string","example":"OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID."}}},"ErrorInvalidInternalRedirectUrl":{"properties":{"message":{"type":"string","example":"OBP-20018: Login failed, invalid internal redirectUrl."}}},"ErrorUserNoOwnerView":{"properties":{"message":{"type":"string","example":"OBP-20019: User does not have access to owner view. "}}},"ErrorInvalidCustomViewFormat":{"properties":{"message":{"type":"string","example":"OBP-20020: View name must start with `_`. eg: _work, _life "}}},"ErrorSystemViewsCanNotBeModified":{"properties":{"message":{"type":"string","example":"OBP-20021: System Views can not be modified. Only the created views can be modified."}}},"ErrorViewDoesNotPermitAccess":{"properties":{"message":{"type":"string","example":"OBP-20022: View does not permit the access."}}},"ErrorConsumerHasMissingRoles":{"properties":{"message":{"type":"string","example":"OBP-20023: Consumer is missing one or more roles: "}}},"ErrorConsumerNotFoundById":{"properties":{"message":{"type":"string","example":"OBP-20024: Consumer not found. Please specify a valid value for CONSUMER_ID."}}},"ErrorScopeNotFound":{"properties":{"message":{"type":"string","example":"OBP-20025: Scope not found. Please specify a valid value for SCOPE_ID."}}},"ErrorConsumerDoesNotHaveScope":{"properties":{"message":{"type":"string","example":"OBP-20026: CONSUMER_ID does not have the SCOPE_ID "}}},"ErrorUserNotFoundByUsername":{"properties":{"message":{"type":"string","example":"OBP-20027: User not found by username."}}},"ErrorGatewayLoginMissingParameters":{"properties":{"message":{"type":"string","example":"OBP-20028: These GatewayLogin parameters are missing: "}}},"ErrorGatewayLoginUnknownError":{"properties":{"message":{"type":"string","example":"OBP-20029: Unknown Gateway login error."}}},"ErrorGatewayLoginHostPropertyMissing":{"properties":{"message":{"type":"string","example":"OBP-20030: Property gateway.host is not defined."}}},"ErrorGatewayLoginWhiteListAddresses":{"properties":{"message":{"type":"string","example":"OBP-20031: Gateway login can be done only from allowed addresses."}}},"ErrorGatewayLoginJwtTokenIsNotValid":{"properties":{"message":{"type":"string","example":"OBP-20040: The JWT is corrupted/changed during a transport."}}},"ErrorGatewayLoginCannotExtractJwtToken":{"properties":{"message":{"type":"string","example":"OBP-20041: Header, Payload and Signature cannot be extracted from the JWT."}}},"ErrorGatewayLoginNoNeedToCallCbs":{"properties":{"message":{"type":"string","example":"OBP-20042: There is no need to call CBS"}}},"ErrorGatewayLoginCannotFindUser":{"properties":{"message":{"type":"string","example":"OBP-20043: User cannot be found. Please initiate CBS communication in order to create it."}}},"ErrorGatewayLoginCannotGetCbsToken":{"properties":{"message":{"type":"string","example":"OBP-20044: Cannot get the CBSToken response from South side"}}},"ErrorGatewayLoginCannotGetOrCreateUser":{"properties":{"message":{"type":"string","example":"OBP-20045: Cannot get or create user during GatewayLogin process."}}},"ErrorGatewayLoginNoJwtForResponse":{"properties":{"message":{"type":"string","example":"OBP-20046: There is no useful value for JWT."}}},"ErrorUserNotSuperAdmin":{"properties":{"message":{"type":"string","example":"OBP-20050: Current User is not a Super Admin!"}}},"ErrorElasticSearchIndexNotFound":{"properties":{"message":{"type":"string","example":"OBP-20051: Elasticsearch index or indices not found."}}},"ErrorNotEnoughtSearchStatisticsResults":{"properties":{"message":{"type":"string","example":"OBP-20052: Result set too small. Will not be displayed for reasons of privacy."}}},"ErrorElasticSearchEmptyQueryBody":{"properties":{"message":{"type":"string","example":"OBP-20053: The Elasticsearch query body cannot be empty"}}},"ErrorElasticSearchDisabled":{"properties":{"message":{"type":"string","example":"OBP-20056: Elasticsearch is disabled for this API instance."}}},"ErrorOauth2IsNotAllowed":{"properties":{"message":{"type":"string","example":"OBP-20201: OAuth2 is not allowed at this instance."}}},"ErrorOauth2IJwtCannotBeVerified":{"properties":{"message":{"type":"string","example":"OBP-20202: OAuth2's Access Token cannot be verified."}}},"ErrorOauth2ThereIsNoUrlOfJwkSet":{"properties":{"message":{"type":"string","example":"OBP-20203: There is no an URL of OAuth 2.0 server's JWK set, published at a well-known URL."}}},"ErrorOauth2BadJWTException":{"properties":{"message":{"type":"string","example":"OBP-20204: Bad JWT error. "}}},"ErrorOauth2ParseException":{"properties":{"message":{"type":"string","example":"OBP-20205: Parse error. "}}},"ErrorOauth2BadJOSEException":{"properties":{"message":{"type":"string","example":"OBP-20206: Bad JSON Object Signing and Encryption (JOSE) exception. "}}},"ErrorOauth2JOSEException":{"properties":{"message":{"type":"string","example":"OBP-20207: Javascript Object Signing and Encryption (JOSE) exception. "}}},"ErrorOauth2CannotMatchIssuerAndJwksUriException":{"properties":{"message":{"type":"string","example":"OBP-20208: Cannot match the issuer and JWKS URI at this server instance. "}}},"ErrorInvalidAmount":{"properties":{"message":{"type":"string","example":"OBP-20054: Invalid amount. Please specify a valid value for amount."}}},"ErrorMissingQueryParams":{"properties":{"message":{"type":"string","example":"OBP-20055: These query parameters are missing: "}}},"ErrorUserNotSuperAdminOrMissRole":{"properties":{"message":{"type":"string","example":"OBP-20101: Current User is not super admin or is missing entitlements: "}}},"ErrorBankNotFound":{"properties":{"message":{"type":"string","example":"OBP-30001: Bank not found. Please specify a valid value for BANK_ID."}}},"ErrorCustomerNotFound":{"properties":{"message":{"type":"string","example":"OBP-30002: Customer not found. Please specify a valid value for CUSTOMER_NUMBER."}}},"ErrorCustomerNotFoundByCustomerId":{"properties":{"message":{"type":"string","example":"OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID."}}},"ErrorAccountNotFound":{"properties":{"message":{"type":"string","example":"OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID."}}},"ErrorCounterpartyNotFound":{"properties":{"message":{"type":"string","example":"OBP-30004: Counterparty not found. The BANK_ID / ACCOUNT_ID specified does not exist on this server."}}},"ErrorViewNotFound":{"properties":{"message":{"type":"string","example":"OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID"}}},"ErrorCustomerNumberAlreadyExists":{"properties":{"message":{"type":"string","example":"OBP-30006: Customer Number already exists. Please specify a different value for BANK_ID or CUSTOMER_NUMBER."}}},"ErrorCustomerAlreadyExistsForUser":{"properties":{"message":{"type":"string","example":"OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID"}}},"ErrorUserCustomerLinksNotFoundForUser":{"properties":{"message":{"type":"string","example":"OBP-30008: User Customer Link not found by USER_ID"}}},"ErrorAtmNotFoundByAtmId":{"properties":{"message":{"type":"string","example":"OBP-30009: ATM not found. Please specify a valid value for ATM_ID."}}},"ErrorBranchNotFoundByBranchId":{"properties":{"message":{"type":"string","example":"OBP-300010: Branch not found. Please specify a valid value for BRANCH_ID."}}},"ErrorProductNotFoundByProductCode":{"properties":{"message":{"type":"string","example":"OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE."}}},"ErrorCounterpartyNotFoundByIban":{"properties":{"message":{"type":"string","example":"OBP-30012: Counterparty not found. Please specify a valid value for IBAN."}}},"ErrorCounterpartyBeneficiaryPermit":{"properties":{"message":{"type":"string","example":"OBP-30013: The account can not send money to the Counterparty. Please set the Counterparty 'isBeneficiary' true first"}}},"ErrorCounterpartyAlreadyExists":{"properties":{"message":{"type":"string","example":"OBP-30014: Counterparty already exists. Please specify a different value for BANK_ID or ACCOUNT_ID or VIEW_ID or NAME."}}},"ErrorCreateBranchError":{"properties":{"message":{"type":"string","example":"OBP-30015: Could not insert the Branch"}}},"ErrorUpdateBranchError":{"properties":{"message":{"type":"string","example":"OBP-30016: Could not update the Branch"}}},"ErrorCounterpartyNotFoundByCounterpartyId":{"properties":{"message":{"type":"string","example":"OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID."}}},"ErrorBankAccountNotFound":{"properties":{"message":{"type":"string","example":"OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. "}}},"ErrorConsumerNotFoundByConsumerId":{"properties":{"message":{"type":"string","example":"OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID."}}},"ErrorCreateBankError":{"properties":{"message":{"type":"string","example":"OBP-30020: Could not create the Bank"}}},"ErrorUpdateBankError":{"properties":{"message":{"type":"string","example":"OBP-30021: Could not update the Bank"}}},"ErrorNoViewPermission":{"properties":{"message":{"type":"string","example":"OBP-30022: The current view does not have the permission: "}}},"ErrorUpdateConsumerError":{"properties":{"message":{"type":"string","example":"OBP-30023: Cannot update Consumer "}}},"ErrorCreateConsumerError":{"properties":{"message":{"type":"string","example":"OBP-30024: Could not create Consumer "}}},"ErrorCreateUserCustomerLinksError":{"properties":{"message":{"type":"string","example":"OBP-30025: Could not create user_customer_links "}}},"ErrorConsumerKeyAlreadyExists":{"properties":{"message":{"type":"string","example":"OBP-30026: Consumer Key already exists. Please specify a different value."}}},"ErrorNoExistingAccountHolders":{"properties":{"message":{"type":"string","example":"OBP-30027: Account Holders not found. The BANK_ID / ACCOUNT_ID specified for account holder does not exist on this server"}}},"ErrorCreateAtmError":{"properties":{"message":{"type":"string","example":"OBP-30028: Could not insert the ATM"}}},"ErrorUpdateAtmError":{"properties":{"message":{"type":"string","example":"OBP-30029: Could not update the ATM"}}},"ErrorCreateProductError":{"properties":{"message":{"type":"string","example":"OBP-30030: Could not insert the Product"}}},"ErrorUpdateProductError":{"properties":{"message":{"type":"string","example":"OBP-30031: Could not update the Product"}}},"ErrorCreateCardError":{"properties":{"message":{"type":"string","example":"OBP-30032: Could not insert the Card"}}},"ErrorUpdateCardError":{"properties":{"message":{"type":"string","example":"OBP-30033: Could not update the Card"}}},"ErrorViewIdNotSupported":{"properties":{"message":{"type":"string","example":"OBP-30034: This ViewId is do not supported. Only support four now: Owner, Public, Accountant, Auditor."}}},"ErrorUserCustomerLinkNotFound":{"properties":{"message":{"type":"string","example":"OBP-30035: User Customer Link not found"}}},"ErrorCreateOrUpdateCounterpartyMetadataError":{"properties":{"message":{"type":"string","example":"OBP-30036: Could not create or update CounterpartyMetadata"}}},"ErrorCounterpartyMetadataNotFound":{"properties":{"message":{"type":"string","example":"OBP-30037: CounterpartyMetadata not found. Please specify valid values for BANK_ID, ACCOUNT_ID and COUNTERPARTY_ID. "}}},"ErrorCreateFxRateError":{"properties":{"message":{"type":"string","example":"OBP-30038: Could not insert the Fx Rate"}}},"ErrorUpdateFxRateError":{"properties":{"message":{"type":"string","example":"OBP-30039: Could not update the Fx Rate"}}},"ErrorUnknownFxRateError":{"properties":{"message":{"type":"string","example":"OBP-30040: Unknown Fx Rate error"}}},"ErrorCheckbookOrderNotFound":{"properties":{"message":{"type":"string","example":"OBP-30041: CheckbookOrder not found for Account. "}}},"ErrorGetTopApisError":{"properties":{"message":{"type":"string","example":"OBP-30042: Could not get the top apis from database. "}}},"ErrorGetMetricsTopConsumersError":{"properties":{"message":{"type":"string","example":"OBP-30045: Could not get the top consumers from database. "}}},"ErrorGetAggregateMetricsError":{"properties":{"message":{"type":"string","example":"OBP-30043: Could not get the aggregate metrics from database. "}}},"ErrorDefaultBankIdNotSet":{"properties":{"message":{"type":"string","example":"OBP-30044: Default BankId is not set on this instance. Please set defaultBank.bank_id in props files. "}}},"ErrorCreateWebhookError":{"properties":{"message":{"type":"string","example":"OBP-30047: Cannot create Webhook"}}},"ErrorGetWebhooksError":{"properties":{"message":{"type":"string","example":"OBP-30048: Cannot get Webhooks"}}},"ErrorUpdateWebhookError":{"properties":{"message":{"type":"string","example":"OBP-30049: Cannot create Webhook"}}},"ErrorWebhookNotFound":{"properties":{"message":{"type":"string","example":"OBP-30050: Webhook not found. Please specify a valid value for account_webhook_id."}}},"ErrorCreateCustomerError":{"properties":{"message":{"type":"string","example":"OBP-30051: Cannot create Customer"}}},"ErrorCheckCustomerError":{"properties":{"message":{"type":"string","example":"OBP-30052: Cannot check Customer"}}},"ErrorCreateUserAuthContextError":{"properties":{"message":{"type":"string","example":"OBP-30053: Could not insert the UserAuthContext"}}},"ErrorUpdateUserAuthContextError":{"properties":{"message":{"type":"string","example":"OBP-30054: Could not update the UserAuthContext"}}},"ErrorUpdateUserAuthContextNotFound":{"properties":{"message":{"type":"string","example":"OBP-30055: UserAuthContext not found. Please specify a valid value for USER_ID."}}},"ErrorDeleteUserAuthContextNotFound":{"properties":{"message":{"type":"string","example":"OBP-30056: UserAuthContext not found by USER_AUTH_CONTEXT_ID."}}},"ErrorMeetingsNotSupported":{"properties":{"message":{"type":"string","example":"OBP-30101: Meetings are not supported on this server."}}},"ErrorMeetingApiKeyNotConfigured":{"properties":{"message":{"type":"string","example":"OBP-30102: Meeting provider API Key is not configured."}}},"ErrorMeetingApiSecretNotConfigured":{"properties":{"message":{"type":"string","example":"OBP-30103: Meeting provider Secret is not configured."}}},"ErrorMeetingNotFound":{"properties":{"message":{"type":"string","example":"OBP-30104: Meeting not found."}}},"ErrorInvalidAccountBalanceCurrency":{"properties":{"message":{"type":"string","example":"OBP-30105: Invalid Balance Currency."}}},"ErrorInvalidAccountBalanceAmount":{"properties":{"message":{"type":"string","example":"OBP-30106: Invalid Balance Amount."}}},"ErrorInvalidUserId":{"properties":{"message":{"type":"string","example":"OBP-30107: Invalid User Id."}}},"ErrorInvalidAccountType":{"properties":{"message":{"type":"string","example":"OBP-30108: Invalid Account Type."}}},"ErrorInitialBalanceMustBeZero":{"properties":{"message":{"type":"string","example":"OBP-30109: Initial Balance of Account must be Zero (0)."}}},"ErrorInvalidAccountIdFormat":{"properties":{"message":{"type":"string","example":"OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255."}}},"ErrorInvalidBankIdFormat":{"properties":{"message":{"type":"string","example":"OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255."}}},"ErrorInvalidAccountInitialBalance":{"properties":{"message":{"type":"string","example":"OBP-30112: Invalid Number. Initial balance must be a number, e.g 1000.00"}}},"ErrorEntitlementIsBankRole":{"properties":{"message":{"type":"string","example":"OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id."}}},"ErrorEntitlementIsSystemRole":{"properties":{"message":{"type":"string","example":"OBP-30206: This entitlement is a System Role. Please set bank_id to empty string."}}},"ErrorInvalidStrongPasswordFormat":{"properties":{"message":{"type":"string","example":"OBP-30207: Invalid Password Format. Your password should EITHER be at least 10 characters long and contain mixed numbers and both upper and lower case letters and at least one special character, OR be longer than 16 characters."}}},"ErrorAccountIdAlreadyExists":{"properties":{"message":{"type":"string","example":"OBP-30208: Account_ID already exists at the Bank."}}},"ErrorInsufficientAuthorisationToCreateBranch":{"properties":{"message":{"type":"string","example":"OBP-30209: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch."}}},"ErrorInsufficientAuthorisationToDeleteBranch":{"properties":{"message":{"type":"string","example":"OBP-30218: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch."}}},"ErrorInsufficientAuthorisationToCreateBank":{"properties":{"message":{"type":"string","example":"OBP-30210: Insufficient authorisation to Create Bank. You do not have the role CanCreateBank."}}},"ErrorInvalidConnector":{"properties":{"message":{"type":"string","example":"OBP-30211: Invalid Connector Version. Please specify a valid value for CONNECTOR."}}},"ErrorEntitlementNotFound":{"properties":{"message":{"type":"string","example":"OBP-30212: EntitlementId not found"}}},"ErrorUserDoesNotHaveEntitlement":{"properties":{"message":{"type":"string","example":"OBP-30213: USER_ID does not have the ENTITLEMENT_ID."}}},"ErrorEntitlementRequestAlreadyExists":{"properties":{"message":{"type":"string","example":"OBP-30214: Entitlement Request already exists for the user."}}},"ErrorEntitlementRequestCannotBeAdded":{"properties":{"message":{"type":"string","example":"OBP-30217: Entitlement Request cannot be added."}}},"ErrorEntitlementRequestNotFound":{"properties":{"message":{"type":"string","example":"OBP-30215: EntitlementRequestId not found"}}},"ErrorEntitlementAlreadyExists":{"properties":{"message":{"type":"string","example":"OBP-30216: Entitlement already exists for the user."}}},"ErrorTaxResidenceNotFound":{"properties":{"message":{"type":"string","example":"OBP-30300: Tax Residence not found by TAX_RESIDENCE_ID. "}}},"ErrorCustomerAddressNotFound":{"properties":{"message":{"type":"string","example":"OBP-30310: Customer's Address not found by CUSTOMER_ADDRESS_ID. "}}},"ErrorAccountApplicationNotFound":{"properties":{"message":{"type":"string","example":"OBP-30311: AccountApplication not found by ACCOUNT_APPLICATION_ID. "}}},"ErrorResourceUserNotFound":{"properties":{"message":{"type":"string","example":"OBP-30312: ResourceUser not found by USER_ID. "}}},"ErrorUserIdAndCustomerIdNotPresent":{"properties":{"message":{"type":"string","example":"OBP-30313: userId and customerId not present. "}}},"ErrorAccountApplicationAlreadyAccepted":{"properties":{"message":{"type":"string","example":"OBP-30314: AccountApplication has already been accepted. "}}},"ErrorUpdateAccountApplicationStatusError":{"properties":{"message":{"type":"string","example":"OBP-30315: AccountApplication Status can not be updated. "}}},"ErrorCreateAccountApplicationError":{"properties":{"message":{"type":"string","example":"OBP-30316: AccountApplication Status can not be created. "}}},"ErrorbranchesNotFoundLicense":{"properties":{"message":{"type":"string","example":"OBP-32001: No branches available. License may not be set."}}},"ErrorBranchesNotFound":{"properties":{"message":{"type":"string","example":"OBP-32002: No branches available."}}},"ErroratmsNotFoundLicense":{"properties":{"message":{"type":"string","example":"OBP-33001: No ATMs available. License may not be set."}}},"ErroratmsNotFound":{"properties":{"message":{"type":"string","example":"OBP-33002: No ATMs available."}}},"ErrorInvalidTransactionRequestType":{"properties":{"message":{"type":"string","example":"OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE"}}},"ErrorInsufficientAuthorisationToCreateTransactionRequest":{"properties":{"message":{"type":"string","example":"OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because you don't have access to the owner view of the from account or you don't have access to canCreateAnyTransactionRequest."}}},"ErrorInvalidTransactionRequestCurrency":{"properties":{"message":{"type":"string","example":"OBP-40003: Transaction Request Currency must be the same as From Account Currency."}}},"ErrorInvalidTransactionRequestId":{"properties":{"message":{"type":"string","example":"OBP-40004: Transaction Request Id not found."}}},"ErrorInsufficientAuthorisationToCreateTransactionType":{"properties":{"message":{"type":"string","example":"OBP-40005: Insufficient authorisation to Create Transaction Type offered by the bank. The Request could not be created because you don't have access to CanCreateTransactionType."}}},"ErrorCreateTransactionTypeInsertError":{"properties":{"message":{"type":"string","example":"OBP-40006: Could not insert Transaction Type: Non unique BANK_ID / SHORT_CODE"}}},"ErrorCreateTransactionTypeUpdateError":{"properties":{"message":{"type":"string","example":"OBP-40007: Could not update Transaction Type: Non unique BANK_ID / SHORT_CODE"}}},"ErrorNotPositiveAmount":{"properties":{"message":{"type":"string","example":"OBP-40008: Can't send a payment with a value of 0 or less."}}},"ErrorTransactionRequestTypeHasChanged":{"properties":{"message":{"type":"string","example":"OBP-40009: The TRANSACTION_REQUEST_TYPE has changed."}}},"ErrorInvalidTransactionRequesChallengeId":{"properties":{"message":{"type":"string","example":"OBP-40010: Invalid Challenge Id. Please specify a valid value for CHALLENGE_ID."}}},"ErrorTransactionRequestStatusNotInitiated":{"properties":{"message":{"type":"string","example":"OBP-40011: Transaction Request Status is not INITIATED."}}},"ErrorCounterpartyNotFoundOtherAccountProvider":{"properties":{"message":{"type":"string","example":"OBP-40012: Please set up the otherAccountRoutingScheme and otherBankRoutingScheme fields of the Counterparty to 'OBP'"}}},"ErrorInvalidChargePolicy":{"properties":{"message":{"type":"string","example":"OBP-40013: Invalid Charge Policy. Please specify a valid value for Charge_Policy: SHARED, SENDER or RECEIVER. "}}},"ErrorAllowedAttemptsUsedUp":{"properties":{"message":{"type":"string","example":"OBP-40014: Sorry, you've used up your allowed attempts. "}}},"ErrorInvalidChallengeType":{"properties":{"message":{"type":"string","example":"OBP-40015: Invalid Challenge Type. Please specify a valid value for CHALLENGE_TYPE, when you create the transaction request."}}},"ErrorInvalidChallengeAnswer":{"properties":{"message":{"type":"string","example":"OBP-40016: Invalid Challenge Answer. Please specify a valid value for answer in Json body. If it is sandbox mode, the answer must be `123`. If it kafka mode, the answer can be got by phone message or other security ways."}}},"ErrorInvalidPhoneNumber":{"properties":{"message":{"type":"string","example":"OBP-40017: Invalid Phone Number. Please specify a valid value for PHONE_NUMBER. Eg:+9722398746 "}}},"ErrorTransactionRequestsNotEnabled":{"properties":{"message":{"type":"string","example":"OBP-40018: Sorry, Transaction Requests are not enabled in this API instance."}}},"ErrorUnknownError":{"properties":{"message":{"type":"string","example":"OBP-50000: Unknown Error."}}},"ErrorFutureTimeoutException":{"properties":{"message":{"type":"string","example":"OBP-50001: Future Timeout Exception."}}},"ErrorKafkaMessageClassCastException":{"properties":{"message":{"type":"string","example":"OBP-50002: Kafka Response Message Class Cast Exception."}}},"ErrorAdapterOrCoreBankingSystemException":{"properties":{"message":{"type":"string","example":"OBP-50003: Adapter Or Core Banking System Exception. Failed to get a valid response from the south side Adapter or Core Banking System."}}},"ErrorCurrentUserNotFoundException":{"properties":{"message":{"type":"string","example":"OBP-50004: Method (AuthUser.getCurrentUser) can not find the current user in the current context!"}}},"ErrorAnUnspecifiedOrInternalErrorOccurred":{"properties":{"message":{"type":"string","example":"OBP-50005: An unspecified or internal error occurred."}}},"ErrorKafkaInterruptedException":{"properties":{"message":{"type":"string","example":"OBP-50006: Kafka interrupted exception."}}},"ErrorKafkaExecutionException":{"properties":{"message":{"type":"string","example":"OBP-50007: Kafka execution exception."}}},"ErrorKafkaStreamTimeoutException":{"properties":{"message":{"type":"string","example":"OBP-50008: Akka Kafka stream timeout exception."}}},"ErrorKafkaUnknownError":{"properties":{"message":{"type":"string","example":"OBP-50009: Kafka unknown error."}}},"ErrorScalaEmptyBoxToLiftweb":{"properties":{"message":{"type":"string","example":"OBP-50010: Scala return Empty box to Liftweb."}}},"ErrorNoCallContext":{"properties":{"message":{"type":"string","example":"OBP-50012: Can not get the CallContext object here."}}},"ErrorUnspecifiedCbsError":{"properties":{"message":{"type":"string","example":"OBP-50013: The Core Banking System returned an unspecified error or response."}}},"ErrorRefreshUserError":{"properties":{"message":{"type":"string","example":"OBP-50014: Can not refresh User."}}},"ErrorInternalServerError":{"properties":{"message":{"type":"string","example":"OBP-50015: The server encountered an unexpected condition which prevented it from fulfilling the request."}}},"ErrorConnectorEmptyResponse":{"properties":{"message":{"type":"string","example":"OBP-50200: Connector cannot return the data we requested."}}},"ErrorInvalidConnectorResponseForGetBankAccounts":{"properties":{"message":{"type":"string","example":"OBP-50201: Connector did not return the set of accounts we requested."}}},"ErrorInvalidConnectorResponseForGetBankAccount":{"properties":{"message":{"type":"string","example":"OBP-50202: Connector did not return the account we requested."}}},"ErrorInvalidConnectorResponseForGetTransaction":{"properties":{"message":{"type":"string","example":"OBP-50203: Connector did not return the transaction we requested."}}},"ErrorInvalidConnectorResponseForGetTransactions":{"properties":{"message":{"type":"string","example":"OBP-50204: Connector did not return the set of transactions we requested."}}},"ErrorInvalidConnectorResponseForGetTransactionRequests210":{"properties":{"message":{"type":"string","example":"OBP-50205: Connector did not return the set of transaction requests we requested."}}},"ErrorInvalidConnectorResponseForGetChallengeThreshold":{"properties":{"message":{"type":"string","example":"OBP-50206: Connector did not return the set of challenge threshold we requested."}}},"ErrorInvalidConnectorResponseForGetChargeLevel":{"properties":{"message":{"type":"string","example":"OBP-50207: Connector did not return the set of challenge level we requested."}}},"ErrorInvalidConnectorResponseForCreateTransactionRequestImpl210":{"properties":{"message":{"type":"string","example":"OBP-50208: Connector did not return the set of transactions requests we requested."}}},"ErrorInvalidConnectorResponseForMakePayment":{"properties":{"message":{"type":"string","example":"OBP-50209: Connector did not return the set of transactions we requested."}}},"ErrorInvalidConnectorResponseForMakePaymentv200":{"properties":{"message":{"type":"string","example":"OBP-50210: Connector did not return the set of transaction id we requested."}}},"ErrorInvalidConnectorResponseForGetCheckbookOrdersFuture":{"properties":{"message":{"type":"string","example":"OBP-50211: Connector did not return the set of check book."}}},"ErrorInvalidConnectorResponseForGetStatusOfCreditCardOrderFuture":{"properties":{"message":{"type":"string","example":"OBP-50212: Connector did not return the set of status of credit card."}}},"ErrorInvalidConnectorResponseForCreateTransactionAfterChallengev300":{"properties":{"message":{"type":"string","example":"OBP-50213: The Connector did not return a valid response for payments."}}},"ErrorGetStatusException":{"properties":{"message":{"type":"string","example":"OBP-60001: Save Transaction Exception. "}}},"ErrorGetChargeValueException":{"properties":{"message":{"type":"string","example":"OBP-60002: Get ChargeValue Exception. "}}},"ErrorCreateTransactionsException":{"properties":{"message":{"type":"string","example":"OBP-60003: Create transaction Exception. "}}},"ErrorUpdateBankAccountException":{"properties":{"message":{"type":"string","example":"OBP-60004: Update bank account Exception. "}}},"ErrorSaveTransactionRequestTransactionException":{"properties":{"message":{"type":"string","example":"OBP-60005: Save Transaction Request Transaction Exception. "}}},"ErrorSaveTransactionRequestChallengeException":{"properties":{"message":{"type":"string","example":"OBP-60006: Save Transaction Request Challenge Exception. "}}},"ErrorSaveTransactionRequestStatusException":{"properties":{"message":{"type":"string","example":"OBP-60007: Save Transaction Request Status Exception. "}}},"ErrorTransactionRequestDetailsExtractException":{"properties":{"message":{"type":"string","example":"OBP-60008: Transaction detail body extract exception. "}}},"ErrorGetTransactionsException":{"properties":{"message":{"type":"string","example":"OBP-60009: Get Transaction Exception. "}}},"ErrorGetTransactionRequestsException":{"properties":{"message":{"type":"string","example":"OBP-60010: Get Transaction Requests Exception. "}}},"ErrorCreateMeetingException":{"properties":{"message":{"type":"string","example":"OBP-60011: Create Meeting Exception. "}}},"ErrorCreateMeetingInviteeException":{"properties":{"message":{"type":"string","example":"OBP-60012: Create Meeting Invitee Exception. "}}},"ErrorallFields":{"properties":{"message":{"type":"string","example":"null"}}},"EmptyClassJson":{"required":["jsonString"],"properties":{"jsonString":{"type":"string","example":"{}"}}},"CreateTemplateJson":{"required":["author","pages","points"],"properties":{"points":{"type":"number","format":"double","example":"1.3"},"pages":{"type":"integer","format":"int32","example":"209"},"author":{"type":"string","example":"Chinua Achebe"}}},"EmptyClassJson":{"required":["jsonString"],"properties":{"jsonString":{"type":"string","example":"{}"}}},"EmptyClassJson":{"required":["jsonString"],"properties":{"jsonString":{"type":"string","example":"{}"}}},"License":{"required":["id","name"],"properties":{"name":{"type":"string","example":"String"},"id":{"type":"string","example":"id"}}},"Routing":{"required":["scheme","address"],"properties":{"address":{"type":"string","example":"String"},"scheme":{"type":"string","example":"String"}}},"BranchId":{"required":["value"],"properties":{"value":{"type":"string","example":"String"}}},"AmountOfMoney":{"required":["currency","amount"],"properties":{"amount":{"type":"string","example":"100"},"currency":{"type":"string","example":"EUR"}}},"AccountRouting":{"required":["scheme","address"],"properties":{"address":{"type":"string","example":"123456"},"scheme":{"type":"string","example":"accountNumber"}}},"CoreAccount":{"required":["id","label","bankId","accountType","accountRoutings"],"properties":{"label":{"type":"string","example":" work"},"id":{"type":"string","example":"123"},"accountType":{"type":"string","example":"330"},"accountRoutings":{"type":"array","items":{"$ref":"#/definitions/AccountRouting"}},"bankId":{"type":"string","example":"123123"}}},"AccountHeld":{"required":["id","bankId","number","accountRoutings"],"properties":{"accountRoutings":{"type":"array","items":{"$ref":"#/definitions/AccountRouting"}},"number":{"type":"string","example":"String"},"bankId":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"}}},"CreateViewJson":{"required":["name","description","metadata_view","is_public","which_alias_to_use","hide_metadata_if_alias_used","allowed_actions"],"properties":{"name":{"type":"string","example":"_test"},"description":{"type":"string","example":"This view is for family"},"is_public":{"type":"boolean","example":"true"},"hide_metadata_if_alias_used":{"type":"boolean","example":"false"},"which_alias_to_use":{"type":"string","example":"family"},"metadata_view":{"type":"string","example":"_test"},"allowed_actions":{"type":"array","items":{"type":"string"}}}},"UpdateViewJSON":{"required":["description","metadata_view","is_public","which_alias_to_use","hide_metadata_if_alias_used","allowed_actions"],"properties":{"description":{"type":"string","example":"this is for family"},"is_public":{"type":"boolean","example":"true"},"hide_metadata_if_alias_used":{"type":"boolean","example":"true"},"which_alias_to_use":{"type":"string","example":"family"},"metadata_view":{"type":"string","example":"owner"},"allowed_actions":{"type":"array","items":{"type":"string"}}}},"TransactionTypeId":{"required":["value"],"properties":{"value":{"type":"string","example":"123"}}},"BankId":{"required":["value"],"properties":{"value":{"type":"string","example":"gh.uk.9j"}}},"TransactionRequestId":{"required":["value"],"properties":{"value":{"type":"string","example":"123"}}},"CounterpartyId":{"required":["value"],"properties":{"value":{"type":"string","example":"123"}}},"AccountId":{"required":["value"],"properties":{"value":{"type":"string","example":"123"}}},"ViewId":{"required":["value"],"properties":{"value":{"type":"string","example":"owner"}}},"TransactionType":{"required":["id","bankId","shortCode","summary","description","charge"],"properties":{"shortCode":{"type":"string","example":"80080"},"description":{"type":"string","example":"This is the sandbox mode, charging litter money."},"id":{"$ref":"#/definitions/TransactionTypeId"},"charge":{"$ref":"#/definitions/AmountOfMoney"},"bankId":{"$ref":"#/definitions/BankId"},"summary":{"type":"string","example":"SANSANDBOX_TAN"}}},"TransactionRequestCharge":{"required":["summary","value"],"properties":{"value":{"$ref":"#/definitions/AmountOfMoney"},"summary":{"type":"string","example":"String"}}},"TransactionRequestChallenge":{"required":["id","allowed_attempts","challenge_type"],"properties":{"challenge_type":{"type":"string","example":"String"},"allowed_attempts":{"type":"integer","format":"int32","example":"4"},"id":{"type":"string","example":"String"}}},"TransactionRequestAccount":{"required":["bank_id","account_id"],"properties":{"account_id":{"type":"string","example":"String"},"bank_id":{"type":"string","example":"String"}}},"TransactionRequestCounterpartyId":{"required":["counterparty_id"],"properties":{"counterparty_id":{"type":"string","example":"String"}}},"TransactionRequestIban":{"required":["iban"],"properties":{"iban":{"type":"string","example":"String"}}},"TransactionRequestBody":{"required":["to","value","description"],"properties":{"description":{"type":"string","example":"String"},"value":{"$ref":"#/definitions/AmountOfMoney"},"to":{"$ref":"#/definitions/TransactionRequestAccount"}}},"FromAccountTransfer":{"required":["mobile_phone_number","nickname"],"properties":{"nickname":{"type":"string","example":"String"},"mobile_phone_number":{"type":"string","example":"String"}}},"ToAccountTransferToPhone":{"required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"string","example":"String"}}},"ToAccountTransferToAtmKycDocument":{"required":["type","number"],"properties":{"number":{"type":"string","example":"String"},"type":{"type":"string","example":"String"}}},"ToAccountTransferToAtm":{"required":["legal_name","date_of_birth","mobile_phone_number","kyc_document"],"properties":{"kyc_document":{"$ref":"#/definitions/ToAccountTransferToAtmKycDocument"},"mobile_phone_number":{"type":"string","example":"String"},"date_of_birth":{"type":"string","example":"20181230"},"legal_name":{"type":"string","example":"String"}}},"ToAccountTransferToAccountAccount":{"required":["number","iban"],"properties":{"iban":{"type":"string","example":"String"},"number":{"type":"string","example":"String"}}},"ToAccountTransferToAccount":{"required":["name","bank_code","branch_number","account"],"properties":{"account":{"$ref":"#/definitions/ToAccountTransferToAccountAccount"},"branch_number":{"type":"string","example":"String"},"bank_code":{"type":"string","example":"String"},"name":{"type":"string","example":"String"}}},"AmountOfMoneyJsonV121":{"required":["currency","amount"],"properties":{"amount":{"type":"string","example":"10"},"currency":{"type":"string","example":"EUR"}}},"TransactionRequestTransferToPhone":{"required":["value","description","message","from","to"],"properties":{"description":{"type":"string","example":"String"},"to":{"$ref":"#/definitions/ToAccountTransferToPhone"},"from":{"$ref":"#/definitions/FromAccountTransfer"},"message":{"type":"string","example":"String"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"TransactionRequestTransferToAtm":{"required":["value","description","message","from","to"],"properties":{"description":{"type":"string","example":"String"},"to":{"$ref":"#/definitions/ToAccountTransferToAtm"},"from":{"$ref":"#/definitions/FromAccountTransfer"},"message":{"type":"string","example":"String"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"TransactionRequestTransferToAccount":{"required":["value","description","transfer_type","future_date","to"],"properties":{"description":{"type":"string","example":"String"},"future_date":{"type":"string","example":"20181230"},"to":{"$ref":"#/definitions/ToAccountTransferToAccount"},"transfer_type":{"type":"string","example":"String"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"TransactionRequestBodyAllTypes":{"required":["value","description"],"properties":{"to_transfer_to_phone":{"$ref":"#/definitions/TransactionRequestTransferToPhone"},"description":{"type":"string","example":"String"},"to_transfer_to_atm":{"$ref":"#/definitions/TransactionRequestTransferToAtm"},"to_counterparty":{"$ref":"#/definitions/TransactionRequestCounterpartyId"},"to_sepa":{"$ref":"#/definitions/TransactionRequestIban"},"to_transfer_to_account":{"$ref":"#/definitions/TransactionRequestTransferToAccount"},"value":{"$ref":"#/definitions/AmountOfMoney"},"to_sandbox_tan":{"$ref":"#/definitions/TransactionRequestAccount"}}},"TransactionRequest":{"required":["id","type","from","body","transaction_ids","status","start_date","end_date","challenge","charge","charge_policy","counterparty_id","name","this_bank_id","this_account_id","this_view_id","other_account_routing_scheme","other_account_routing_address","other_bank_routing_scheme","other_bank_routing_address","is_beneficiary"],"properties":{"other_account_routing_address":{"type":"string","example":"String"},"other_account_routing_scheme":{"type":"string","example":"String"},"body":{"$ref":"#/definitions/TransactionRequestBodyAllTypes"},"challenge":{"$ref":"#/definitions/TransactionRequestChallenge"},"name":{"type":"string","example":"String"},"start_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"is_beneficiary":{"type":"boolean","example":"true"},"future_date":{"type":"string","example":"20881230"},"other_bank_routing_scheme":{"type":"string","example":"String"},"id":{"$ref":"#/definitions/TransactionRequestId"},"this_account_id":{"$ref":"#/definitions/AccountId"},"end_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"status":{"type":"string","example":"String"},"charge_policy":{"type":"string","example":"String"},"from":{"$ref":"#/definitions/TransactionRequestAccount"},"this_view_id":{"$ref":"#/definitions/ViewId"},"charge":{"$ref":"#/definitions/TransactionRequestCharge"},"other_bank_routing_address":{"type":"string","example":"String"},"this_bank_id":{"$ref":"#/definitions/BankId"},"type":{"type":"string","example":"String"},"counterparty_id":{"$ref":"#/definitions/CounterpartyId"},"transaction_ids":{"type":"string","example":"String"}}},"MessageDocJson":{"required":["process","message_format","description","example_outbound_message","example_inbound_message","adapter_implementation"],"properties":{"adapter_implementation":{"$ref":"#/definitions/AdapterImplementationJson"},"outboundAvroSchema":{"type":"string","example":"This is a json String."},"example_inbound_message":{"type":"string","example":"This is a json String."},"inboundAvroSchema":{"type":"string","example":"This is a json String."},"description":{"type":"string","example":"get Banks"},"process":{"type":"string","example":"getAccounts"},"message_format":{"type":"string","example":"KafkaV2017"},"example_outbound_message":{"type":"string","example":"This is a json String."},"outbound_topic":{"type":"string","example":"to.obp.api.1.caseclass.OutboundGetAccounts"},"inbound_topic":{"type":"string","example":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts"}}},"MessageDocsJson":{"required":["message_docs"],"properties":{"message_docs":{"type":"array","items":{"$ref":"#/definitions/MessageDocJson"}}}},"MakePaymentJson":{"required":["bank_id","account_id","amount"],"properties":{"amount":{"type":"string","example":"10"},"account_id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"bank_id":{"type":"string","example":"gh.29.uk"}}},"TransactionIdJson":{"required":["transaction_id"],"properties":{"transaction_id":{"type":"string","example":"123"}}},"HostedBy":{"required":["organisation","email","phone","organisation_website"],"properties":{"organisation_website":{"type":"string","example":"String"},"phone":{"type":"string","example":"String"},"email":{"type":"string","example":"String"},"organisation":{"type":"string","example":"String"}}},"RateLimiting":{"required":["enabled","technology","service_available","is_active"],"properties":{"is_active":{"type":"boolean","example":"true"},"service_available":{"type":"boolean","example":"true"},"technology":{"type":"string","example":"REDIS"},"enabled":{"type":"boolean","example":"true"}}},"APIInfoJSON":{"required":["version","version_status","git_commit","connector","hosted_by"],"properties":{"version_status":{"type":"string","example":"String"},"version":{"type":"string","example":"String"},"connector":{"type":"string","example":"String"},"hosted_by":{"$ref":"#/definitions/HostedBy"},"git_commit":{"type":"string","example":"String"}}},"ErrorMessage":{"required":["code","message"],"properties":{"message":{"type":"string","example":"Internal Server Error"},"code":{"type":"integer","format":"int32","example":"500"}}},"PostTransactionImageJSON":{"required":["label","URL"],"properties":{"URL":{"type":"string","example":"String"},"label":{"type":"string","example":"String"}}},"PostTransactionCommentJSON":{"required":["value"],"properties":{"value":{"type":"string","example":"String"}}},"PostTransactionTagJSON":{"required":["value"],"properties":{"value":{"type":"string","example":"String"}}},"AliasJSON":{"required":["alias"],"properties":{"alias":{"type":"string","example":"String"}}},"MoreInfoJSON":{"required":["more_info"],"properties":{"more_info":{"type":"string","example":"String"}}},"UrlJSON":{"required":["URL"],"properties":{"URL":{"type":"string","example":"String"}}},"ImageUrlJSON":{"required":["image_URL"],"properties":{"image_URL":{"type":"string","example":"String"}}},"OpenCorporateUrlJSON":{"required":["open_corporates_URL"],"properties":{"open_corporates_URL":{"type":"string","example":"String"}}},"AccountRoutingJsonV121":{"required":["scheme","address"],"properties":{"address":{"type":"string","example":"4930396"},"scheme":{"type":"string","example":"AccountNumber"}}},"AccountRuleJsonV300":{"required":["scheme","value"],"properties":{"value":{"type":"string","example":"10"},"scheme":{"type":"string","example":"OVERDRAFT"}}},"UserJSONV121":{"required":["id","provider","display_name"],"properties":{"display_name":{"type":"string","example":"OBP"},"provider":{"type":"string","example":"OBP"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"}}},"ViewJSONV121":{"required":["id","short_name","description","is_public","alias","hide_metadata_if_alias_used","can_add_comment","can_add_corporate_location","can_add_image","can_add_image_url","can_add_more_info","can_add_open_corporates_url","can_add_physical_location","can_add_private_alias","can_add_public_alias","can_add_tag","can_add_url","can_add_where_tag","can_delete_comment","can_delete_corporate_location","can_delete_image","can_delete_physical_location","can_delete_tag","can_delete_where_tag","can_edit_owner_comment","can_see_bank_account_balance","can_see_bank_account_bank_name","can_see_bank_account_currency","can_see_bank_account_iban","can_see_bank_account_label","can_see_bank_account_national_identifier","can_see_bank_account_number","can_see_bank_account_owners","can_see_bank_account_swift_bic","can_see_bank_account_type","can_see_comments","can_see_corporate_location","can_see_image_url","can_see_images","can_see_more_info","can_see_open_corporates_url","can_see_other_account_bank_name","can_see_other_account_iban","can_see_other_account_kind","can_see_other_account_metadata","can_see_other_account_national_identifier","can_see_other_account_number","can_see_other_account_swift_bic","can_see_owner_comment","can_see_physical_location","can_see_private_alias","can_see_public_alias","can_see_tags","can_see_transaction_amount","can_see_transaction_balance","can_see_transaction_currency","can_see_transaction_description","can_see_transaction_finish_date","can_see_transaction_metadata","can_see_transaction_other_bank_account","can_see_transaction_start_date","can_see_transaction_this_bank_account","can_see_transaction_type","can_see_url","can_see_where_tag"],"properties":{"can_see_transaction_start_date":{"type":"boolean","example":"true"},"can_add_url":{"type":"boolean","example":"true"},"can_add_where_tag":{"type":"boolean","example":"true"},"can_see_transaction_this_bank_account":{"type":"boolean","example":"true"},"can_see_bank_account_owners":{"type":"boolean","example":"true"},"can_see_private_alias":{"type":"boolean","example":"true"},"can_edit_owner_comment":{"type":"boolean","example":"true"},"can_see_other_account_national_identifier":{"type":"boolean","example":"true"},"can_see_public_alias":{"type":"boolean","example":"true"},"can_see_physical_location":{"type":"boolean","example":"true"},"can_see_owner_comment":{"type":"boolean","example":"true"},"can_see_bank_account_iban":{"type":"boolean","example":"true"},"can_see_corporate_location":{"type":"boolean","example":"true"},"can_see_bank_account_number":{"type":"boolean","example":"true"},"can_see_other_account_bank_name":{"type":"boolean","example":"true"},"description":{"type":"string","example":"description"},"can_see_transaction_other_bank_account":{"type":"boolean","example":"true"},"can_delete_corporate_location":{"type":"boolean","example":"true"},"can_see_comments":{"type":"boolean","example":"true"},"can_see_bank_account_bank_name":{"type":"boolean","example":"true"},"can_add_more_info":{"type":"boolean","example":"true"},"can_see_other_account_number":{"type":"boolean","example":"true"},"can_see_other_account_swift_bic":{"type":"boolean","example":"true"},"can_add_open_corporates_url":{"type":"boolean","example":"true"},"can_see_other_account_kind":{"type":"boolean","example":"true"},"can_delete_physical_location":{"type":"boolean","example":"true"},"can_see_bank_account_label":{"type":"boolean","example":"true"},"can_see_transaction_currency":{"type":"boolean","example":"true"},"is_public":{"type":"boolean","example":"true"},"can_see_transaction_finish_date":{"type":"boolean","example":"true"},"can_add_tag":{"type":"boolean","example":"true"},"can_see_images":{"type":"boolean","example":"true"},"can_see_bank_account_currency":{"type":"boolean","example":"true"},"hide_metadata_if_alias_used":{"type":"boolean","example":"true"},"can_delete_where_tag":{"type":"boolean","example":"true"},"alias":{"type":"string","example":"None"},"can_add_image_url":{"type":"boolean","example":"true"},"can_add_comment":{"type":"boolean","example":"true"},"can_see_image_url":{"type":"boolean","example":"true"},"id":{"type":"string","example":"123"},"can_see_bank_account_national_identifier":{"type":"boolean","example":"true"},"can_see_tags":{"type":"boolean","example":"true"},"can_see_open_corporates_url":{"type":"boolean","example":"true"},"short_name":{"type":"string","example":"short_name"},"can_delete_tag":{"type":"boolean","example":"true"},"can_see_more_info":{"type":"boolean","example":"true"},"can_see_transaction_metadata":{"type":"boolean","example":"true"},"can_delete_comment":{"type":"boolean","example":"true"},"can_see_where_tag":{"type":"boolean","example":"true"},"can_add_private_alias":{"type":"boolean","example":"true"},"can_add_public_alias":{"type":"boolean","example":"true"},"can_see_bank_account_swift_bic":{"type":"boolean","example":"true"},"can_add_image":{"type":"boolean","example":"true"},"can_see_transaction_type":{"type":"boolean","example":"true"},"can_see_other_account_iban":{"type":"boolean","example":"true"},"can_add_physical_location":{"type":"boolean","example":"true"},"can_add_corporate_location":{"type":"boolean","example":"true"},"can_delete_image":{"type":"boolean","example":"true"},"can_see_url":{"type":"boolean","example":"true"},"can_see_bank_account_balance":{"type":"boolean","example":"true"},"can_see_transaction_balance":{"type":"boolean","example":"true"},"can_see_transaction_amount":{"type":"boolean","example":"true"},"can_see_other_account_metadata":{"type":"boolean","example":"true"},"can_see_bank_account_type":{"type":"boolean","example":"true"},"can_see_transaction_description":{"type":"boolean","example":"true"}}},"CreateViewJsonV121":{"required":["name","description","is_public","which_alias_to_use","hide_metadata_if_alias_used","allowed_actions"],"properties":{"name":{"type":"string","example":"_test"},"description":{"type":"string","example":"This view is for family"},"is_public":{"type":"boolean","example":"true"},"hide_metadata_if_alias_used":{"type":"boolean","example":"false"},"which_alias_to_use":{"type":"string","example":"family"},"allowed_actions":{"type":"array","items":{"type":"string"}}}},"UpdateViewJsonV121":{"required":["description","is_public","which_alias_to_use","hide_metadata_if_alias_used","allowed_actions"],"properties":{"description":{"type":"string","example":"This view is for family"},"is_public":{"type":"boolean","example":"true"},"hide_metadata_if_alias_used":{"type":"boolean","example":"false"},"which_alias_to_use":{"type":"string","example":"family"},"allowed_actions":{"type":"array","items":{"type":"string"}}}},"ViewsJSONV121":{"required":["views"],"properties":{"views":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV121"}}}},"AccountJSON":{"required":["id","label","views_available","bank_id"],"properties":{"bank_id":{"type":"string","example":"gh.uk.db"},"views_available":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV121"}},"label":{"type":"string","example":"OBP"},"id":{"type":"string","example":"123"}}},"AccountsJSON":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/AccountJSON"}}}},"BankRoutingJsonV121":{"required":["scheme","address"],"properties":{"address":{"type":"string","example":"gh.29.uk"},"scheme":{"type":"string","example":"Bank_ID"}}},"BankJSON":{"required":["id","short_name","full_name","logo","website","bank_routing"],"properties":{"website":{"type":"string","example":"www.openbankproject.com"},"full_name":{"type":"string","example":"full_name"},"logo":{"type":"string","example":"logo"},"id":{"type":"string","example":"gh.29.uk"},"short_name":{"type":"string","example":"short_name "},"bank_routing":{"$ref":"#/definitions/BankRoutingJsonV121"}}},"BanksJSON":{"required":["banks"],"properties":{"banks":{"type":"array","items":{"$ref":"#/definitions/BankJSON"}}}},"AccountHolderJSON":{"required":["name","is_alias"],"properties":{"is_alias":{"type":"boolean","example":"true"},"name":{"type":"string","example":"OBP"}}},"MinimalBankJSON":{"required":["national_identifier","name"],"properties":{"name":{"type":"string","example":"OBP"},"national_identifier":{"type":"string","example":"OBP"}}},"ModeratedAccountJSON":{"required":["id","label","number","owners","type","balance","IBAN","swift_bic","views_available","bank_id","account_routing"],"properties":{"number":{"type":"string","example":"123"},"account_routing":{"$ref":"#/definitions/AccountRoutingJsonV121"},"views_available":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV121"}},"IBAN":{"type":"string","example":"DE89 3704 0044 0532 0130 00"},"label":{"type":"string","example":"NoneLabel"},"owners":{"type":"array","items":{"$ref":"#/definitions/UserJSONV121"}},"swift_bic":{"type":"string","example":"OKOYFIHH"},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"type":{"type":"string","example":"OBP"}}},"ThisAccountJSON":{"required":["id","holders","number","kind","IBAN","swift_bic","bank"],"properties":{"number":{"type":"string","example":"123"},"IBAN":{"type":"string","example":"UK1234AD"},"swift_bic":{"type":"string","example":"UK1234AD"},"bank":{"$ref":"#/definitions/MinimalBankJSON"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"holders":{"type":"array","items":{"$ref":"#/definitions/AccountHolderJSON"}},"kind":{"type":"string","example":"AC"}}},"LocationJSONV121":{"required":["latitude","longitude","date","user"],"properties":{"user":{"$ref":"#/definitions/UserJSONV121"},"date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"longitude":{"type":"number","format":"double","example":"1.231"},"latitude":{"type":"number","format":"double","example":"1.231"}}},"OtherAccountMetadataJSON":{"required":["public_alias","private_alias","more_info","URL","image_URL","open_corporates_URL","corporate_location","physical_location"],"properties":{"public_alias":{"type":"string","example":"NONE"},"image_URL":{"type":"string","example":"www.openbankproject.com"},"physical_location":{"$ref":"#/definitions/LocationJSONV121"},"private_alias":{"type":"string","example":"NONE"},"URL":{"type":"string","example":"www.openbankproject.com"},"more_info":{"type":"string","example":"www.openbankproject.com"},"corporate_location":{"$ref":"#/definitions/LocationJSONV121"},"open_corporates_URL":{"type":"string","example":"www.openbankproject.com"}}},"OtherAccountJSON":{"required":["id","holder","number","kind","IBAN","swift_bic","bank","metadata"],"properties":{"number":{"type":"string","example":"123"},"IBAN":{"type":"string","example":"UK234DB"},"swift_bic":{"type":"string","example":"UK12321DB"},"holder":{"$ref":"#/definitions/AccountHolderJSON"},"bank":{"$ref":"#/definitions/MinimalBankJSON"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"metadata":{"$ref":"#/definitions/OtherAccountMetadataJSON"},"kind":{"type":"string","example":"3456"}}},"TransactionDetailsJSON":{"required":["type","description","posted","completed","new_balance","value"],"properties":{"new_balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"description":{"type":"string","example":"this is for family"},"completed":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"type":{"type":"string","example":"AC"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"posted":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"}}},"TransactionImageJSON":{"required":["id","label","URL","date","user"],"properties":{"URL":{"type":"string","example":"www.openbankproject.com"},"label":{"type":"string","example":"NONE"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"TransactionImagesJSON":{"required":["images"],"properties":{"images":{"type":"array","items":{"$ref":"#/definitions/TransactionImageJSON"}}}},"TransactionCommentJSON":{"required":["id","value","date","user"],"properties":{"user":{"$ref":"#/definitions/UserJSONV121"},"date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"value":{"type":"string","example":"OBP"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"}}},"TransactionTagJSON":{"required":["id","value","date","user"],"properties":{"user":{"$ref":"#/definitions/UserJSONV121"},"date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"value":{"type":"string","example":"OBP"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"}}},"TransactionTagsJSON":{"required":["tags"],"properties":{"tags":{"type":"array","items":{"$ref":"#/definitions/TransactionTagJSON"}}}},"TransactionMetadataJSON":{"required":["narrative","comments","tags","images","where"],"properties":{"narrative":{"type":"string","example":"NONE"},"tags":{"type":"array","items":{"$ref":"#/definitions/TransactionTagJSON"}},"where":{"$ref":"#/definitions/LocationJSONV121"},"images":{"type":"array","items":{"$ref":"#/definitions/TransactionImageJSON"}},"comments":{"type":"array","items":{"$ref":"#/definitions/TransactionCommentJSON"}}}},"TransactionJSON":{"required":["id","this_account","other_account","details","metadata"],"properties":{"this_account":{"$ref":"#/definitions/ThisAccountJSON"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"details":{"$ref":"#/definitions/TransactionDetailsJSON"},"metadata":{"$ref":"#/definitions/TransactionMetadataJSON"},"other_account":{"$ref":"#/definitions/OtherAccountJSON"}}},"TransactionsJSON":{"required":["transactions"],"properties":{"transactions":{"type":"array","items":{"$ref":"#/definitions/TransactionJSON"}}}},"SuccessMessage":{"required":["success"],"properties":{"success":{"type":"string","example":"Success"}}},"OtherAccountsJSON":{"required":["other_accounts"],"properties":{"other_accounts":{"type":"array","items":{"$ref":"#/definitions/OtherAccountJSON"}}}},"TransactionNarrativeJSON":{"required":["narrative"],"properties":{"narrative":{"type":"string","example":"narative"}}},"TransactionCommentsJSON":{"required":["comments"],"properties":{"comments":{"type":"array","items":{"$ref":"#/definitions/TransactionCommentJSON"}}}},"TransactionWhereJSON":{"required":["where"],"properties":{"where":{"$ref":"#/definitions/LocationJSONV121"}}},"PermissionJSON":{"required":["user","views"],"properties":{"views":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV121"}},"user":{"$ref":"#/definitions/UserJSONV121"}}},"PermissionsJSON":{"required":["permissions"],"properties":{"permissions":{"type":"array","items":{"$ref":"#/definitions/PermissionJSON"}}}},"UpdateAccountJSON":{"required":["id","label","bank_id"],"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"label":{"type":"string","example":"label"},"id":{"type":"string","example":"123123"}}},"ViewIdsJson":{"required":["views"],"properties":{"views":{"type":"array","items":{"type":"string"}}}},"LocationPlainJSON":{"required":["latitude","longitude"],"properties":{"longitude":{"type":"number","format":"double","example":"1.535"},"latitude":{"type":"number","format":"double","example":"1.532"}}},"PostTransactionWhereJSON":{"required":["where"],"properties":{"where":{"$ref":"#/definitions/LocationPlainJSON"}}},"CorporateLocationJSON":{"required":["corporate_location"],"properties":{"corporate_location":{"$ref":"#/definitions/LocationPlainJSON"}}},"PhysicalLocationJSON":{"required":["physical_location"],"properties":{"physical_location":{"$ref":"#/definitions/LocationPlainJSON"}}},"PinResetJSON":{"required":["requested_date","reason_requested"],"properties":{"reason_requested":{"type":"string","example":"FORGOT"},"requested_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"}}},"PinResetJSON":{"required":["requested_date","reason_requested"],"properties":{"reason_requested":{"type":"string","example":"GOOD_SECURITY_PRACTICE"},"requested_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"}}},"ReplacementJSON":{"required":["requested_date","reason_requested"],"properties":{"reason_requested":{"type":"string","example":"RENEW"},"requested_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"}}},"PhysicalCardJSON":{"required":["bank_id","bank_card_number","name_on_card","issue_number","serial_number","valid_from_date","expires_date","enabled","cancelled","on_hot_list","technology","networks","allows","account","replacement","pin_reset","collected","posted"],"properties":{"allows":{"type":"array","items":{"type":"string"}},"expires_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"networks":{"type":"array","items":{"type":"string"}},"issue_number":{"type":"string","example":"String"},"replacement":{"$ref":"#/definitions/ReplacementJSON"},"enabled":{"type":"boolean","example":"true"},"collected":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"technology":{"type":"string","example":"String"},"cancelled":{"type":"boolean","example":"true"},"bank_id":{"type":"string","example":"gh.29.uk"},"pin_reset":{"type":"array","items":{"$ref":"#/definitions/PinResetJSON"}},"serial_number":{"type":"string","example":"String"},"account":{"$ref":"#/definitions/AccountJSON"},"valid_from_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"bank_card_number":{"type":"string","example":"String"},"name_on_card":{"type":"string","example":"String"},"posted":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"on_hot_list":{"type":"boolean","example":"true"}}},"PhysicalCardsJSON":{"required":["cards"],"properties":{"cards":{"type":"array","items":{"$ref":"#/definitions/PhysicalCardJSON"}}}},"PostPhysicalCardJSON":{"required":["bank_card_number","name_on_card","issue_number","serial_number","valid_from_date","expires_date","enabled","technology","networks","allows","account_id","replacement","pin_reset","collected","posted"],"properties":{"allows":{"type":"array","items":{"type":"string"}},"expires_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"networks":{"type":"array","items":{"type":"string"}},"issue_number":{"type":"string","example":"String"},"replacement":{"$ref":"#/definitions/ReplacementJSON"},"enabled":{"type":"boolean","example":"true"},"collected":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"technology":{"type":"string","example":"String"},"account_id":{"type":"string","example":"String"},"pin_reset":{"type":"array","items":{"$ref":"#/definitions/PinResetJSON"}},"serial_number":{"type":"string","example":"String"},"valid_from_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"bank_card_number":{"type":"string","example":"String"},"name_on_card":{"type":"string","example":"String"},"posted":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"}}},"TransactionRequestBodyJson":{"required":["to","value","description"],"properties":{"description":{"type":"string","example":"String"},"value":{"$ref":"#/definitions/AmountOfMoney"},"to":{"$ref":"#/definitions/TransactionRequestAccount"}}},"TransactionRequestJson":{"required":["id","type","from","details","body","transaction_ids","status","start_date","end_date","challenge","charge","charge_policy","counterparty_id","name","this_bank_id","this_account_id","this_view_id","other_account_routing_scheme","other_account_routing_address","other_bank_routing_scheme","other_bank_routing_address","is_beneficiary"],"properties":{"other_account_routing_address":{"type":"string","example":"String"},"other_account_routing_scheme":{"type":"string","example":"String"},"body":{"$ref":"#/definitions/TransactionRequestBodyJson"},"challenge":{"$ref":"#/definitions/TransactionRequestChallenge"},"name":{"type":"string","example":"String"},"start_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"is_beneficiary":{"type":"boolean","example":"true"},"other_bank_routing_scheme":{"type":"string","example":"String"},"id":{"$ref":"#/definitions/TransactionRequestId"},"this_account_id":{"$ref":"#/definitions/AccountId"},"end_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"status":{"type":"string","example":"String"},"charge_policy":{"type":"string","example":"String"},"from":{"$ref":"#/definitions/TransactionRequestAccount"},"this_view_id":{"$ref":"#/definitions/ViewId"},"details":{"$ref":"#/definitions/TransactionRequestBodyJson"},"charge":{"$ref":"#/definitions/TransactionRequestCharge"},"other_bank_routing_address":{"type":"string","example":"String"},"this_bank_id":{"$ref":"#/definitions/BankId"},"type":{"type":"string","example":"String"},"counterparty_id":{"$ref":"#/definitions/CounterpartyId"},"transaction_ids":{"type":"string","example":"String"}}},"CustomerFaceImageJson":{"required":["url","date"],"properties":{"date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"url":{"type":"string","example":"www.openbankproject"}}},"LocationJsonV140":{"required":["latitude","longitude"],"properties":{"longitude":{"type":"number","format":"double","example":"11.45"},"latitude":{"type":"number","format":"double","example":"11.45"}}},"TransactionRequestChargeJsonV140":{"required":["summary","value"],"properties":{"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"summary":{"type":"string","example":"The bank fixed charge"}}},"TransactionRequestTypeJsonV140":{"required":["value","charge"],"properties":{"charge":{"$ref":"#/definitions/TransactionRequestChargeJsonV140"},"value":{"type":"string","example":"10"}}},"TransactionRequestTypesJsonV140":{"required":["transaction_request_types"],"properties":{"transaction_request_types":{"type":"array","items":{"$ref":"#/definitions/TransactionRequestTypeJsonV140"}}}},"TransactionRequestAccountJsonV140":{"required":["bank_id","account_id"],"properties":{"account_id":{"type":"string","example":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"},"bank_id":{"type":"string","example":"gh.29.uk"}}},"ChallengeJsonV140":{"required":["id","allowed_attempts","challenge_type"],"properties":{"challenge_type":{"type":"string","example":"SANDBOX_TAN"},"allowed_attempts":{"type":"integer","format":"int32","example":"3"},"id":{"type":"string","example":"be1a183d-b301-4b83-b855-5eeffdd3526f"}}},"DriveUpStringJson":{"required":["hours"],"properties":{"hours":{"type":"string","example":"5"}}},"LicenseJsonV140":{"required":["id","name"],"properties":{"name":{"type":"string","example":"TESOBE"},"id":{"type":"string","example":"5"}}},"MetaJsonV140":{"required":["license"],"properties":{"license":{"$ref":"#/definitions/LicenseJsonV140"}}},"LobbyStringJson":{"required":["hours"],"properties":{"hours":{"type":"string","example":"5"}}},"AddressJsonV140":{"required":["line_1","line_2","line_3","city","state","postcode","country"],"properties":{"city":{"type":"string","example":"Berlin"},"line_2":{"type":"string","example":"Wedding"},"state":{"type":"string","example":"Berlin Brandenburg"},"postcode":{"type":"string","example":"13359"},"country":{"type":"string","example":"DE"},"line_3":{"type":"string","example":""},"line_1":{"type":"string","example":"Osloer Straße 16/17"}}},"ChallengeAnswerJSON":{"required":["id","answer"],"properties":{"answer":{"type":"string","example":"123"},"id":{"type":"string","example":"This is challenge.id, you can get it from `Create Transaction Request.` response, only is useful if status ==`INITIATED` there."}}},"PostCustomerJson":{"required":["customer_number","legal_name","mobile_phone_number","email","face_image","date_of_birth","relationship_status","dependants","dob_of_dependants","highest_education_attained","employment_status","kyc_status","last_ok_date"],"properties":{"email":{"type":"string","example":"String"},"mobile_phone_number":{"type":"string","example":"String"},"customer_number":{"type":"string","example":"String"},"highest_education_attained":{"type":"string","example":"String"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"date_of_birth":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"last_ok_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"employment_status":{"type":"string","example":"String"},"legal_name":{"type":"string","example":"String"},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"String"},"kyc_status":{"type":"boolean","example":"true"}}},"CustomerJsonV140":{"required":["customer_id","customer_number","legal_name","mobile_phone_number","email","face_image","date_of_birth","relationship_status","dependants","dob_of_dependants","highest_education_attained","employment_status","kyc_status","last_ok_date"],"properties":{"customer_id":{"type":"string","example":"String"},"email":{"type":"string","example":"String"},"mobile_phone_number":{"type":"string","example":"String"},"customer_number":{"type":"string","example":"String"},"highest_education_attained":{"type":"string","example":"String"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"date_of_birth":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"last_ok_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"employment_status":{"type":"string","example":"String"},"legal_name":{"type":"string","example":"String"},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"10"},"relationship_status":{"type":"string","example":"String"},"kyc_status":{"type":"boolean","example":"true"}}},"CustomersJsonV140":{"required":["customers"],"properties":{"customers":{"type":"array","items":{"$ref":"#/definitions/CustomerJsonV140"}}}},"CustomerMessageJson":{"required":["id","date","message","from_department","from_person"],"properties":{"from_person":{"type":"string","example":"String"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"from_department":{"type":"string","example":"String"},"message":{"type":"string","example":"String"}}},"CustomerMessagesJson":{"required":["messages"],"properties":{"messages":{"type":"array","items":{"$ref":"#/definitions/CustomerMessageJson"}}}},"AddCustomerMessageJson":{"required":["message","from_department","from_person"],"properties":{"from_person":{"type":"string","example":"String"},"from_department":{"type":"string","example":"String"},"message":{"type":"string","example":"String"}}},"BranchRoutingJsonV141":{"required":["scheme","address"],"properties":{"address":{"type":"string","example":"678"},"scheme":{"type":"string","example":"BranchNumber"}}},"BranchJson":{"required":["id","name","address","location","lobby","drive_up","meta","branch_routing"],"properties":{"name":{"type":"string","example":"String"},"location":{"$ref":"#/definitions/LocationJsonV140"},"branch_routing":{"$ref":"#/definitions/BranchRoutingJsonV141"},"drive_up":{"$ref":"#/definitions/DriveUpStringJson"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"lobby":{"$ref":"#/definitions/LobbyStringJson"},"address":{"$ref":"#/definitions/AddressJsonV140"}}},"BranchesJson":{"required":["branches"],"properties":{"branches":{"type":"array","items":{"$ref":"#/definitions/BranchJson"}}}},"Meta":{"required":["license"],"properties":{"license":{"$ref":"#/definitions/License"}}},"OpeningTimesV300":{"required":["opening_time","closing_time"],"properties":{"closing_time":{"type":"string","example":"18:00"},"opening_time":{"type":"string","example":"10:00"}}},"OpeningTimes":{"required":["openingTime","closingTime"],"properties":{"closingTime":{"type":"string","example":"18:00"},"openingTime":{"type":"string","example":"10:00"}}},"Address":{"required":["line1","line2","line3","city","state","postCode","countryCode"],"properties":{"city":{"type":"string","example":"Berlin"},"postCode":{"type":"string","example":"13359"},"state":{"type":"string","example":"Brandenburg"},"line1":{"type":"string","example":"No 1 the Road"},"county":{"type":"string","example":"String"},"countryCode":{"type":"string","example":"DE"},"line2":{"type":"string","example":"The Place"},"line3":{"type":"string","example":"The Hill"}}},"Lobby":{"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"properties":{"sunday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimes"}},"tuesday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimes"}},"wednesday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimes"}},"monday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimes"}},"friday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimes"}},"thursday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimes"}},"saturday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimes"}}}},"DriveUp":{"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"properties":{"sunday":{"$ref":"#/definitions/OpeningTimes"},"tuesday":{"$ref":"#/definitions/OpeningTimes"},"wednesday":{"$ref":"#/definitions/OpeningTimes"},"monday":{"$ref":"#/definitions/OpeningTimes"},"friday":{"$ref":"#/definitions/OpeningTimes"},"thursday":{"$ref":"#/definitions/OpeningTimes"},"saturday":{"$ref":"#/definitions/OpeningTimes"}}},"Routing":{"required":["scheme","address"],"properties":{"address":{"type":"string","example":"123abc"},"scheme":{"type":"string","example":"OBP"}}},"BasicResourceUser":{"required":["userId","provider","username"],"properties":{"username":{"type":"string","example":" String"},"provider":{"type":"string","example":" String"},"userId":{"type":"string","example":"String"}}},"Location":{"required":["latitude","longitude"],"properties":{"user":{"$ref":"#/definitions/BasicResourceUser"},"date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"longitude":{"type":"number","format":"double","example":"10.0"},"latitude":{"type":"number","format":"double","example":"10.0"}}},"LobbyString":{"required":["hours"],"properties":{"hours":{"type":"string","example":"String "}}},"DriveUpString":{"required":["hours"],"properties":{"hours":{"type":"string","example":"String "}}},"Branch":{"required":["branchId","bankId","name","address","location","meta"],"properties":{"name":{"type":"string","example":"Branch by the Lake"},"location":{"$ref":"#/definitions/Location"},"phoneNumber":{"type":"string","example":"+381631954907"},"driveUp":{"$ref":"#/definitions/DriveUp"},"isAccessible":{"type":"boolean","example":"true"},"branchId":{"$ref":"#/definitions/BranchId"},"meta":{"$ref":"#/definitions/Meta"},"moreInfo":{"type":"string","example":"short walk to the lake from here"},"isDeleted":{"type":"boolean","example":"false"},"lobbyString":{"$ref":"#/definitions/LobbyString"},"lobby":{"$ref":"#/definitions/Lobby"},"accessibleFeatures":{"type":"string","example":"wheelchair, atm usuable by the visually impaired"},"address":{"$ref":"#/definitions/Address"},"bankId":{"$ref":"#/definitions/BankId"},"branchType":{"type":"string","example":"Full service store"},"branchRouting":{"$ref":"#/definitions/Routing"},"driveUpString":{"$ref":"#/definitions/DriveUpString"}}},"LobbyJsonV330":{"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"properties":{"sunday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimesV300"}},"tuesday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimesV300"}},"wednesday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimesV300"}},"monday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimesV300"}},"friday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimesV300"}},"thursday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimesV300"}},"saturday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimesV300"}}}},"DriveUpJsonV330":{"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"properties":{"sunday":{"$ref":"#/definitions/OpeningTimesV300"},"tuesday":{"$ref":"#/definitions/OpeningTimesV300"},"wednesday":{"$ref":"#/definitions/OpeningTimesV300"},"monday":{"$ref":"#/definitions/OpeningTimesV300"},"friday":{"$ref":"#/definitions/OpeningTimesV300"},"thursday":{"$ref":"#/definitions/OpeningTimesV300"},"saturday":{"$ref":"#/definitions/OpeningTimesV300"}}},"BranchJsonV300":{"required":["id","bank_id","name","address","location","meta","lobby","drive_up","branch_routing","is_accessible","accessibleFeatures","branch_type","more_info","phone_number"],"properties":{"name":{"type":"string","example":"Branch by the Lake"},"phone_number":{"type":"string","example":"+381631954907"},"location":{"$ref":"#/definitions/LocationJsonV140"},"branch_type":{"type":"string","example":"Full service store"},"branch_routing":{"$ref":"#/definitions/BranchRoutingJsonV141"},"drive_up":{"$ref":"#/definitions/DriveUpJsonV330"},"more_info":{"type":"string","example":"short walk to the lake from here"},"bank_id":{"type":"string","example":"bank-id-123"},"id":{"type":"string","example":"branch-id-123"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"lobby":{"$ref":"#/definitions/LobbyJsonV330"},"accessibleFeatures":{"type":"string","example":"wheelchair, atm usuable by the visually impaired"},"address":{"$ref":"#/definitions/AddressJsonV300"},"is_accessible":{"type":"string","example":"true"}}},"BranchesJsonV300":{"required":["branches"],"properties":{"branches":{"type":"array","items":{"$ref":"#/definitions/BranchJsonV300"}}}},"PostBranchJsonV300":{"required":["bank_id","name","address","location","meta","lobby","drive_up","branch_routing","is_accessible","accessibleFeatures","branch_type","more_info","phone_number"],"properties":{"name":{"type":"string","example":"Branch by the Lake"},"phone_number":{"type":"string","example":"+381631954907"},"location":{"$ref":"#/definitions/LocationJsonV140"},"branch_type":{"type":"string","example":"Full service store"},"branch_routing":{"$ref":"#/definitions/BranchRoutingJsonV141"},"drive_up":{"$ref":"#/definitions/DriveUpJsonV330"},"more_info":{"type":"string","example":"short walk to the lake from here"},"bank_id":{"type":"string","example":"bank-id-123"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"lobby":{"$ref":"#/definitions/LobbyJsonV330"},"accessibleFeatures":{"type":"string","example":"wheelchair, atm usuable by the visually impaired"},"address":{"$ref":"#/definitions/AddressJsonV300"},"is_accessible":{"type":"string","example":"true"}}},"AtmJson":{"required":["id","name","address","location","meta"],"properties":{"name":{"type":"string","example":"String"},"location":{"$ref":"#/definitions/LocationJsonV140"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"address":{"$ref":"#/definitions/AddressJsonV140"}}},"AtmsJson":{"required":["atms"],"properties":{"atms":{"type":"array","items":{"$ref":"#/definitions/AtmJson"}}}},"AddressJsonV300":{"required":["line_1","line_2","line_3","city","county","state","postcode","country_code"],"properties":{"city":{"type":"string","example":"Berlin"},"line_2":{"type":"string","example":"The Place"},"state":{"type":"string","example":"Brandenburg"},"postcode":{"type":"string","example":"13359"},"county":{"type":"string","example":""},"country_code":{"type":"string","example":"DE"},"line_3":{"type":"string","example":"The Hill"},"line_1":{"type":"string","example":"No 1 the Road"}}},"CustomerAddressJsonV310":{"required":["customer_address_id","customer_id","line_1","line_2","line_3","city","county","state","postcode","country_code","tags","status","insert_date"],"properties":{"city":{"type":"string","example":"Berlin"},"line_2":{"type":"string","example":"The Place"},"customer_id":{"type":"string","example":"36f8a9e6-c2b1-407a-8bd0-421b7119307e"},"state":{"type":"string","example":"Brandenburg"},"insert_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"tags":{"type":"array","items":{"type":"string"}},"customer_address_id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"postcode":{"type":"string","example":"13359"},"county":{"type":"string","example":""},"country_code":{"type":"string","example":"DE"},"status":{"type":"string","example":"OK"},"line_3":{"type":"string","example":"The Hill"},"line_1":{"type":"string","example":"No 1 the Road"}}},"CustomerAddressesJsonV310":{"required":["addresses"],"properties":{"addresses":{"type":"array","items":{"$ref":"#/definitions/CustomerAddressJsonV310"}}}},"PostCustomerAddressJsonV310":{"required":["line_1","line_2","line_3","city","county","state","postcode","country_code","tags","status"],"properties":{"city":{"type":"string","example":"Berlin"},"line_2":{"type":"string","example":"The Place"},"state":{"type":"string","example":"Brandenburg"},"tags":{"type":"array","items":{"type":"string"}},"postcode":{"type":"string","example":"13359"},"county":{"type":"string","example":""},"country_code":{"type":"string","example":"DE"},"status":{"type":"string","example":"OK"},"line_3":{"type":"string","example":"The Hill"},"line_1":{"type":"string","example":"No 1 the Road"}}},"AtmJsonV300":{"required":["id","bank_id","name","address","location","meta","monday","tuesday","wednesday","thursday","friday","saturday","sunday","is_accessible","located_at","more_info","has_deposit_capability"],"properties":{"sunday":{"$ref":"#/definitions/OpeningTimesV300"},"name":{"type":"string","example":"Atm by the Lake"},"location":{"$ref":"#/definitions/LocationJsonV140"},"tuesday":{"$ref":"#/definitions/OpeningTimesV300"},"wednesday":{"$ref":"#/definitions/OpeningTimesV300"},"monday":{"$ref":"#/definitions/OpeningTimesV300"},"has_deposit_capability":{"type":"string","example":"true"},"more_info":{"type":"string","example":"short walk to the lake from here"},"bank_id":{"type":"string","example":"bank-id-123"},"id":{"type":"string","example":"atm-id-123"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"address":{"$ref":"#/definitions/AddressJsonV300"},"friday":{"$ref":"#/definitions/OpeningTimesV300"},"is_accessible":{"type":"string","example":"true"},"thursday":{"$ref":"#/definitions/OpeningTimesV300"},"saturday":{"$ref":"#/definitions/OpeningTimesV300"},"located_at":{"type":"string","example":"Full service store"}}},"ProductJson":{"required":["code","name","category","family","super_family","more_info_url","meta"],"properties":{"name":{"type":"string","example":"String"},"more_info_url":{"type":"string","example":"String"},"super_family":{"type":"string","example":"String"},"code":{"type":"string","example":"String"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"category":{"type":"string","example":"String"},"family":{"type":"string","example":"String"}}},"ProductsJson":{"required":["products"],"properties":{"products":{"type":"array","items":{"$ref":"#/definitions/ProductJson"}}}},"CrmEventJson":{"required":["id","bank_id","customer_name","customer_number","category","detail","channel","scheduled_date","actual_date","result"],"properties":{"channel":{"type":"string","example":"String"},"customer_name":{"type":"string","example":"String"},"result":{"type":"string","example":"String"},"customer_number":{"type":"string","example":"String"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"scheduled_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"category":{"type":"string","example":"String"},"detail":{"type":"string","example":"String"},"actual_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"}}},"CrmEventsJson":{"required":["crm_events"],"properties":{"crm_events":{"type":"array","items":{"$ref":"#/definitions/CrmEventJson"}}}},"ImplementedByJson":{"required":["version","function"],"properties":{"function":{"type":"string","example":"getBranches"},"version":{"type":"string","example":"1_4_0"}}},"CanCreateCustomer":{"required":["requiresBankId"],"properties":{"requiresBankId":{"type":"boolean","example":"true"}}},"ResourceDocJson":{"required":["operation_id","implemented_by","request_verb","request_url","summary","description","description_markdown","example_request_body","success_response_body","error_response_bodies","is_core","is_psd2","is_obwg","tags","typed_request_body","typed_success_response_body","is_featured","special_instructions","specified_url"],"properties":{"error_response_bodies":{"type":"array","items":{"type":"string"}},"request_verb":{"type":"string","example":"String"},"request_url":{"type":"string","example":"String"},"description":{"type":"string","example":"HTML String"},"tags":{"type":"array","items":{"type":"string"}},"is_core":{"type":"boolean","example":"true"},"success_response_body":{"$ref":"#/definitions/SuccessMessage"},"example_request_body":{"$ref":"#/definitions/SuccessMessage"},"typed_success_response_body":{"type":"string","example":"This is a json String."},"special_instructions":{"type":"string","example":""},"is_featured":{"type":"boolean","example":"false"},"roles":{"type":"array","items":{"$ref":"#/definitions/CanCreateCustomer"}},"is_psd2":{"type":"boolean","example":"true"},"operation_id":{"type":"string","example":"String"},"implemented_by":{"$ref":"#/definitions/ImplementedByJson"},"specified_url":{"type":"string","example":""},"description_markdown":{"type":"string","example":"Mark_down String"},"is_obwg":{"type":"boolean","example":"true"},"typed_request_body":{"type":"string","example":"This is a json String."},"summary":{"type":"string","example":"String"}}},"ResourceDocsJson":{"required":["resource_docs"],"properties":{"resource_docs":{"type":"array","items":{"$ref":"#/definitions/ResourceDocJson"}}}},"TransactionRequestBodyJsonV140":{"required":["to","value","description","challenge_type"],"properties":{"challenge_type":{"type":"string","example":"String"},"description":{"type":"string","example":"String"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"to":{"$ref":"#/definitions/TransactionRequestAccountJsonV140"}}},"TransactionRequestJsonV140":{"required":["id","type","from","body","transaction_ids","status","start_date","end_date","challenge"],"properties":{"body":{"$ref":"#/definitions/TransactionRequestBodyJsonV140"},"challenge":{"$ref":"#/definitions/ChallengeJsonV140"},"start_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"end_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"status":{"type":"string","example":"String"},"from":{"$ref":"#/definitions/TransactionRequestAccountJsonV140"},"type":{"type":"string","example":"String"},"transaction_ids":{"type":"string","example":"String"}}},"BasicViewJson":{"required":["id","short_name","is_public"],"properties":{"is_public":{"type":"boolean","example":"true"},"short_name":{"type":"string","example":"HHH"},"id":{"type":"string","example":"1"}}},"BasicAccountJSON":{"required":["id","label","bank_id","views_available"],"properties":{"views_available":{"type":"array","items":{"$ref":"#/definitions/BasicViewJson"}},"bank_id":{"type":"string","example":"gh.29.uk"},"label":{"type":"string","example":"NoneLabel"},"id":{"type":"string","example":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"}}},"CoreAccountJSON":{"required":["id","label","bank_id","_links"],"properties":{"_links":{"type":"string","example":"This is a json String."},"bank_id":{"type":"string","example":"gh.29.uk"},"label":{"type":"string","example":"NoneLabel"},"id":{"type":"string","example":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"}}},"ModeratedCoreAccountJSON":{"required":["id","label","number","owners","type","balance","IBAN","swift_bic","bank_id","account_routing"],"properties":{"number":{"type":"string","example":"123"},"account_routing":{"$ref":"#/definitions/AccountRoutingJsonV121"},"IBAN":{"type":"string","example":"GR1301720530005053000582373"},"label":{"type":"string","example":"NoneLabel"},"owners":{"type":"array","items":{"$ref":"#/definitions/UserJSONV121"}},"swift_bic":{"type":"string","example":"UKTF3049auf"},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"},"type":{"type":"string","example":"OBP"}}},"BasicAccountsJSON":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/BasicAccountJSON"}}}},"CoreAccountsJSON":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/CoreAccountJSON"}}}},"KycDocumentJSON":{"required":["bank_id","customer_id","id","customer_number","type","number","issue_date","issue_place","expiry_date"],"properties":{"number":{"type":"string","example":"PlaceholderString"},"customer_id":{"type":"string","example":"PlaceholderString"},"customer_number":{"type":"string","example":"PlaceholderString"},"issue_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"bank_id":{"type":"string","example":"PlaceholderString"},"id":{"type":"string","example":"PlaceholderString"},"type":{"type":"string","example":"PlaceholderString"},"issue_place":{"type":"string","example":"PlaceholderString"},"expiry_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"}}},"KycDocumentsJSON":{"required":["documents"],"properties":{"documents":{"type":"array","items":{"$ref":"#/definitions/KycDocumentJSON"}}}},"KycMediaJSON":{"required":["bank_id","customer_id","id","customer_number","type","url","date","relates_to_kyc_document_id","relates_to_kyc_check_id"],"properties":{"customer_id":{"type":"string","example":"PlaceholderString"},"url":{"type":"string","example":"PlaceholderString"},"customer_number":{"type":"string","example":"PlaceholderString"},"bank_id":{"type":"string","example":"PlaceholderString"},"id":{"type":"string","example":"PlaceholderString"},"date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"relates_to_kyc_document_id":{"type":"string","example":"PlaceholderString"},"relates_to_kyc_check_id":{"type":"string","example":"PlaceholderString"},"type":{"type":"string","example":"PlaceholderString"}}},"KycMediasJSON":{"required":["medias"],"properties":{"medias":{"type":"array","items":{"$ref":"#/definitions/KycMediaJSON"}}}},"KycCheckJSON":{"required":["bank_id","customer_id","id","customer_number","date","how","staff_user_id","staff_name","satisfied","comments"],"properties":{"customer_id":{"type":"string","example":"PlaceholderString"},"customer_number":{"type":"string","example":"PlaceholderString"},"bank_id":{"type":"string","example":"PlaceholderString"},"id":{"type":"string","example":"PlaceholderString"},"how":{"type":"string","example":"PlaceholderString"},"date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"satisfied":{"type":"boolean","example":"true"},"staff_user_id":{"type":"string","example":"PlaceholderString"},"staff_name":{"type":"string","example":"PlaceholderString"},"comments":{"type":"string","example":"PlaceholderString"}}},"KycChecksJSON":{"required":["checks"],"properties":{"checks":{"type":"array","items":{"$ref":"#/definitions/KycCheckJSON"}}}},"KycStatusJSON":{"required":["customer_id","customer_number","ok","date"],"properties":{"date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"ok":{"type":"boolean","example":"true"},"customer_number":{"type":"string","example":"PlaceholderString"},"customer_id":{"type":"string","example":"PlaceholderString"}}},"KycStatusesJSON":{"required":["statuses"],"properties":{"statuses":{"type":"array","items":{"$ref":"#/definitions/KycStatusJSON"}}}},"SocialMediaJSON":{"required":["customer_number","type","handle","date_added","date_activated"],"properties":{"date_activated":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"customer_number":{"type":"string","example":"PlaceholderString"},"date_added":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"type":{"type":"string","example":"PlaceholderString"},"handle":{"type":"string","example":"PlaceholderString"}}},"SocialMediasJSON":{"required":["checks"],"properties":{"checks":{"type":"array","items":{"$ref":"#/definitions/SocialMediaJSON"}}}},"EntitlementJSON":{"required":["entitlement_id","role_name","bank_id"],"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"role_name":{"type":"string","example":"CanQueryOtherUser"},"entitlement_id":{"type":"string","example":"6fb17583-1e49-4435-bb74-a14fe0996723"}}},"EntitlementJSONs":{"required":["list"],"properties":{"list":{"type":"array","items":{"$ref":"#/definitions/EntitlementJSON"}}}},"UserJsonV200":{"required":["user_id","email","provider_id","provider","username","entitlements"],"properties":{"provider":{"type":"string","example":"OBP"},"email":{"type":"string","example":"robert.x.0.gh@example.com"},"username":{"type":"string","example":"robert.x.0.gh"},"provider_id":{"type":"string","example":"OBP"},"user_id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"entitlements":{"$ref":"#/definitions/EntitlementJSONs"}}},"EntitlementRequestJSON":{"required":["entitlement_request_id","user","role_name","bank_id","created"],"properties":{"entitlement_request_id":{"type":"string","example":"6fb17583-1e49-4435-bb74-a14fe0996723"},"role_name":{"type":"string","example":"CanQueryOtherUser"},"bank_id":{"type":"string","example":"gh.29.uk"},"user":{"$ref":"#/definitions/UserJsonV200"},"created":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"}}},"EntitlementRequestsJSON":{"required":["entitlement_requests"],"properties":{"entitlement_requests":{"type":"array","items":{"$ref":"#/definitions/EntitlementRequestJSON"}}}},"CoreTransactionDetailsJSON":{"required":["type","description","posted","completed","new_balance","value"],"properties":{"new_balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"description":{"type":"string","example":"OBP"},"completed":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"type":{"type":"string","example":"AC"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"posted":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"}}},"CoreAccountHolderJSON":{"required":["name"],"properties":{"name":{"type":"string","example":"ZACK"}}},"CreateEntitlementJSON":{"required":["bank_id","role_name"],"properties":{"role_name":{"type":"string","example":"String"},"bank_id":{"type":"string","example":"gh.29.uk"}}},"CoreCounterpartyJSON":{"required":["id","holder","number","kind","IBAN","swift_bic","bank"],"properties":{"number":{"type":"string","example":"1234"},"IBAN":{"type":"string","example":"UK12344DB"},"swift_bic":{"type":"string","example":"UK12344DB"},"holder":{"$ref":"#/definitions/CoreAccountHolderJSON"},"bank":{"$ref":"#/definitions/MinimalBankJSON"},"id":{"type":"string","example":"123"},"kind":{"type":"string","example":"AV"}}},"CoreTransactionJSON":{"required":["id","account","counterparty","details"],"properties":{"details":{"$ref":"#/definitions/CoreTransactionDetailsJSON"},"counterparty":{"$ref":"#/definitions/CoreCounterpartyJSON"},"account":{"$ref":"#/definitions/ThisAccountJSON"},"id":{"type":"string","example":"123"}}},"CoreTransactionsJSON":{"required":["transactions"],"properties":{"transactions":{"type":"array","items":{"$ref":"#/definitions/CoreTransactionJSON"}}}},"TransactionRequestChargeJsonV200":{"required":["summary","value"],"properties":{"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"summary":{"type":"string","example":"Rent the flat"}}},"TransactionRequestWithChargeJson":{"required":["id","type","from","details","transaction_ids","status","start_date","end_date","challenge","charge"],"properties":{"challenge":{"$ref":"#/definitions/ChallengeJsonV140"},"start_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"id":{"type":"string","example":"82f92531-9c63-4246-abfc-96c20ec46188"},"end_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"status":{"type":"string","example":"COMPLETED"},"from":{"$ref":"#/definitions/TransactionRequestAccountJsonV140"},"details":{"$ref":"#/definitions/TransactionRequestBody"},"charge":{"$ref":"#/definitions/TransactionRequestChargeJsonV200"},"type":{"type":"string","example":"SANDBOX_TAN"},"transaction_ids":{"type":"string","example":"666666-9c63-4246-abfc-96c20ec46188"}}},"TransactionRequestBodyJsonV200":{"required":["to","value","description"],"properties":{"description":{"type":"string","example":"this is for work"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"to":{"$ref":"#/definitions/TransactionRequestAccountJsonV140"}}},"TransactionTypeJsonV200":{"required":["id","bank_id","short_code","summary","description","charge"],"properties":{"description":{"type":"string","example":"PlaceholderString"},"short_code":{"type":"string","example":"PlaceholderString"},"bank_id":{"type":"string","example":"PlaceholderString"},"id":{"$ref":"#/definitions/TransactionTypeId"},"charge":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"summary":{"type":"string","example":"PlaceholderString"}}},"TransactionTypesJsonV200":{"required":["transaction_types"],"properties":{"transaction_types":{"type":"array","items":{"$ref":"#/definitions/TransactionTypeJsonV200"}}}},"LinkJson":{"required":["href","rel","method"],"properties":{"method":{"type":"string","example":"String"},"rel":{"type":"string","example":"String"},"href":{"type":"string","example":"String"}}},"LinksJson":{"required":["_links"],"properties":{"_links":{"type":"array","items":{"$ref":"#/definitions/LinkJson"}}}},"ResultAndLinksJson":{"required":["result","links"],"properties":{"links":{"$ref":"#/definitions/LinksJson"},"result":{"type":"string","example":"This is a json String."}}},"CreateUserJson":{"required":["email","username","password","first_name","last_name"],"properties":{"first_name":{"type":"string","example":"String"},"email":{"type":"string","example":"String"},"username":{"type":"string","example":"String"},"last_name":{"type":"string","example":"String"},"password":{"type":"string","example":"String"}}},"CreateUsersJson":{"required":["users"],"properties":{"users":{"type":"array","items":{"$ref":"#/definitions/CreateUserJson"}}}},"CreateMeetingJson":{"required":["provider_id","purpose_id"],"properties":{"purpose_id":{"type":"string","example":"String"},"provider_id":{"type":"string","example":"String"}}},"MeetingKeysJson":{"required":["session_id","staff_token","customer_token"],"properties":{"customer_token":{"type":"string","example":"String"},"staff_token":{"type":"string","example":"String"},"session_id":{"type":"string","example":"String"}}},"MeetingPresentJson":{"required":["staff_user_id","customer_user_id"],"properties":{"customer_user_id":{"type":"string","example":"String"},"staff_user_id":{"type":"string","example":"String"}}},"MeetingJson":{"required":["meeting_id","provider_id","purpose_id","bank_id","present","keys","when"],"properties":{"present":{"$ref":"#/definitions/MeetingPresentJson"},"provider_id":{"type":"string","example":"String"},"bank_id":{"type":"string","example":"gh.29.uk"},"purpose_id":{"type":"string","example":"String"},"when":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"meeting_id":{"type":"string","example":"String"},"keys":{"$ref":"#/definitions/MeetingKeysJson"}}},"MeetingsJson":{"required":["meetings"],"properties":{"meetings":{"type":"array","items":{"$ref":"#/definitions/MeetingJson"}}}},"UserCustomerLinkJson":{"required":["user_customer_link_id","customer_id","user_id","date_inserted","is_active"],"properties":{"is_active":{"type":"boolean","example":"true"},"customer_id":{"type":"string","example":"String"},"user_id":{"type":"string","example":"String"},"date_inserted":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"user_customer_link_id":{"type":"string","example":"String"}}},"UserCustomerLinksJson":{"required":["l"],"properties":{"l":{"type":"array","items":{"$ref":"#/definitions/UserCustomerLinkJson"}}}},"CreateUserCustomerLinkJson":{"required":["user_id","customer_id"],"properties":{"customer_id":{"type":"string","example":"String"},"user_id":{"type":"string","example":"String"}}},"CreateAccountJSON":{"required":["user_id","label","type","balance"],"properties":{"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"type":{"type":"string","example":"String"},"label":{"type":"string","example":"String"},"user_id":{"type":"string","example":"String"}}},"PostKycDocumentJSON":{"required":["customer_number","type","number","issue_date","issue_place","expiry_date"],"properties":{"number":{"type":"string","example":"12345"},"customer_number":{"type":"string","example":"1234"},"issue_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"type":{"type":"string","example":"passport"},"issue_place":{"type":"string","example":"Berlin"},"expiry_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"}}},"PostKycMediaJSON":{"required":["customer_number","type","url","date","relates_to_kyc_document_id","relates_to_kyc_check_id"],"properties":{"url":{"type":"string","example":"http://www.example.com/id-docs/123/image.png"},"customer_number":{"type":"string","example":"1239879"},"date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"relates_to_kyc_document_id":{"type":"string","example":"123"},"relates_to_kyc_check_id":{"type":"string","example":"123"},"type":{"type":"string","example":"image"}}},"PostKycCheckJSON":{"required":["customer_number","date","how","staff_user_id","staff_name","satisfied","comments"],"properties":{"customer_number":{"type":"string","example":"1239879"},"how":{"type":"string","example":"online_meeting"},"date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"satisfied":{"type":"boolean","example":"true"},"staff_user_id":{"type":"string","example":"67876"},"staff_name":{"type":"string","example":"Simon"},"comments":{"type":"string","example":"String"}}},"PostKycStatusJSON":{"required":["customer_number","ok","date"],"properties":{"date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"ok":{"type":"boolean","example":"true"},"customer_number":{"type":"string","example":"String"}}},"CreateCustomerJson":{"required":["title","branchId","nameSuffix","user_id","customer_number","legal_name","mobile_phone_number","email","face_image","date_of_birth","relationship_status","dependants","dob_of_dependants","highest_education_attained","employment_status","kyc_status","last_ok_date"],"properties":{"email":{"type":"string","example":"String"},"mobile_phone_number":{"type":"string","example":"String"},"customer_number":{"type":"string","example":"String"},"highest_education_attained":{"type":"string","example":"String"},"user_id":{"type":"string","example":"String"},"branchId":{"type":"string","example":"String"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"date_of_birth":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"nameSuffix":{"type":"string","example":"String"},"last_ok_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"employment_status":{"type":"string","example":"String"},"legal_name":{"type":"string","example":"String"},"title":{"type":"string","example":"String"},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"String"},"kyc_status":{"type":"boolean","example":"true"}}},"TransactionRequestJsonV200":{"required":["id","type","from","body","transaction_ids","status","start_date","end_date","challenge"],"properties":{"body":{"$ref":"#/definitions/TransactionRequestBodyJsonV200"},"challenge":{"$ref":"#/definitions/ChallengeJsonV140"},"start_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"end_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"status":{"type":"string","example":"String"},"from":{"$ref":"#/definitions/TransactionRequestAccountJsonV140"},"type":{"type":"string","example":"String"},"transaction_ids":{"type":"string","example":"String"}}},"TransactionRequestWithChargesJson":{"required":["transaction_requests_with_charges"],"properties":{"transaction_requests_with_charges":{"type":"array","items":{"$ref":"#/definitions/TransactionRequestWithChargeJson"}}}},"UsersJsonV200":{"required":["users"],"properties":{"users":{"type":"array","items":{"$ref":"#/definitions/UserJsonV200"}}}},"CounterpartiesJSON":{"required":["counterparties"],"properties":{"counterparties":{"type":"array","items":{"$ref":"#/definitions/CoreCounterpartyJSON"}}}},"CounterpartyIdJson":{"required":["counterparty_id"],"properties":{"counterparty_id":{"type":"string","example":"123456"}}},"IbanJson":{"required":["iban"],"properties":{"iban":{"type":"string","example":"123"}}},"MetricJson":{"required":["user_id","url","date","user_name","app_name","developer_email","implemented_by_partial_function","implemented_in_version","consumer_id","verb","correlation_id","duration"],"properties":{"duration":{"type":"integer","format":"int64","example":"39"},"implemented_in_version":{"type":"string","example":"v210"},"url":{"type":"string","example":"www.openbankproject.com"},"correlation_id":{"type":"string","example":"v8ho6h5ivel3uq7a5zcnv0w1"},"implemented_by_partial_function":{"type":"string","example":"getBanks"},"user_id":{"type":"string","example":"134"},"developer_email":{"type":"string","example":"contact@tesobe.ocm"},"date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"consumer_id":{"type":"string","example":"123"},"verb":{"type":"string","example":"get"},"app_name":{"type":"string","example":"SOFI"},"user_name":{"type":"string","example":"OBP"}}},"ResourceUserJSON":{"required":["user_id","email","provider_id","provider","username"],"properties":{"provider":{"type":"string","example":"obp"},"email":{"type":"string","example":"contact@tesobe.com"},"username":{"type":"string","example":"TESOBE"},"provider_id":{"type":"string","example":"obp"},"user_id":{"type":"string","example":"123"}}},"AvailableRoleJSON":{"required":["role","requires_bank_id"],"properties":{"requires_bank_id":{"type":"boolean","example":"true"},"role":{"type":"string","example":"CanCreateBranch"}}},"TransactionRequestTypeJSONV210":{"required":["transaction_request_type"],"properties":{"transaction_request_type":{"type":"string","example":"SandboxTan"}}},"TransactionRequestTypesJSON":{"required":["transaction_request_types"],"properties":{"transaction_request_types":{"type":"array","items":{"$ref":"#/definitions/TransactionRequestTypeJSONV210"}}}},"TransactionRequestBodyCounterpartyJSON":{"required":["to","value","description","charge_policy"],"properties":{"description":{"type":"string","example":"A description for the transaction to the counterparty"},"future_date":{"type":"string","example":"20881230"},"to":{"$ref":"#/definitions/CounterpartyIdJson"},"charge_policy":{"type":"string","example":"SHARED"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"TransactionRequestBodySEPAJSON":{"required":["value","to","description","charge_policy"],"properties":{"description":{"type":"string","example":"This is a SEPA Transaction Request"},"future_date":{"type":"string","example":"20881230"},"to":{"$ref":"#/definitions/IbanJson"},"charge_policy":{"type":"string","example":"SHARED"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"CustomerCreditRatingJSON":{"required":["rating","source"],"properties":{"source":{"type":"string","example":"OBP"},"rating":{"type":"string","example":"OBP"}}},"CustomerJsonV210":{"required":["bank_id","customer_id","customer_number","legal_name","mobile_phone_number","email","face_image","date_of_birth","relationship_status","dependants","dob_of_dependants","highest_education_attained","employment_status","kyc_status","last_ok_date"],"properties":{"customer_id":{"type":"string","example":"123"},"email":{"type":"string","example":"contact@tesobe.com"},"mobile_phone_number":{"type":"string","example":"123"},"customer_number":{"type":"string","example":"123"},"highest_education_attained":{"type":"string","example":"123"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"bank_id":{"type":"string","example":"bankid1234"},"date_of_birth":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"employment_status":{"type":"string","example":"123"},"legal_name":{"type":"string","example":"legal_name"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"123"},"relationship_status":{"type":"string","example":"123"},"kyc_status":{"type":"boolean","example":"true"}}},"CustomerJSONs":{"required":["customers"],"properties":{"customers":{"type":"array","items":{"$ref":"#/definitions/CustomerJsonV210"}}}},"UserJSONV210":{"required":["id","provider","username"],"properties":{"username":{"type":"string","example":"OBP"},"provider":{"type":"string","example":"OBP"},"id":{"type":"string","example":"123"}}},"LocationJsonV210":{"required":["latitude","longitude","date","user"],"properties":{"user":{"$ref":"#/definitions/UserJSONV210"},"date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"longitude":{"type":"number","format":"double","example":"11.45"},"latitude":{"type":"number","format":"double","example":"11.45"}}},"PostCustomerJsonV210":{"required":["user_id","customer_number","legal_name","mobile_phone_number","email","face_image","date_of_birth","relationship_status","dependants","dob_of_dependants","credit_rating","credit_limit","highest_education_attained","employment_status","kyc_status","last_ok_date"],"properties":{"email":{"type":"string","example":"person@example.com"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"customer_number":{"type":"string","example":"new customer number 687687678"},"highest_education_attained":{"type":"string","example":"Bachelor’s Degree"},"user_id":{"type":"string","example":"user_id to attach this customer to e.g. 123213"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"date_of_birth":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"employment_status":{"type":"string","example":"Employed"},"legal_name":{"type":"string","example":"NONE"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"5"},"relationship_status":{"type":"string","example":"Single"},"kyc_status":{"type":"boolean","example":"true"}}},"CustomerJsonV300":{"required":["bank_id","customer_id","customer_number","legal_name","mobile_phone_number","email","face_image","date_of_birth","relationship_status","dependants","dob_of_dependants","highest_education_attained","employment_status","kyc_status","last_ok_date","title","branchId","nameSuffix"],"properties":{"customer_id":{"type":"string","example":"123"},"email":{"type":"string","example":"contact@tesobe.com"},"mobile_phone_number":{"type":"string","example":"123"},"customer_number":{"type":"string","example":"123"},"highest_education_attained":{"type":"string","example":"123"},"branchId":{"type":"string","example":"12314"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string","example":"bankid1234"},"date_of_birth":{"type":"string","example":"19900101"},"nameSuffix":{"type":"string","example":"Sr"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"employment_status":{"type":"string","example":"123"},"legal_name":{"type":"string","example":"legal_name"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"title":{"type":"string","example":"Dr."},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"123"},"relationship_status":{"type":"string","example":"123"},"kyc_status":{"type":"boolean","example":"true"}}},"PostCustomerJsonV310":{"required":["legal_name","mobile_phone_number","email","face_image","date_of_birth","relationship_status","dependants","dob_of_dependants","credit_rating","credit_limit","highest_education_attained","employment_status","kyc_status","last_ok_date","title","branchId","nameSuffix"],"properties":{"email":{"type":"string","example":"person@example.com"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"highest_education_attained":{"type":"string","example":"string"},"branchId":{"type":"string","example":"12314"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"date_of_birth":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"nameSuffix":{"type":"string","example":"Sr"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"employment_status":{"type":"string","example":"Employed"},"legal_name":{"type":"string","example":"Tom Tom"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"title":{"type":"string","example":"Dr."},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"5"},"relationship_status":{"type":"string","example":"Single"},"kyc_status":{"type":"boolean","example":"true"}}},"CustomerJsonV310":{"required":["bank_id","customer_id","customer_number","legal_name","mobile_phone_number","email","face_image","date_of_birth","relationship_status","dependants","dob_of_dependants","highest_education_attained","employment_status","kyc_status","last_ok_date","title","branchId","nameSuffix"],"properties":{"customer_id":{"type":"string","example":"123"},"email":{"type":"string","example":"contact@tesobe.com"},"mobile_phone_number":{"type":"string","example":"123"},"customer_number":{"type":"string","example":"123"},"highest_education_attained":{"type":"string","example":"123"},"branchId":{"type":"string","example":"12314"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"bank_id":{"type":"string","example":"bankid1234"},"date_of_birth":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"nameSuffix":{"type":"string","example":"Sr"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"employment_status":{"type":"string","example":"123"},"legal_name":{"type":"string","example":"legal_name"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"title":{"type":"string","example":"Dr."},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"123"},"relationship_status":{"type":"string","example":"123"},"kyc_status":{"type":"boolean","example":"true"}}},"PostCustomerNumberJsonV310":{"required":["customer_number"],"properties":{"customer_number":{"type":"string","example":"123"}}},"TaxResidenceV310":{"required":["domain","tax_number","tax_residence_id"],"properties":{"tax_residence_id":{"type":"string","example":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"},"tax_number":{"type":"string","example":"Enter some number"},"domain":{"type":"string","example":"Enter some domain"}}},"PostTaxResidenceJsonV310":{"required":["domain","tax_number"],"properties":{"tax_number":{"type":"string","example":"Enter some number"},"domain":{"type":"string","example":"Enter some domain"}}},"TaxResidenceJsonV310":{"required":["tax_residence"],"properties":{"tax_residence":{"type":"array","items":{"$ref":"#/definitions/TaxResidenceV310"}}}},"TransactionRequestWithChargeJSON210":{"required":["id","type","from","details","transaction_ids","status","start_date","end_date","challenge","charge"],"properties":{"challenge":{"$ref":"#/definitions/ChallengeJsonV140"},"start_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"id":{"type":"string","example":"4050046c-63b3-4868-8a22-14b4181d33a6"},"end_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"status":{"type":"string","example":"COMPLETED"},"from":{"$ref":"#/definitions/TransactionRequestAccountJsonV140"},"details":{"$ref":"#/definitions/TransactionRequestBodyAllTypes"},"charge":{"$ref":"#/definitions/TransactionRequestChargeJsonV200"},"type":{"type":"string","example":"SANDBOX_TAN"},"transaction_ids":{"type":"array","items":{"type":"string"}}}},"TransactionRequestWithChargeJSONs210":{"required":["transaction_requests_with_charges"],"properties":{"transaction_requests_with_charges":{"type":"array","items":{"$ref":"#/definitions/TransactionRequestWithChargeJSON210"}}}},"AvailableRolesJSON":{"required":["roles"],"properties":{"roles":{"type":"array","items":{"$ref":"#/definitions/AvailableRoleJSON"}}}},"ConsumerJSON":{"required":["consumer_id","app_name","app_type","description","developer_email","redirect_url","created_by_user_id","created_by_user","enabled","created"],"properties":{"created_by_user_id":{"type":"string","example":"123213"},"app_type":{"type":"string","example":"Web"},"description":{"type":"string","example":"Account Management"},"created_by_user":{"$ref":"#/definitions/ResourceUserJSON"},"enabled":{"type":"boolean","example":"true"},"redirect_url":{"type":"string","example":"www.openbankproject.com"},"developer_email":{"type":"string","example":"contact@tesobe.com"},"consumer_id":{"type":"integer","format":"int64","example":"1213"},"app_name":{"type":"string","example":"SOFI"},"created":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"}}},"ConsumersJson":{"required":["list"],"properties":{"list":{"type":"array","items":{"$ref":"#/definitions/ConsumerJSON"}}}},"ConsumersJson":{"required":["consumers"],"properties":{"consumers":{"type":"array","items":{"$ref":"#/definitions/ConsumerJson"}}}},"PutEnabledJSON":{"required":["enabled"],"properties":{"enabled":{"type":"boolean","example":"false"}}},"ProductJsonV210":{"required":["bank_id","code","name","category","family","super_family","more_info_url","details","description","meta"],"properties":{"name":{"type":"string","example":"product name"},"description":{"type":"string","example":"Description"},"more_info_url":{"type":"string","example":"www.example.com/prod1/more-info.html"},"super_family":{"type":"string","example":"super family"},"code":{"type":"string","example":"prod1"},"bank_id":{"type":"string","example":"bankid123"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"details":{"type":"string","example":"Details"},"category":{"type":"string","example":"category"},"family":{"type":"string","example":"family"}}},"ProductsJsonV210":{"required":["products"],"properties":{"products":{"type":"array","items":{"$ref":"#/definitions/ProductJsonV210"}}}},"ProductTreeJsonV310":{"required":["bank_id","code","name","category","family","super_family","more_info_url","details","description","meta"],"properties":{"name":{"type":"string","example":"product name"},"description":{"type":"string","example":"Description"},"parent_product":{"$ref":"#/definitions/None$"},"more_info_url":{"type":"string","example":"www.example.com/prod1/more-info.html"},"super_family":{"type":"string","example":"super family"},"code":{"type":"string","example":"GRANDPARENT_CODE"},"bank_id":{"type":"string","example":"testBank2"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"details":{"type":"string","example":"Details"},"category":{"type":"string","example":"category"},"family":{"type":"string","example":"family"}}},"ProductTreeJsonV310":{"required":["bank_id","code","name","category","family","super_family","more_info_url","details","description","meta"],"properties":{"name":{"type":"string","example":"product name"},"description":{"type":"string","example":"Description"},"parent_product":{"$ref":"#/definitions/ProductTreeJsonV310"},"more_info_url":{"type":"string","example":"www.example.com/prod1/more-info.html"},"super_family":{"type":"string","example":"super family"},"code":{"type":"string","example":"PARENT_CODE"},"bank_id":{"type":"string","example":"testBank2"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"details":{"type":"string","example":"Details"},"category":{"type":"string","example":"category"},"family":{"type":"string","example":"family"}}},"ProductTreeJsonV310":{"required":["bank_id","code","name","category","family","super_family","more_info_url","details","description","meta"],"properties":{"name":{"type":"string","example":"product name"},"description":{"type":"string","example":"Description"},"parent_product":{"$ref":"#/definitions/ProductTreeJsonV310"},"more_info_url":{"type":"string","example":"www.example.com/prod1/more-info.html"},"super_family":{"type":"string","example":"super family"},"code":{"type":"string","example":"PRODUCT_CODE"},"bank_id":{"type":"string","example":"testBank2"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"details":{"type":"string","example":"Details"},"category":{"type":"string","example":"category"},"family":{"type":"string","example":"family"}}},"PostCounterpartyBespokeJson":{"required":["key","value"],"properties":{"value":{"type":"string","example":"english Name"},"key":{"type":"string","example":"englishName"}}},"PostCounterpartyJSON":{"required":["name","description","other_account_routing_scheme","other_account_routing_address","other_account_secondary_routing_scheme","other_account_secondary_routing_address","other_bank_routing_scheme","other_bank_routing_address","other_branch_routing_scheme","other_branch_routing_address","is_beneficiary","bespoke"],"properties":{"other_account_routing_address":{"type":"string","example":"7987987-2348987-234234"},"other_account_routing_scheme":{"type":"string","example":"accountNumber"},"name":{"type":"string","example":"CounterpartyName"},"other_account_secondary_routing_address":{"type":"string","example":"DE89370400440532013000"},"is_beneficiary":{"type":"boolean","example":"true"},"description":{"type":"string","example":"My landlord"},"other_branch_routing_address":{"type":"string","example":"10010"},"bespoke":{"type":"array","items":{"$ref":"#/definitions/PostCounterpartyBespokeJson"}},"other_bank_routing_scheme":{"type":"string","example":"bankCode"},"other_branch_routing_scheme":{"type":"string","example":"branchNumber"},"other_bank_routing_address":{"type":"string","example":"10"},"other_account_secondary_routing_scheme":{"type":"string","example":"IBAN"}}},"MetricsJson":{"required":["metrics"],"properties":{"metrics":{"type":"array","items":{"$ref":"#/definitions/MetricJson"}}}},"BranchJsonPutV210":{"required":["bank_id","name","address","location","meta","lobby","drive_up"],"properties":{"name":{"type":"string","example":"OBP"},"location":{"$ref":"#/definitions/LocationJsonV140"},"drive_up":{"$ref":"#/definitions/DriveUpStringJson"},"bank_id":{"type":"string","example":"gh.29.fi"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"lobby":{"$ref":"#/definitions/LobbyStringJson"},"address":{"$ref":"#/definitions/AddressJsonV140"}}},"BranchJsonPostV210":{"required":["id","bank_id","name","address","location","meta","lobby","drive_up"],"properties":{"name":{"type":"string","example":"OBP"},"location":{"$ref":"#/definitions/LocationJsonV140"},"drive_up":{"$ref":"#/definitions/DriveUpStringJson"},"bank_id":{"type":"string","example":"gh.29.fi"},"id":{"type":"string","example":"123"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"lobby":{"$ref":"#/definitions/LobbyStringJson"},"address":{"$ref":"#/definitions/AddressJsonV140"}}},"ConsumerRedirectUrlJSON":{"required":["redirect_url"],"properties":{"redirect_url":{"type":"string","example":"http://localhost:8888"}}},"ViewJSONV220":{"required":["id","short_name","description","is_public","alias","hide_metadata_if_alias_used","can_add_comment","can_add_corporate_location","can_add_image","can_add_image_url","can_add_more_info","can_add_open_corporates_url","can_add_physical_location","can_add_private_alias","can_add_public_alias","can_add_tag","can_add_url","can_add_where_tag","can_delete_comment","can_add_counterparty","can_delete_corporate_location","can_delete_image","can_delete_physical_location","can_delete_tag","can_delete_where_tag","can_edit_owner_comment","can_see_bank_account_balance","can_see_bank_account_bank_name","can_see_bank_account_currency","can_see_bank_account_iban","can_see_bank_account_label","can_see_bank_account_national_identifier","can_see_bank_account_number","can_see_bank_account_owners","can_see_bank_account_swift_bic","can_see_bank_account_type","can_see_comments","can_see_corporate_location","can_see_image_url","can_see_images","can_see_more_info","can_see_open_corporates_url","can_see_other_account_bank_name","can_see_other_account_iban","can_see_other_account_kind","can_see_other_account_metadata","can_see_other_account_national_identifier","can_see_other_account_number","can_see_other_account_swift_bic","can_see_owner_comment","can_see_physical_location","can_see_private_alias","can_see_public_alias","can_see_tags","can_see_transaction_amount","can_see_transaction_balance","can_see_transaction_currency","can_see_transaction_description","can_see_transaction_finish_date","can_see_transaction_metadata","can_see_transaction_other_bank_account","can_see_transaction_start_date","can_see_transaction_this_bank_account","can_see_transaction_type","can_see_url","can_see_where_tag"],"properties":{"can_see_transaction_start_date":{"type":"boolean","example":"true"},"can_add_url":{"type":"boolean","example":"true"},"can_add_where_tag":{"type":"boolean","example":"true"},"can_see_transaction_this_bank_account":{"type":"boolean","example":"true"},"can_see_bank_account_owners":{"type":"boolean","example":"true"},"can_see_private_alias":{"type":"boolean","example":"true"},"can_edit_owner_comment":{"type":"boolean","example":"true"},"can_see_other_account_national_identifier":{"type":"boolean","example":"true"},"can_see_public_alias":{"type":"boolean","example":"true"},"can_see_physical_location":{"type":"boolean","example":"true"},"can_see_owner_comment":{"type":"boolean","example":"true"},"can_see_bank_account_iban":{"type":"boolean","example":"true"},"can_see_corporate_location":{"type":"boolean","example":"true"},"can_see_bank_account_number":{"type":"boolean","example":"true"},"can_see_other_account_bank_name":{"type":"boolean","example":"true"},"description":{"type":"string","example":"description"},"can_see_transaction_other_bank_account":{"type":"boolean","example":"true"},"can_delete_corporate_location":{"type":"boolean","example":"true"},"can_see_comments":{"type":"boolean","example":"true"},"can_see_bank_account_bank_name":{"type":"boolean","example":"true"},"can_add_more_info":{"type":"boolean","example":"true"},"can_see_other_account_number":{"type":"boolean","example":"true"},"can_see_other_account_swift_bic":{"type":"boolean","example":"true"},"can_add_open_corporates_url":{"type":"boolean","example":"true"},"can_see_other_account_kind":{"type":"boolean","example":"true"},"can_delete_physical_location":{"type":"boolean","example":"true"},"can_see_bank_account_label":{"type":"boolean","example":"true"},"can_see_transaction_currency":{"type":"boolean","example":"true"},"is_public":{"type":"boolean","example":"true"},"can_see_transaction_finish_date":{"type":"boolean","example":"true"},"can_add_tag":{"type":"boolean","example":"true"},"can_see_images":{"type":"boolean","example":"true"},"can_see_bank_account_currency":{"type":"boolean","example":"true"},"hide_metadata_if_alias_used":{"type":"boolean","example":"true"},"can_delete_where_tag":{"type":"boolean","example":"true"},"alias":{"type":"string","example":"No"},"can_add_image_url":{"type":"boolean","example":"true"},"can_add_comment":{"type":"boolean","example":"true"},"can_see_image_url":{"type":"boolean","example":"true"},"id":{"type":"string","example":"1234"},"can_see_bank_account_national_identifier":{"type":"boolean","example":"true"},"can_add_counterparty":{"type":"boolean","example":"true"},"can_see_tags":{"type":"boolean","example":"true"},"can_see_open_corporates_url":{"type":"boolean","example":"true"},"short_name":{"type":"string","example":"short_name"},"can_delete_tag":{"type":"boolean","example":"true"},"can_see_more_info":{"type":"boolean","example":"true"},"can_see_transaction_metadata":{"type":"boolean","example":"true"},"can_delete_comment":{"type":"boolean","example":"true"},"can_see_where_tag":{"type":"boolean","example":"true"},"can_add_private_alias":{"type":"boolean","example":"true"},"can_add_public_alias":{"type":"boolean","example":"true"},"can_see_bank_account_swift_bic":{"type":"boolean","example":"true"},"can_add_image":{"type":"boolean","example":"true"},"can_see_transaction_type":{"type":"boolean","example":"true"},"can_see_other_account_iban":{"type":"boolean","example":"true"},"can_add_physical_location":{"type":"boolean","example":"true"},"can_add_corporate_location":{"type":"boolean","example":"true"},"can_delete_image":{"type":"boolean","example":"true"},"can_see_url":{"type":"boolean","example":"true"},"can_see_bank_account_balance":{"type":"boolean","example":"true"},"can_see_transaction_balance":{"type":"boolean","example":"true"},"can_see_transaction_amount":{"type":"boolean","example":"true"},"can_see_other_account_metadata":{"type":"boolean","example":"true"},"can_see_bank_account_type":{"type":"boolean","example":"true"},"can_see_transaction_description":{"type":"boolean","example":"true"}}},"ViewsJSONV220":{"required":["views"],"properties":{"views":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV220"}}}},"FXRateJsonV220":{"required":["bank_id","from_currency_code","to_currency_code","conversion_value","inverse_conversion_value","effective_date"],"properties":{"inverse_conversion_value":{"type":"number","format":"double","example":"0.998"},"to_currency_code":{"type":"string","example":"GBP"},"effective_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"conversion_value":{"type":"number","format":"double","example":"1.001"},"bank_id":{"type":"string","example":"bankid434"},"from_currency_code":{"type":"string","example":"EUR"}}},"CounterpartyJsonV220":{"required":["name","description","created_by_user_id","this_bank_id","this_account_id","this_view_id","counterparty_id","other_bank_routing_scheme","other_bank_routing_address","other_branch_routing_scheme","other_branch_routing_address","other_account_routing_scheme","other_account_routing_address","other_account_secondary_routing_scheme","other_account_secondary_routing_address","is_beneficiary","bespoke"],"properties":{"other_account_routing_address":{"type":"string","example":"7987987-2348987-234234"},"other_account_routing_scheme":{"type":"string","example":"accountNumber"},"created_by_user_id":{"type":"string","example":"49e1e147-64c1-4823-ad9f-89efcd02a9fa"},"name":{"type":"string","example":"CounterpartyName"},"other_account_secondary_routing_address":{"type":"string","example":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"},"is_beneficiary":{"type":"boolean","example":"true"},"description":{"type":"string","example":"My landlord"},"other_branch_routing_address":{"type":"string","example":"10010"},"bespoke":{"type":"array","items":{"$ref":"#/definitions/PostCounterpartyBespokeJson"}},"other_bank_routing_scheme":{"type":"string","example":"bankCode"},"other_branch_routing_scheme":{"type":"string","example":"branchNumber"},"this_account_id":{"type":"string","example":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"},"this_view_id":{"type":"string","example":"owner"},"other_bank_routing_address":{"type":"string","example":"10"},"this_bank_id":{"type":"string","example":"gh.29.uk"},"counterparty_id":{"type":"string","example":"1d65db7c-a7b2-4839-af41-958276ab7790"},"other_account_secondary_routing_scheme":{"type":"string","example":"accountId"}}},"CounterpartyMetadataJson":{"required":["publicAlias","moreInfo","url","imageURL","openCorporatesURL","corporateLocation","physicalLocation","privateAlias"],"properties":{"publicAlias":{"type":"string","example":"String"}}},"CounterpartyWithMetadataJson":{"required":["name","description","created_by_user_id","this_bank_id","this_account_id","this_view_id","counterparty_id","other_bank_routing_scheme","other_bank_routing_address","other_branch_routing_scheme","other_branch_routing_address","other_account_routing_scheme","other_account_routing_address","other_account_secondary_routing_scheme","other_account_secondary_routing_address","is_beneficiary","bespoke","metadata"],"properties":{"other_account_routing_address":{"type":"string","example":"7987987-2348987-234234"},"other_account_routing_scheme":{"type":"string","example":"accountNumber"},"created_by_user_id":{"type":"string","example":"49e1e147-64c1-4823-ad9f-89efcd02a9fa"},"name":{"type":"string","example":"CounterpartyName"},"other_account_secondary_routing_address":{"type":"string","example":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"},"is_beneficiary":{"type":"boolean","example":"true"},"description":{"type":"string","example":"My landlord"},"other_branch_routing_address":{"type":"string","example":"10010"},"bespoke":{"type":"array","items":{"$ref":"#/definitions/PostCounterpartyBespokeJson"}},"other_bank_routing_scheme":{"type":"string","example":"bankCode"},"other_branch_routing_scheme":{"type":"string","example":"branchNumber"},"this_account_id":{"type":"string","example":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"},"this_view_id":{"type":"string","example":"owner"},"metadata":{"$ref":"#/definitions/CounterpartyMetadataJson"},"other_bank_routing_address":{"type":"string","example":"10"},"this_bank_id":{"type":"string","example":"gh.29.uk"},"counterparty_id":{"type":"string","example":"1d65db7c-a7b2-4839-af41-958276ab7790"},"other_account_secondary_routing_scheme":{"type":"string","example":"accountId"}}},"CounterpartiesJsonV220":{"required":["counterparties"],"properties":{"counterparties":{"type":"array","items":{"$ref":"#/definitions/CounterpartyJsonV220"}}}},"BankJSONV220":{"required":["id","full_name","short_name","logo_url","website_url","swift_bic","national_identifier","bank_routing"],"properties":{"national_identifier":{"type":"string","example":"UK97ZZZ1234567890"},"full_name":{"type":"string","example":"uk"},"swift_bic":{"type":"string","example":"IIIGGB22"},"logo_url":{"type":"string","example":"https://static.openbankproject.com/images/sandbox/bank_x.png"},"id":{"type":"string","example":"gh.29.uk.x"},"short_name":{"type":"string","example":"uk"},"bank_routing":{"$ref":"#/definitions/BankRoutingJsonV121"},"website_url":{"type":"string","example":"https://www.example.com"}}},"BranchJsonV220":{"required":["id","bank_id","name","address","location","meta","lobby","drive_up","branch_routing"],"properties":{"name":{"type":"string","example":"OBP"},"location":{"$ref":"#/definitions/LocationJsonV140"},"branch_routing":{"$ref":"#/definitions/BranchRoutingJsonV141"},"drive_up":{"$ref":"#/definitions/DriveUpStringJson"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"123"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"lobby":{"$ref":"#/definitions/LobbyStringJson"},"address":{"$ref":"#/definitions/AddressJsonV140"}}},"AtmJsonV220":{"required":["id","bank_id","name","address","location","meta"],"properties":{"name":{"type":"string","example":"OBP"},"location":{"$ref":"#/definitions/LocationJsonV140"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"123"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"address":{"$ref":"#/definitions/AddressJsonV140"}}},"ProductJsonV220":{"required":["bank_id","code","name","category","family","super_family","more_info_url","details","description","meta"],"properties":{"name":{"type":"string","example":"product name"},"description":{"type":"string","example":"Description"},"more_info_url":{"type":"string","example":"www.example.com/prod1/more-info.html"},"super_family":{"type":"string","example":"super family"},"code":{"type":"string","example":"prod1"},"bank_id":{"type":"string","example":"bankid123"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"details":{"type":"string","example":"Details"},"category":{"type":"string","example":"category"},"family":{"type":"string","example":"family"}}},"PostPutProductJsonV310":{"required":["bank_id","name","parent_product_code","category","family","super_family","more_info_url","details","description","meta"],"properties":{"name":{"type":"string","example":"product name"},"description":{"type":"string","example":"Description"},"more_info_url":{"type":"string","example":"www.example.com/prod1/more-info.html"},"super_family":{"type":"string","example":"super family"},"bank_id":{"type":"string","example":"bankid123"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"details":{"type":"string","example":"Details"},"category":{"type":"string","example":"category"},"family":{"type":"string","example":"family"},"parent_product_code":{"type":"string","example":"parent product name"}}},"PutProductCollectionsV310":{"required":["parent_product_code","children_product_codes"],"properties":{"children_product_codes":{"type":"array","items":{"type":"string"}},"parent_product_code":{"type":"string","example":"A"}}},"FXRateJsonV220":{"required":["bank_id","from_currency_code","to_currency_code","conversion_value","inverse_conversion_value","effective_date"],"properties":{"inverse_conversion_value":{"type":"number","format":"double","example":"1.0"},"to_currency_code":{"type":"string","example":"USD"},"effective_date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"conversion_value":{"type":"number","format":"double","example":"1.0"},"bank_id":{"type":"string","example":"bankid123"},"from_currency_code":{"type":"string","example":"EUR"}}},"CreateAccountJSONV220":{"required":["user_id","label","type","balance","branch_id","account_routing"],"properties":{"account_routing":{"$ref":"#/definitions/AccountRoutingJsonV121"},"branch_id":{"type":"string","example":"1234"},"label":{"type":"string","example":"Label"},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"user_id":{"type":"string","example":"66214b8e-259e-44ad-8868-3eb47be70646"},"type":{"type":"string","example":"CURRENT"}}},"CachedFunctionJSON":{"required":["function_name","ttl_in_seconds"],"properties":{"ttl_in_seconds":{"type":"integer","format":"int32","example":"5"},"function_name":{"type":"string","example":"getBanks"}}},"PortJSON":{"required":["property","value"],"properties":{"value":{"type":"string","example":"8080"},"property":{"type":"string","example":"default"}}},"AkkaJSON":{"required":["ports","log_level"],"properties":{"remote_data_secret_matched":{"type":"boolean","example":"true"},"log_level":{"type":"string","example":"Debug"},"ports":{"type":"array","items":{"$ref":"#/definitions/PortJSON"}}}},"MetricsJSON":{"required":["property","value"],"properties":{"value":{"type":"string","example":"Mapper"},"property":{"type":"string","example":"String"}}},"WarehouseJSON":{"required":["property","value"],"properties":{"value":{"type":"string","example":"ElasticSearch"},"property":{"type":"string","example":"String"}}},"ElasticSearchJSON":{"required":["metrics","warehouse"],"properties":{"warehouse":{"type":"array","items":{"$ref":"#/definitions/WarehouseJSON"}},"metrics":{"type":"array","items":{"$ref":"#/definitions/MetricsJSON"}}}},"ConfigurationJSON":{"required":["akka","elastic_search","cache"],"properties":{"cache":{"type":"array","items":{"$ref":"#/definitions/CachedFunctionJSON"}},"elastic_search":{"$ref":"#/definitions/ElasticSearchJSON"},"akka":{"$ref":"#/definitions/AkkaJSON"}}},"ConnectorMetricJson":{"required":["connector_name","function_name","correlation_id","date","duration"],"properties":{"connector_name":{"type":"string","example":"mapper"},"duration":{"type":"integer","format":"int64","example":"1000"},"function_name":{"type":"string","example":"getBanks"},"correlation_id":{"type":"string","example":"12345"},"date":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"}}},"ConnectorMetricsJson":{"required":["metrics"],"properties":{"metrics":{"type":"array","items":{"$ref":"#/definitions/ConnectorMetricJson"}}}},"ViewJsonV300":{"required":["id","short_name","description","metadata_view","is_public","alias","hide_metadata_if_alias_used","can_add_comment","can_add_corporate_location","can_add_image","can_add_image_url","can_add_more_info","can_add_open_corporates_url","can_add_physical_location","can_add_private_alias","can_add_public_alias","can_add_tag","can_add_url","can_add_where_tag","can_delete_comment","can_add_counterparty","can_delete_corporate_location","can_delete_image","can_delete_physical_location","can_delete_tag","can_delete_where_tag","can_edit_owner_comment","can_see_bank_account_balance","can_query_available_funds","can_see_bank_account_bank_name","can_see_bank_account_currency","can_see_bank_account_iban","can_see_bank_account_label","can_see_bank_account_national_identifier","can_see_bank_account_number","can_see_bank_account_owners","can_see_bank_account_swift_bic","can_see_bank_account_type","can_see_comments","can_see_corporate_location","can_see_image_url","can_see_images","can_see_more_info","can_see_open_corporates_url","can_see_other_account_bank_name","can_see_other_account_iban","can_see_other_account_kind","can_see_other_account_metadata","can_see_other_account_national_identifier","can_see_other_account_number","can_see_other_account_swift_bic","can_see_owner_comment","can_see_physical_location","can_see_private_alias","can_see_public_alias","can_see_tags","can_see_transaction_amount","can_see_transaction_balance","can_see_transaction_currency","can_see_transaction_description","can_see_transaction_finish_date","can_see_transaction_metadata","can_see_transaction_other_bank_account","can_see_transaction_start_date","can_see_transaction_this_bank_account","can_see_transaction_type","can_see_url","can_see_where_tag","can_see_bank_routing_scheme","can_see_bank_routing_address","can_see_bank_account_routing_scheme","can_see_bank_account_routing_address","can_see_other_bank_routing_scheme","can_see_other_bank_routing_address","can_see_other_account_routing_scheme","can_see_other_account_routing_address","can_add_transaction_request_to_own_account","can_add_transaction_request_to_any_account","can_see_bank_account_credit_limit"],"properties":{"can_see_transaction_start_date":{"type":"boolean","example":"true"},"can_add_url":{"type":"boolean","example":"true"},"can_add_where_tag":{"type":"boolean","example":"true"},"can_see_transaction_this_bank_account":{"type":"boolean","example":"true"},"can_see_bank_account_owners":{"type":"boolean","example":"true"},"can_see_bank_routing_address":{"type":"boolean","example":"true"},"can_see_private_alias":{"type":"boolean","example":"true"},"can_edit_owner_comment":{"type":"boolean","example":"true"},"can_see_other_account_national_identifier":{"type":"boolean","example":"true"},"can_see_bank_routing_scheme":{"type":"boolean","example":"true"},"can_see_public_alias":{"type":"boolean","example":"true"},"can_see_physical_location":{"type":"boolean","example":"true"},"can_see_owner_comment":{"type":"boolean","example":"true"},"can_see_bank_account_iban":{"type":"boolean","example":"true"},"can_see_corporate_location":{"type":"boolean","example":"true"},"can_see_bank_account_number":{"type":"boolean","example":"true"},"can_see_other_account_bank_name":{"type":"boolean","example":"true"},"description":{"type":"string","example":"description"},"can_see_bank_account_routing_scheme":{"type":"boolean","example":"true"},"can_see_transaction_other_bank_account":{"type":"boolean","example":"true"},"can_delete_corporate_location":{"type":"boolean","example":"true"},"can_see_comments":{"type":"boolean","example":"true"},"can_see_bank_account_bank_name":{"type":"boolean","example":"true"},"can_add_more_info":{"type":"boolean","example":"true"},"can_see_other_account_number":{"type":"boolean","example":"true"},"can_see_other_account_swift_bic":{"type":"boolean","example":"true"},"can_add_open_corporates_url":{"type":"boolean","example":"true"},"can_see_other_account_kind":{"type":"boolean","example":"true"},"can_add_transaction_request_to_own_account":{"type":"boolean","example":"true"},"can_delete_physical_location":{"type":"boolean","example":"true"},"can_see_bank_account_label":{"type":"boolean","example":"true"},"can_see_transaction_currency":{"type":"boolean","example":"true"},"is_public":{"type":"boolean","example":"true"},"can_see_transaction_finish_date":{"type":"boolean","example":"true"},"can_see_bank_account_routing_address":{"type":"boolean","example":"true"},"can_add_tag":{"type":"boolean","example":"true"},"can_see_images":{"type":"boolean","example":"true"},"can_query_available_funds":{"type":"boolean","example":"true"},"can_see_bank_account_credit_limit":{"type":"boolean","example":"true"},"can_see_bank_account_currency":{"type":"boolean","example":"true"},"hide_metadata_if_alias_used":{"type":"boolean","example":"true"},"can_delete_where_tag":{"type":"boolean","example":"true"},"alias":{"type":"string","example":"No"},"can_add_image_url":{"type":"boolean","example":"true"},"can_add_comment":{"type":"boolean","example":"true"},"can_see_image_url":{"type":"boolean","example":"true"},"id":{"type":"string","example":"1234"},"can_see_bank_account_national_identifier":{"type":"boolean","example":"true"},"can_add_counterparty":{"type":"boolean","example":"true"},"can_add_transaction_request_to_any_account":{"type":"boolean","example":"true"},"can_see_tags":{"type":"boolean","example":"true"},"can_see_open_corporates_url":{"type":"boolean","example":"true"},"short_name":{"type":"string","example":"short_name"},"can_delete_tag":{"type":"boolean","example":"true"},"can_see_other_account_routing_scheme":{"type":"boolean","example":"true"},"can_see_more_info":{"type":"boolean","example":"true"},"can_see_transaction_metadata":{"type":"boolean","example":"true"},"can_delete_comment":{"type":"boolean","example":"true"},"can_see_where_tag":{"type":"boolean","example":"true"},"can_add_private_alias":{"type":"boolean","example":"true"},"can_add_public_alias":{"type":"boolean","example":"true"},"can_see_bank_account_swift_bic":{"type":"boolean","example":"true"},"can_add_image":{"type":"boolean","example":"true"},"can_see_transaction_type":{"type":"boolean","example":"true"},"can_see_other_account_routing_address":{"type":"boolean","example":"true"},"can_see_other_account_iban":{"type":"boolean","example":"true"},"can_add_physical_location":{"type":"boolean","example":"true"},"can_add_corporate_location":{"type":"boolean","example":"true"},"can_delete_image":{"type":"boolean","example":"true"},"can_see_url":{"type":"boolean","example":"true"},"can_see_bank_account_balance":{"type":"boolean","example":"true"},"can_see_other_bank_routing_address":{"type":"boolean","example":"true"},"can_see_transaction_balance":{"type":"boolean","example":"true"},"metadata_view":{"type":"string","example":"owner"},"can_see_transaction_amount":{"type":"boolean","example":"true"},"can_see_other_account_metadata":{"type":"boolean","example":"true"},"can_see_bank_account_type":{"type":"boolean","example":"true"},"can_see_other_bank_routing_scheme":{"type":"boolean","example":"true"},"can_see_transaction_description":{"type":"boolean","example":"true"}}},"ViewsJsonV300":{"required":["views"],"properties":{"views":{"type":"array","items":{"$ref":"#/definitions/ViewJsonV300"}}}},"CoreAccountJsonV300":{"required":["id","label","bank_id","account_routings"],"properties":{"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"bank_id":{"type":"string","example":"gh.29.uk"},"label":{"type":"string","example":"String"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"}}},"ViewBasic":{"required":["id","short_name","description","is_public"],"properties":{"is_public":{"type":"boolean","example":"false"},"description":{"type":"string","example":"description"},"short_name":{"type":"string","example":"short_name"},"id":{"type":"string","example":"123"}}},"CoreAccountJson":{"required":["id","label","bank_id","account_type","account_routings","views"],"properties":{"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"label":{"type":"string","example":"String"},"account_type":{"type":"string","example":"330"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"views":{"type":"array","items":{"$ref":"#/definitions/ViewBasic"}}}},"CoreAccountsJsonV300":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/CoreAccountJson"}}}},"Balances":{"required":["balances"],"properties":{"balances":{"type":"string","example":"/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"}}},"Transactions":{"required":["trasactions"],"properties":{"trasactions":{"type":"string","example":"/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions"}}},"CoreAccountJsonV1":{"required":["id","iban","currency","accountType","cashAccountType","_links","name"],"properties":{"name":{"type":"string","example":"Main Account"},"cashAccountType":{"type":"string","example":"CurrentAccount"},"id":{"type":"string","example":"3dc3d5b3-7023-4848-9853-f5400a64e80f"},"accountType":{"type":"string","example":"Girokonto"},"currency":{"type":"string","example":"EUR"},"iban":{"type":"string","example":"DE2310010010123456789"},"_links":{"type":"array","items":{"$ref":"#/definitions/Balances"}}}},"CoreAccountsJsonV1":{"required":["account$minuslist"],"properties":{"account$minuslist":{"type":"array","items":{"$ref":"#/definitions/CoreAccountJsonV1"}}}},"AmountOfMoneyV1":{"required":["currency","content"],"properties":{"content":{"type":"string","example":"String"},"currency":{"type":"string","example":"String"}}},"AccountInner":{"required":["SchemeName","Identification","Name"],"properties":{"SecondaryIdentification":{"type":"string","example":"00021"},"Name":{"type":"string","example":"Mr Kevin"},"Identification":{"type":"string","example":"80200110203345"},"SchemeName":{"type":"string","example":"SortCodeAccountNumber"}}},"Account":{"required":["AccountId","Currency","AccountType","AccountSubType","Nickname","Account"],"properties":{"AccountSubType":{"type":"string","example":"CurrentAccount"},"Nickname":{"type":"string","example":"Bills"},"Currency":{"type":"string","example":"GBP"},"AccountType":{"type":"string","example":"Personal"},"AccountId":{"type":"string","example":"22289"},"Account":{"$ref":"#/definitions/AccountInner"}}},"AccountList":{"required":["Account"],"properties":{"Account":{"type":"array","items":{"$ref":"#/definitions/Account"}}}},"Links":{"required":["Self"],"properties":{"Self":{"type":"string","example":"https://citizensbank.openbankproject.com/open-banking/v2.0/accounts/"}}},"MetaUK":{"required":["TotalPages"],"properties":{"TotalPages":{"type":"integer","format":"int32","example":"1"}}},"Accounts":{"required":["Data","Links","Meta"],"properties":{"Meta":{"$ref":"#/definitions/MetaUK"},"Links":{"$ref":"#/definitions/Links"},"Data":{"$ref":"#/definitions/AccountList"}}},"ClosingBookedBody":{"required":["amount","date"],"properties":{"date":{"type":"string","example":"2017-10-25"},"amount":{"$ref":"#/definitions/AmountOfMoneyV1"}}},"ExpectedBody":{"required":["amount","lastActionDateTime"],"properties":{"lastActionDateTime":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"amount":{"$ref":"#/definitions/AmountOfMoneyV1"}}},"AccountBalance":{"required":["closingBooked","expected"],"properties":{"expected":{"$ref":"#/definitions/ExpectedBody"},"closingBooked":{"$ref":"#/definitions/ClosingBookedBody"}}},"AccountBalances":{"required":["balances"],"properties":{"balances":{"type":"array","items":{"$ref":"#/definitions/AccountBalance"}}}},"TransactionJsonV1":{"required":["transactionId","creditorName","creditorAccount","amount","bookingDate","valueDate","remittanceInformationUnstructured"],"properties":{"remittanceInformationUnstructured":{"type":"string","example":"String"},"creditorAccount":{"$ref":"#/definitions/IbanJson"},"amount":{"$ref":"#/definitions/AmountOfMoneyV1"},"valueDate":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"creditorName":{"type":"string","example":"String"},"bookingDate":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"transactionId":{"type":"string","example":"String"}}},"ViewAccount":{"required":["viewAccount"],"properties":{"viewAccount":{"type":"string","example":"/v1/accounts/3dc3d5b3-7023-4848-9853- f5400a64e80f"}}},"TransactionsJsonV1":{"required":["transactions_booked","transactions_pending","_links"],"properties":{"_links":{"type":"array","items":{"$ref":"#/definitions/ViewAccount"}},"transactions_pending":{"type":"array","items":{"$ref":"#/definitions/TransactionJsonV1"}},"transactions_booked":{"type":"array","items":{"$ref":"#/definitions/TransactionJsonV1"}}}},"AccountIdJson":{"required":["id"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"}}},"AccountsIdsJsonV300":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/AccountIdJson"}}}},"AdapterInfoJsonV300":{"required":["name","version","git_commit","date"],"properties":{"date":{"type":"string","example":"2013-01-21T23:08:00Z"},"git_commit":{"type":"string","example":"String"},"version":{"type":"string","example":"String"},"name":{"type":"string","example":"String"}}},"RateLimitingInfoV310":{"required":["enabled","technology","service_available","is_active"],"properties":{"is_active":{"type":"boolean","example":"true"},"service_available":{"type":"boolean","example":"true"},"technology":{"type":"string","example":"REDIS"},"enabled":{"type":"boolean","example":"true"}}},"ThisAccountJsonV300":{"required":["id","bank_routing","account_routings","holders"],"properties":{"holders":{"type":"array","items":{"$ref":"#/definitions/AccountHolderJSON"}},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"bank_routing":{"$ref":"#/definitions/BankRoutingJsonV121"},"id":{"type":"string","example":"String"}}},"OtherAccountJsonV300":{"required":["id","holder","bank_routing","account_routings","metadata"],"properties":{"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"holder":{"$ref":"#/definitions/AccountHolderJSON"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"metadata":{"$ref":"#/definitions/OtherAccountMetadataJSON"},"bank_routing":{"$ref":"#/definitions/BankRoutingJsonV121"}}},"OtherAccountsJsonV300":{"required":["other_accounts"],"properties":{"other_accounts":{"type":"array","items":{"$ref":"#/definitions/OtherAccountJsonV300"}}}},"TransactionJsonV300":{"required":["id","this_account","other_account","details","metadata"],"properties":{"this_account":{"$ref":"#/definitions/ThisAccountJsonV300"},"id":{"type":"string","example":"String"},"details":{"$ref":"#/definitions/TransactionDetailsJSON"},"metadata":{"$ref":"#/definitions/TransactionMetadataJSON"},"other_account":{"$ref":"#/definitions/OtherAccountJsonV300"}}},"TransactionsJsonV300":{"required":["transactions"],"properties":{"transactions":{"type":"array","items":{"$ref":"#/definitions/TransactionJsonV300"}}}},"CoreCounterpartyJsonV300":{"required":["id","holder","bank_routing","account_routings"],"properties":{"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"bank_routing":{"$ref":"#/definitions/BankRoutingJsonV121"},"holder":{"$ref":"#/definitions/AccountHolderJSON"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"}}},"CoreTransactionJsonV300":{"required":["id","this_account","other_account","details"],"properties":{"details":{"$ref":"#/definitions/CoreTransactionDetailsJSON"},"other_account":{"$ref":"#/definitions/CoreCounterpartyJsonV300"},"this_account":{"$ref":"#/definitions/ThisAccountJsonV300"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"}}},"CoreCounterpartiesJsonV300":{"required":["counterparties"],"properties":{"counterparties":{"type":"array","items":{"$ref":"#/definitions/CoreCounterpartyJsonV300"}}}},"CoreTransactionsJsonV300":{"required":["transactions"],"properties":{"transactions":{"type":"array","items":{"$ref":"#/definitions/CoreTransactionJsonV300"}}}},"AccountHeldJson":{"required":["id","bank_id","number","account_routings"],"properties":{"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"number":{"type":"string","example":"123"},"bank_id":{"type":"string","example":"123"},"id":{"type":"string","example":"12314"}}},"CoreAccountsHeldJsonV300":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/AccountHeldJson"}}}},"ModeratedAccountJsonV300":{"required":["id","bank_id","label","number","owners","type","balance","views_available","account_routings"],"properties":{"number":{"type":"string","example":"String"},"views_available":{"type":"array","items":{"$ref":"#/definitions/ViewJsonV300"}},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"label":{"type":"string","example":"String"},"owners":{"type":"array","items":{"$ref":"#/definitions/UserJSONV121"}},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"String"},"type":{"type":"string","example":"String"}}},"ModeratedCoreAccountJsonV300":{"required":["id","bank_id","label","number","owners","type","balance","account_routings","account_rules"],"properties":{"number":{"type":"string","example":"String"},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"label":{"type":"string","example":"String"},"owners":{"type":"array","items":{"$ref":"#/definitions/UserJSONV121"}},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"bank_id":{"type":"string","example":"String"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"type":{"type":"string","example":"String"},"account_rules":{"type":"array","items":{"$ref":"#/definitions/AccountRuleJsonV300"}}}},"ModeratedCoreAccountsJsonV300":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/ModeratedCoreAccountJsonV300"}}}},"AggregateMetricJSON":{"required":["count","average_response_time","minimum_response_time","maximum_response_time"],"properties":{"maximum_response_time":{"type":"number","format":"double","example":"9039.0"},"minimum_response_time":{"type":"number","format":"double","example":"1.0"},"average_response_time":{"type":"number","format":"double","example":"65.21"},"count":{"type":"integer","format":"int32","example":"7076"}}},"BankTransactionCodeJson":{"required":["Code","SubCode"],"properties":{"SubCode":{"type":"string","example":"DomesticCreditTransfer"},"Code":{"type":"string","example":"ReceivedCreditTransfer"}}},"BalanceUKOpenBankingJson":{"required":["Amount","CreditDebitIndicator","Type"],"properties":{"Type":{"type":"string","example":"InterimBooked"},"CreditDebitIndicator":{"type":"string","example":"Credit"},"Amount":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"TransactionCodeJson":{"required":["Code","Issuer"],"properties":{"Issuer":{"type":"string","example":"AlphaBank"},"Code":{"type":"string","example":"Transfer"}}},"TransactionInnerJson":{"required":["AccountId","TransactionId","TransactionReference","Amount","CreditDebitIndicator","Status","BookingDateTime","ValueDateTime","TransactionInformation","BankTransactionCode","ProprietaryBankTransactionCode","Balance"],"properties":{"TransactionInformation":{"type":"string","example":"Cash from Aubrey"},"Balance":{"$ref":"#/definitions/BalanceUKOpenBankingJson"},"BookingDateTime":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"CreditDebitIndicator":{"type":"string","example":"Credit"},"TransactionReference":{"type":"string","example":"Ref 1"},"Amount":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"ProprietaryBankTransactionCode":{"$ref":"#/definitions/TransactionCodeJson"},"TransactionId":{"type":"string","example":"123"},"AccountId":{"type":"string","example":"123"},"ValueDateTime":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"BankTransactionCode":{"$ref":"#/definitions/BankTransactionCodeJson"},"Status":{"type":"string","example":"Booked"}}},"TransactionsInnerJson":{"required":["Transaction"],"properties":{"Transaction":{"type":"array","items":{"$ref":"#/definitions/TransactionInnerJson"}}}},"MetaInnerJson":{"required":["TotalPages","FirstAvailableDateTime","LastAvailableDateTime"],"properties":{"LastAvailableDateTime":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"FirstAvailableDateTime":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"TotalPages":{"type":"integer","format":"int32","example":"1"}}},"TransactionsJsonUKV200":{"required":["Data","Links","Meta"],"properties":{"Meta":{"$ref":"#/definitions/MetaInnerJson"},"Links":{"$ref":"#/definitions/Links"},"Data":{"$ref":"#/definitions/TransactionsInnerJson"}}},"CreditLineJson":{"required":["Included","Amount","Type"],"properties":{"Type":{"type":"string","example":"Pre-Agreed"},"Amount":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"Included":{"type":"boolean","example":"true"}}},"BalanceJsonUKV200":{"required":["AccountId","Amount","CreditDebitIndicator","Type","DateTime","CreditLine"],"properties":{"CreditDebitIndicator":{"type":"string","example":"Credit"},"Amount":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"DateTime":{"type":"string","format":"date","example":"Tue Sep 19 00:00:00 UTC 2017"},"AccountId":{"type":"string","example":"22289"},"CreditLine":{"type":"array","items":{"$ref":"#/definitions/CreditLineJson"}},"Type":{"type":"string","example":"InterimAvailable"}}},"DataJsonUKV200":{"required":["Balance"],"properties":{"Balance":{"type":"array","items":{"$ref":"#/definitions/BalanceJsonUKV200"}}}},"MetaBisJson":{"required":["TotalPages"],"properties":{"TotalPages":{"type":"integer","format":"int32","example":"1"}}},"AccountBalancesUKV200":{"required":["Data","Links","Meta"],"properties":{"Meta":{"$ref":"#/definitions/MetaBisJson"},"Links":{"$ref":"#/definitions/Links"},"Data":{"$ref":"#/definitions/DataJsonUKV200"}}},"CreateScopeJson":{"required":["bank_id","role_name"],"properties":{"role_name":{"type":"string","example":"CanGetEntitlementsForAnyUserAtOneBank"},"bank_id":{"type":"string","example":"gh.29.uk"}}},"ScopeJson":{"required":["scope_id","role_name","bank_id"],"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"role_name":{"type":"string","example":"CanGetEntitlementsForAnyUserAtOneBank"},"scope_id":{"type":"string","example":"88625da4-a671-435e-9d24-e5b6e5cc404f"}}},"ScopeJsons":{"required":["list"],"properties":{"list":{"type":"array","items":{"$ref":"#/definitions/ScopeJson"}}}},"OrderObjectJson":{"required":["order_id","order_date","number_of_checkbooks","distribution_channel","status","first_check_number","shipping_code"],"properties":{"order_id":{"type":"string","example":"xjksajfkj"},"number_of_checkbooks":{"type":"string","example":"4"},"first_check_number":{"type":"string","example":"5165276"},"order_date":{"type":"string","example":"07082013"},"status":{"type":"string","example":"2"},"shipping_code":{"type":"string","example":"1"},"distribution_channel":{"type":"string","example":"1201"}}},"OrderJson":{"required":["order"],"properties":{"order":{"$ref":"#/definitions/OrderObjectJson"}}},"AccountV310Json":{"required":["bank_id","account_id","account_type","account_routings","branch_routings"],"properties":{"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"account_type":{"type":"string","example":"330"},"bank_id":{"type":"string","example":"10"},"account_id":{"type":"string","example":"xjfsafjj"},"branch_routings":{"type":"array","items":{"$ref":"#/definitions/BranchRoutingJsonV141"}}}},"CheckbookOrdersJson":{"required":["account","orders"],"properties":{"orders":{"type":"array","items":{"$ref":"#/definitions/OrderJson"}},"account":{"$ref":"#/definitions/AccountV310Json"}}},"CheckFundsAvailableJson":{"required":["answer","date","available_funds_request_id"],"properties":{"available_funds_request_id":{"type":"string","example":"c4ykz59svsr9b7fmdxk8ezs7"},"date":{"type":"string","format":"date","example":"Fri Mar 15 15:09:15 UTC 2019"},"answer":{"type":"string","example":"yes"}}},"CardObjectJson":{"required":["card_type","card_description","use_type"],"properties":{"use_type":{"type":"string","example":"3"},"card_description":{"type":"string","example":"good"},"card_type":{"type":"string","example":"5"}}},"CreditCardOrderStatusResponseJson":{"required":["cards"],"properties":{"cards":{"type":"array","items":{"$ref":"#/definitions/CardObjectJson"}}}},"CreditLimitRequestJson":{"required":["requested_current_rate_amount1","requested_current_rate_amount2","requested_current_valid_end_date","current_credit_documentation","temporary_requested_current_amount","requested_temporary_valid_end_date","temporary_credit_documentation"],"properties":{"requested_current_rate_amount1":{"type":"string","example":"String"},"temporary_credit_documentation":{"type":"string","example":"String"},"requested_current_valid_end_date":{"type":"string","example":"String"},"temporary_requested_current_amount":{"type":"string","example":"String"},"requested_current_rate_amount2":{"type":"string","example":"String"},"requested_temporary_valid_end_date":{"type":"string","example":"String"},"current_credit_documentation":{"type":"string","example":"String"}}},"CreditLimitOrderResponseJson":{"required":["execution_time","execution_date","token","short_reference"],"properties":{"short_reference":{"type":"string","example":"String"},"token":{"type":"string","example":"String"},"execution_date":{"type":"string","example":"String"},"execution_time":{"type":"string","example":"String"}}},"CreditLimitOrderJson":{"required":["rank_amount_1","nominal_interest_1","rank_amount_2","nominal_interest_2"],"properties":{"nominal_interest_2":{"type":"string","example":"String"},"rank_amount_2":{"type":"string","example":"String"},"nominal_interest_1":{"type":"string","example":"String"},"rank_amount_1":{"type":"string","example":"String"}}},"TopApiJson":{"required":["count","Implemented_by_partial_function","implemented_in_version"],"properties":{"implemented_in_version":{"type":"string","example":"v1.2.1"},"Implemented_by_partial_function":{"type":"string","example":"getBanks"},"count":{"type":"integer","format":"int32","example":"7076"}}},"TopApisJson":{"required":["top_apis"],"properties":{"top_apis":{"type":"array","items":{"$ref":"#/definitions/TopApiJson"}}}},"TopConsumerJson":{"required":["count","consumer_id","app_name","developer_email"],"properties":{"developer_email":{"type":"string","example":"tesobe@tesobe.com"},"app_name":{"type":"string","example":"Api Explorer"},"consumer_id":{"type":"string","example":"12312312"},"count":{"type":"integer","format":"int32","example":"7076"}}},"TopConsumersJson":{"required":["top_consumers"],"properties":{"top_consumers":{"type":"array","items":{"$ref":"#/definitions/TopConsumerJson"}}}},"GlossaryItem":{"required":["title","description","htmlDescription","textDescription"],"properties":{"textDescription":{"type":"string","example":"