{"swagger":"2.0","info":{"title":"Open Bank Project API","description":"An Open Source API for Banks. (c) TESOBE GmbH. 2011 - 2024. Licensed under the AGPL and commercial licences.","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v4.0.0"},"host":"api.ttk.com.mk","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Direct-Login","in":"header","name":"Authorization"},"gatewayLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Gateway-Login","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/obp/v4.0.0/account/check/scheme/IBAN":{"post":{"tags":["Account","New-Style"],"summary":"Validate and check IBAN number","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
Validate and check IBAN number for errors
Authentication is Optional
","operationId":"OBPv4.0.0-ibanChecker","parameters":[{"in":"body","name":"body","description":"IbanAddress object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/IbanAddress"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/IbanCheckerJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v4.0.0/accounts/public":{"get":{"tags":["Account-Public","Account","PublicData"],"summary":"Get Public Accounts at all Banks","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get public accounts at all banks (Anonymous access).
Returns accounts that contain at least one public view (a view where is_public is true)
For each account the API returns the ID and the available views.
Authentication is Optional
","operationId":"OBPv2.0.0-publicAccountsAllBanks","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BasicAccountsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorCannotGetAccounts"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/account-applications":{"get":{"tags":["Account-Application","Account","New-Style"],"summary":"Get Account Applications","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the Account Applications.
Authentication is Mandatory
","operationId":"OBPv3.1.0-getAccountApplications","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AccountApplicationsJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Account-Application","Account","New-Style"],"summary":"Create Account Application","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create Account Application
Authentication is Mandatory
","operationId":"OBPv3.1.0-createAccountApplication","parameters":[{"in":"body","name":"body","description":"AccountApplicationJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AccountApplicationJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/AccountApplicationResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/account-applications/{ACCOUNT_APPLICATION_ID}":{"get":{"tags":["Account-Application","Account","New-Style"],"summary":"Get Account Application by Id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the Account Application.
Authentication is Mandatory
","operationId":"OBPv3.1.0-getAccountApplication","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"ACCOUNT_APPLICATION_ID","description":"the account application id ","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AccountApplicationResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["Account-Application","Account","New-Style"],"summary":"Update Account Application Status","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update an Account Application status
Authentication is Mandatory
","operationId":"OBPv3.1.0-updateAccountApplicationStatus","parameters":[{"in":"body","name":"body","description":"AccountApplicationUpdateStatusJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AccountApplicationUpdateStatusJson"}},{"in":"path","name":"ACCOUNT_APPLICATION_ID","description":"the account application id ","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AccountApplicationResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts":{"get":{"tags":["Account","PrivateData","PublicData","New-Style"],"summary":"Get Accounts at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns the list of accounts at BANK_ID that the user has access to.
For each account the API returns the account ID and the views available to the user..
Each account must have at least one private View.
optional request parameters for filter with attributes
URL params example: /banks/some-bank-id/accounts?manager=John&count=8
Authentication is Mandatory
","operationId":"OBPv4.0.0-getPrivateAccountsAtOneBank","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BasicAccountsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Account","Onboarding","New-Style"],"summary":"Create Account (POST)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create Account at bank specified by BANK_ID.
The User can create an Account for himself - or - the User that has the USER_ID specified in the POST body.
If the POST body USER_ID is specified, the logged in user must have the Role CanCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.
If the POST body USER_ID is not specified, the account will be owned by the logged in User.
The 'product_code' field SHOULD be a product_code from Product.
If the product_code matches a product_code from Product, account attributes will be created that match the Product Attributes.
Note: The Amount MUST be zero.
Authentication is Mandatory
","operationId":"OBPv4.0.0-addAccount","parameters":[{"in":"body","name":"body","description":"CreateAccountRequestJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateAccountRequestJsonV310"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/CreateAccountResponseJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts-held":{"get":{"tags":["Account","Account Information Service (AIS)","View-(Custom)","PSD2","New-Style"],"summary":"Get Accounts Held","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Accounts held by the current User if even the User has not been assigned the owner View yet.
Can be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.
optional request parameters:
whole url example:
/banks/BANK_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
","operationId":"OBPv3.0.0-getAccountsHeld","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CoreAccountsHeldJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}":{"post":{"tags":["Account","New-Style"],"summary":"Update Account Label","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update the label for the account. The label is how the account is known to the account owner e.g. 'My savings account'
Authentication is Mandatory
","operationId":"OBPv4.0.0-updateAccountLabel","parameters":[{"in":"body","name":"body","description":"UpdateAccountJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/UpdateAccountJsonV400"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/account":{"get":{"tags":["Account","New-Style"],"summary":"Get Account by Id (Full)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Information returned about an account specified by ACCOUNT_ID as moderated by the view (VIEW_ID):
More details about the data moderation by the view here.
PSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
This call provides balance and other account information via delegated authentication using OAuth.
Authentication is required if the 'is_public' field in view (VIEW_ID) is not set to true
.
Authentication is Mandatory
","operationId":"OBPv4.0.0-getPrivateAccountByIdFull","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ModeratedAccountJSON400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/checkbook/orders":{"get":{"tags":["Account","New-Style"],"summary":"Get Checkbook orders","security":[{"directLogin":[],"gatewayLogin":[]}],"description":" Get all checkbook orders
Authentication is Mandatory
","operationId":"OBPv3.1.0-getCheckbookOrders","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CheckbookOrdersJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/counterparties":{"get":{"tags":["Counterparty","Payment Initiation Service (PIS)","PSD2","Account","New-Style"],"summary":"Get Counterparties (Explicit)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the Counterparties (Explicit) for the account / view.
Authentication is Mandatory
","operationId":"OBPv4.0.0-getExplictCounterpartiesForAccount","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CounterpartiesJson400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Counterparty","Account","New-Style"],"summary":"Create Counterparty (Explicit)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create Counterparty (Explicit) for an Account.
In OBP, there are two types of Counterparty.
Explicit Counterparties (those here) which we create explicitly and are used in COUNTERPARTY Transaction Requests
Implicit Counterparties (AKA Other Accounts) which are generated automatically from the other sides of Transactions.
Explicit Counterparties are created for the account / view
They are how the user of the view (e.g. account owner) refers to the other side of the transaction
name : the human readable name (e.g. Piano teacher, Miss Nipa)
description : the human readable name (e.g. Piano teacher, Miss Nipa)
currency : counterparty account currency (e.g. EUR, GBP, USD, ...)
bank_routing_scheme : eg: bankId or bankCode or any other strings
bank_routing_address : eg: gh.29.uk
, must be valid sandbox bankIds
account_routing_scheme : eg: AccountId or AccountNumber or any other strings
account_routing_address : eg: 1d65db7c-a7b2-4839-af41-95
, must be valid accountIds
other_account_secondary_routing_scheme : eg: IBan or any other strings
other_account_secondary_routing_address : if it is an IBAN, it should be unique for each counterparty.
other_branch_routing_scheme : eg: branchId or any other strings or you can leave it empty, not useful in sandbox mode.
other_branch_routing_address : eg: branch-id-123
or you can leave it empty, not useful in sandbox mode.
is_beneficiary : must be set to true
in order to send payments to this counterparty
bespoke: It supports a list of key-value, you can add it to the counterparty.
bespoke.key : any info-key you want to add to this counterparty
bespoke.value : any info-value you want to add to this counterparty
The view specified by VIEW_ID must have the canAddCounterparty permission
A minimal example for TransactionRequestType == COUNTERPARTY
{
"name": "Tesobe1",
"description": "Good Company",
"currency": "EUR",
"other_bank_routing_scheme": "OBP",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "OBP",
"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"is_beneficiary": true,
"other_account_secondary_routing_scheme": "",
"other_account_secondary_routing_address": "",
"other_branch_routing_scheme": "",
"other_branch_routing_address": "",
"bespoke": []
}
A minimal example for TransactionRequestType == SEPA
{
"name": "Tesobe2",
"description": "Good Company",
"currency": "EUR",
"other_bank_routing_scheme": "OBP",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "OBP",
"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"other_account_secondary_routing_scheme": "IBAN",
"other_account_secondary_routing_address": "DE89 3704 0044 0532 0130 00",
"is_beneficiary": true,
"other_branch_routing_scheme": "",
"other_branch_routing_address": "",
"bespoke": []
}
Authentication is Mandatory
","operationId":"OBPv4.0.0-createCounterparty","parameters":[{"in":"body","name":"body","description":"PostCounterpartyJson400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostCounterpartyJson400"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/CounterpartyWithMetadataJson400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/credit_cards/orders":{"get":{"tags":["Card","New-Style"],"summary":"Get status of Credit Card order ","security":[{"directLogin":[],"gatewayLogin":[]}],"description":" Get status of Credit Card orders
Get all orders
Authentication is Mandatory
","operationId":"OBPv3.1.0-getStatusOfCreditCardOrder","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CreditCardOrderStatusResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/direct-debit":{"post":{"tags":["Direct-Debit","Account","New-Style"],"summary":"Create Direct Debit","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create direct debit for an account.
Authentication is Mandatory
","operationId":"OBPv4.0.0-createDirectDebit","parameters":[{"in":"body","name":"body","description":"PostDirectDebitJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostDirectDebitJsonV400"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/DirectDebitJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/funds-available":{"get":{"tags":["Account","Confirmation of Funds Service (PIIS)","PSD2","New-Style"],"summary":"Check Available Funds","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Check Available Funds
Mandatory URL parameters:
Authentication is Mandatory
","operationId":"OBPv3.1.0-checkFundsAvailable","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CheckFundsAvailableJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/metadata/tags":{"get":{"tags":["Account-Metadata","Account","New-Style"],"summary":"Get tags on account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns the account ACCOUNT_ID tags made on a view (VIEW_ID).
Authentication is Mandatory
Authentication is required as the tag is linked with the user.
","operationId":"OBPv4.0.0-getTagsForViewOnAccount","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AccountTagsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Account-Metadata","Account","New-Style"],"summary":"Create a tag on account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Posts a tag about an account ACCOUNT_ID on a view VIEW_ID.
Authentication is Mandatory
Authentication is required as the tag is linked with the user.
","operationId":"OBPv4.0.0-addTagForViewOnAccount","parameters":[{"in":"body","name":"body","description":"PostAccountTagJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostAccountTagJSON"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/AccountTagJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/metadata/tags/{TAG_ID}":{"delete":{"tags":["Account-Metadata","Account","New-Style"],"summary":"Delete a tag on account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Deletes the tag TAG_ID about the account ACCOUNT_ID made on view.
Authentication is Mandatory
Authentication is required as the tag is linked with the user.
","operationId":"OBPv4.0.0-deleteTagForViewOnAccount","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"TAG_ID","description":"The tag id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorNoViewPermission"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts":{"get":{"tags":["Counterparty","Account","New-Style"],"summary":"Get Other Accounts of one Account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID.
Authentication is Optional
Authentication is required if the view VIEW_ID is not public.
","operationId":"OBPv3.0.0-getOtherAccountsForBankAccount","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OtherAccountsJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}":{"get":{"tags":["Counterparty","Account","New-Style"],"summary":"Get Other Account by Id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID.
Authentication is Optional
Authentication is required if the view is not public.
","operationId":"OBPv3.0.0-getOtherAccountByIdForBankAccount","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OtherAccountJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/standing-order":{"post":{"tags":["Standing-Order","Account","New-Style"],"summary":"Create Standing Order","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create standing order for an account.
when -> frequency = {‘YEARLY’,’MONTHLY, ‘WEEKLY’, ‘BI-WEEKLY’, DAILY’}
when -> detail = { ‘FIRST_MONDAY’, ‘FIRST_DAY’, ‘LAST_DAY’}}
Authentication is Mandatory
","operationId":"OBPv4.0.0-createStandingOrder","parameters":[{"in":"body","name":"body","description":"PostStandingOrderJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostStandingOrderJsonV400"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/StandingOrderJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions":{"get":{"tags":["Transaction","Account","New-Style"],"summary":"Get Transactions for Account (Full)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns transactions list of the account specified by ACCOUNT_ID and moderated by the view (VIEW_ID).
Authentication is Optional
Authentication is required if the view is not public.
Possible custom url parameters for pagination:
eg1:?limit=100&offset=0
eg2:?limit=100&offset=0&sort_direction=ASC
Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.
eg3:?sort_direction=ASC&limit=100&offset=0&from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z
","operationId":"OBPv3.0.0-getTransactionsForBankAccount","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionsJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorFilterSortDirectionError"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/account-access":{"put":{"tags":["Account-Access","View-(Custom)","Account","User","OwnerViewRequired"],"summary":"Revoke/Grant User access to View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Revoke/Grant the logged in User access to the views identified by json.
Authentication is Mandatory and the user needs to be an account holder or has owner view access.
","operationId":"OBPv4.0.0-revokeGrantUserAccessToViews","parameters":[{"in":"body","name":"body","description":"PostRevokeGrantAccountAccessJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostRevokeGrantAccountAccessJsonV400"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/RevokedJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/account-access/grant":{"post":{"tags":["Account-Access","View-(Custom)","Account","User","OwnerViewRequired","New-Style"],"summary":"Grant User access to View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Grants the User identified by USER_ID access to the view identified by VIEW_ID.
Authentication is Mandatory and the user needs to be account holder.
","operationId":"OBPv4.0.0-grantUserAccessToView","parameters":[{"in":"body","name":"body","description":"PostAccountAccessJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostAccountAccessJsonV400"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/ViewJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/account-access/revoke":{"post":{"tags":["Account-Access","View-(Custom)","Account","User","OwnerViewRequired","New-Style"],"summary":"Revoke User access to View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Revoke the User identified by USER_ID access to the view identified by VIEW_ID.
Authentication is Mandatory and the user needs to be account holder.
","operationId":"OBPv4.0.0-revokeUserAccessToView","parameters":[{"in":"body","name":"body","description":"PostAccountAccessJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostAccountAccessJsonV400"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/RevokedJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/permissions":{"get":{"tags":["View-(Custom)","Account","User","Entitlement","New-Style"],"summary":"Get access","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns the list of the permissions at BANK_ID for account ACCOUNT_ID, with each time a pair composed of the user and the views that he has access to.
Authentication is Mandatory
and the user needs to have access to the owner view.
Returns the list of the views at BANK_ID for account ACCOUNT_ID that a user identified by PROVIDER_ID at their provider PROVIDER has access to.
All url parameters must be %-encoded, which is often especially relevant for USER_ID and PROVIDER.
Authentication is Mandatory
The user needs to have access to the owner view.
","operationId":"OBPv3.0.0-getPermissionForUserForBankAccount","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"PROVIDER","description":"the user PROVIDER","required":true,"type":"string"},{"in":"path","name":"PROVIDER_ID","description":"The provider id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ViewsJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/products/{PRODUCT_CODE}/attribute":{"post":{"tags":["Account","New-Style"],"summary":"Create Account Attribute","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create Account Attribute
Account Attributes are used to describe a financial Product with a list of typed key value pairs.
Each Account Attribute is linked to its Account by ACCOUNT_ID
Typical account attributes might be:
ISIN (for International bonds)
VKN (for German bonds)
REDCODE (markit short code for credit derivative)
LOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
MATURITY_DATE (End of life time of a product)
TRADABLE
See FPML for more examples.
The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
Authentication is Mandatory
","operationId":"OBPv3.1.0-createAccountAttribute","parameters":[{"in":"body","name":"body","description":"AccountAttributeJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AccountAttributeJson"}},{"in":"path","name":"PRODUCT_CODE","description":"the product code","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/AccountAttributeResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/products/{PRODUCT_CODE}/attributes/{ACCOUNT_ATTRIBUTE_ID}":{"put":{"tags":["Account","New-Style"],"summary":"Update Account Attribute","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Account Attribute
Account Attributes are used to describe a financial Product with a list of typed key value pairs.
Each Account Attribute is linked to its Account by ACCOUNT_ID
Typical account attributes might be:
ISIN (for International bonds)
VKN (for German bonds)
REDCODE (markit short code for credit derivative)
LOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
MATURITY_DATE (End of life time of a product)
TRADABLE
See FPML for more examples.
Authentication is Mandatory
","operationId":"OBPv3.1.0-updateAccountAttribute","parameters":[{"in":"body","name":"body","description":"AccountAttributeJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AccountAttributeJson"}},{"in":"path","name":"ACCOUNT_ATTRIBUTE_ID","description":"the account attribute id ","required":true,"type":"string"},{"in":"path","name":"PRODUCT_CODE","description":"the product code","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AccountAttributeResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/views":{"get":{"tags":["View-(Custom)","Account","New-Style"],"summary":"Get Views for Account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Views in Open Bank Project provide a mechanism for fine grained access control and delegation to Accounts and Transactions. Account holders use the 'owner' view by default. Delegated access is made through other views for example 'accountants', 'share-holders' or 'tagging-application'. Views can be created via the API and each view has a list of entitlements.
Views on accounts and transactions filter the underlying data to redact certain fields for certain users. For instance the balance on an account may be hidden from the public. The way to know what is possible on a view is determined in the following JSON.
Data: When a view moderates a set of data, some fields my contain the value null
rather than the original value. This indicates either that the user is not allowed to see the original data or the field is empty.
There is currently one exception to this rule; the 'holder' field in the JSON contains always a value which is either an alias or the real name - indicated by the 'is_alias' field.
Action: When a user performs an action like trying to post a comment (with POST API call), if he is not allowed, the body response will contain an error message.
Metadata:
Transaction metadata (like images, tags, comments, etc.) will appears ONLY on the view where they have been created e.g. comments posted to the public view only appear on the public view.
The other account metadata fields (like image_URL, more_info, etc.) are unique through all the views. Example, if a user edits the 'more_info' field in the 'team' view, then the view 'authorities' will show the new value (if it is allowed to do it).
Optional
Returns the list of the views created for account ACCOUNT_ID at BANK_ID.
Authentication is Mandatory and the user needs to have access to the owner view.
","operationId":"OBPv3.0.0-getViewsForBankAccount","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ViewsJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["View-(Custom)","Account","New-Style"],"summary":"Create View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create a view on bank account
Authentication is Mandatory and the user needs to have access to the owner view.
The 'alias' field in the JSON can take one of three values:
''(empty string): to use no alias; the view shows the real name of the other account.
The 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to true
and there is an alias on the other account then the other accounts' metadata (like more_info, url, image_url, open_corporates_url, etc.) will be hidden. Otherwise the metadata will be shown.
The 'allowed_actions' field is a list containing the name of the actions allowed on this view, all the actions contained will be set to true
on the view creation, the rest will be set to false
.
You MUST use a leading _ (underscore) in the view name because other view names are reserved for OBP system views.
","operationId":"OBPv3.0.0-createViewForBankAccount","parameters":[{"in":"body","name":"body","description":"CreateViewJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateViewJson"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/ViewJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/views/{VIEW_ID}":{"delete":{"tags":["View-(Custom)","Account","New-Style"],"summary":"Delete View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Deletes the view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID
Authentication is Mandatory
","operationId":"OBPv1.2.1-deleteViewForBankAccount","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["View-(Custom)","Account","New-Style"],"summary":"Update View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update an existing view on a bank account
Authentication is Mandatory and the user needs to have access to the owner view.
The json sent is the same as during view creation (above), with one difference: the 'name' field
of a view is not editable (it is only set when a view is created)
Returns only the list of accounts ids at BANK_ID that the user has access to.
Each account must have at least one private View.
For each account the API returns its account ID.
If you want to see more information on the Views, use the Account Detail call.
optional request parameters:
whole url example:
/banks/BANK_ID/accounts/account_ids/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
","operationId":"OBPv3.0.0-getPrivateAccountIdsbyBankId","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AccountsIdsJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/private":{"get":{"tags":["Account","Account Information Service (AIS)","New-Style","PSD2"],"summary":"Get Accounts at Bank (Minimal)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns the minimal list of private accounts at BANK_ID that the user has access to.
For each account, the API returns the ID, routing addresses and the views available to the current user.
If you want to see more information on the Views, use the Account Detail call.
optional request parameters:
whole url example:
/banks/BANK_ID/accounts/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
","operationId":"OBPv3.0.0-privateAccountsAtOneBank","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CoreAccountsJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/public":{"get":{"tags":["Account-Public","Account","PublicData","New-Style"],"summary":"Get Public Accounts at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.
Authentication is Optional
","operationId":"OBPv2.0.0-publicAccountsAtOneBank","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BasicAccountsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/attribute-definitions/ATTRIBUTE_DEFINITION_ID/account":{"delete":{"tags":["Account","New-Style"],"summary":"Delete Account Attribute Definition","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Account Attribute Definition by ATTRIBUTE_DEFINITION_ID
Authentication is Mandatory
","operationId":"OBPv4.0.0-deleteAccountAttributeDefinition","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/attribute-definitions/ATTRIBUTE_DEFINITION_ID/card":{"delete":{"tags":["Card","New-Style"],"summary":"Delete Card Attribute Definition","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Card Attribute Definition by ATTRIBUTE_DEFINITION_ID
Authentication is Mandatory
","operationId":"OBPv4.0.0-deleteCardAttributeDefinition","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/attribute-definitions/account":{"get":{"tags":["Account","New-Style"],"summary":"Get Account Attribute Definition","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Account Attribute Definition
Authentication is Mandatory
","operationId":"OBPv4.0.0-getAccountAttributeDefinition","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AttributeDefinitionsResponseJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["Account","New-Style"],"summary":"Create or Update Account Attribute Definition","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create or Update Account Attribute Definition
The category field must be Account
The type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
Authentication is Mandatory
","operationId":"OBPv4.0.0-createOrUpdateAccountAttributeDefinition","parameters":[{"in":"body","name":"body","description":"AttributeDefinitionJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AttributeDefinitionJsonV400"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AttributeDefinitionResponseJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/attribute-definitions/card":{"get":{"tags":["Card","New-Style"],"summary":"Get Card Attribute Definition","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Card Attribute Definition
Authentication is Mandatory
","operationId":"OBPv4.0.0-getCardAttributeDefinition","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AttributeDefinitionsResponseJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["Card","New-Style"],"summary":"Create or Update Card Attribute Definition","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create or Update Card Attribute Definition
The category field must be Card
The type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
Authentication is Mandatory
","operationId":"OBPv4.0.0-createOrUpdateCardAttributeDefinition","parameters":[{"in":"body","name":"body","description":"AttributeDefinitionJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AttributeDefinitionJsonV400"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AttributeDefinitionResponseJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/balances":{"get":{"tags":["Account","Account Information Service (AIS)","PSD2","New-Style"],"summary":"Get Accounts Balances","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the Balances for the Accounts of the current User at one bank.
Authentication is Mandatory
","operationId":"OBPv4.0.0-getBankAccountsBalances","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AccountsBalancesJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/firehose/accounts/views/{VIEW_ID}":{"get":{"tags":["Account","Account-Firehose","FirehoseData","New-Style"],"summary":"Get Firehose Accounts at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Accounts which have a firehose view assigned to them.
This endpoint allows bulk access to accounts.
Requires the CanUseFirehoseAtAnyBank Role
To be shown on the list, each Account must have a firehose View linked to it.
A firehose view has is_firehose = true
For VIEW_ID try 'owner'
optional request parameters for filter with attributes
URL params example:
/banks/some-bank-id/firehose/accounts/views/owner?manager=John&count=8
to invalid Browser cache, add timestamp query parameter as follow, the parameter name must be _timestamp_
URL params example:/banks/some-bank-id/firehose/accounts/views/owner?manager=John&count=8&_timestamp_=1596762180358
Authentication is Mandatory
","operationId":"OBPv4.0.0-getFirehoseAccountsAtOneBank","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ModeratedFirehoseAccountsJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/public/accounts/{ACCOUNT_ID}/{VIEW_ID}/account":{"get":{"tags":["Account-Public","Account","New-Style"],"summary":"Get Public Account by Id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns information about an account that has a public view.
The account is specified by ACCOUNT_ID. The information is moderated by the view specified by VIEW_ID.
PSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
This call provides balance and other account information via delegated authentication using OAuth.
Authentication is Optional
","operationId":"OBPv3.0.0-getPublicAccountById","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ModeratedCoreAccountJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}},"/obp/v4.0.0/cards":{"get":{"tags":["Card","User"],"summary":"Get cards for the current user","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns data about all the physical cards a user has been issued. These could be debit cards, credit cards, etc.
Authentication is Mandatory
","operationId":"OBPv1.3.0-getCards","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/PhysicalCardsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/accounts/account-routing-query":{"post":{"tags":["Account","New-Style"],"summary":"Get Account by Account Routing","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"This endpoint returns the account (if it exists) linked with the provided scheme and address.
The bank_id
field is optional, but if it's not provided, we don't guarantee that the returned account is unique across all the banks.
Example of account routing scheme: IBAN
, "OBP", "AccountNumber", ...
Example of account routing address: DE17500105178275645584
, "321774cc-fccd-11ea-adc1-0242ac120002", "55897106215", ...
Authentication is Mandatory
","operationId":"OBPv4.0.0-getAccountByAccountRouting","parameters":[{"in":"body","name":"body","description":"BankAccountRoutingJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/BankAccountRoutingJson"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/ModeratedAccountJSON400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/banks/{BANK_ID}/accounts/{ACCOUNT_ID}":{"put":{"tags":["Account","New-Style"],"summary":"Update Account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update the account.
Authentication is Mandatory
","operationId":"OBPv3.1.0-updateAccount","parameters":[{"in":"body","name":"body","description":"UpdateAccountRequestJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/UpdateAccountRequestJsonV310"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/UpdateAccountResponseJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v4.0.0/management/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/counterparties":{"post":{"tags":["Counterparty","Account","New-Style"],"summary":"Create Counterparty for any account (Explicit)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create Counterparty for any Account. (Explicit)
In OBP, there are two types of Counterparty.
Explicit Counterparties (those here) which we create explicitly and are used in COUNTERPARTY Transaction Requests
Implicit Counterparties (AKA Other Accounts) which are generated automatically from the other sides of Transactions.
Explicit Counterparties are created for the account / view
They are how the user of the view (e.g. account owner) refers to the other side of the transaction
name : the human readable name (e.g. Piano teacher, Miss Nipa)
description : the human readable name (e.g. Piano teacher, Miss Nipa)
currency : counterparty account currency (e.g. EUR, GBP, USD, ...)
bank_routing_scheme : eg: bankId or bankCode or any other strings
bank_routing_address : eg: gh.29.uk
, must be valid sandbox bankIds
account_routing_scheme : eg: AccountId or AccountNumber or any other strings
account_routing_address : eg: 1d65db7c-a7b2-4839-af41-95
, must be valid accountIds
other_account_secondary_routing_scheme : eg: IBan or any other strings
other_account_secondary_routing_address : if it is an IBAN, it should be unique for each counterparty.
other_branch_routing_scheme : eg: branchId or any other strings or you can leave it empty, not useful in sandbox mode.
other_branch_routing_address : eg: branch-id-123
or you can leave it empty, not useful in sandbox mode.
is_beneficiary : must be set to true
in order to send payments to this counterparty
bespoke: It supports a list of key-value, you can add it to the counterparty.
bespoke.key : any info-key you want to add to this counterparty
bespoke.value : any info-value you want to add to this counterparty
The view specified by VIEW_ID must have the canAddCounterparty permission
A minimal example for TransactionRequestType == COUNTERPARTY
{
"name": "Tesobe1",
"description": "Good Company",
"currency": "EUR",
"other_bank_routing_scheme": "OBP",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "OBP",
"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"is_beneficiary": true,
"other_account_secondary_routing_scheme": "",
"other_account_secondary_routing_address": "",
"other_branch_routing_scheme": "",
"other_branch_routing_address": "",
"bespoke": []
}
A minimal example for TransactionRequestType == SEPA
{
"name": "Tesobe2",
"description": "Good Company",
"currency": "EUR",
"other_bank_routing_scheme": "OBP",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "OBP",
"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"other_account_secondary_routing_scheme": "IBAN",
"other_account_secondary_routing_address": "DE89 3704 0044 0532 0130 00",
"is_beneficiary": true,
"other_branch_routing_scheme": "",
"other_branch_routing_address": "",
"bespoke": []
}
Authentication is Mandatory
","operationId":"OBPv4.0.0-createCounterpartyForAnyAccount","parameters":[{"in":"body","name":"body","description":"PostCounterpartyJson400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostCounterpartyJson400"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/CounterpartyWithMetadataJson400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/counterparties/COUNTERPARTY_NAME":{"get":{"tags":["Counterparty","Account","New-Style"],"summary":"Get Counterparty by name for any account (Explicit) ","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Authentication is Mandatory
","operationId":"OBPv4.0.0-getCounterpartyByNameForAnyAccount","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CounterpartyWithMetadataJson400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/direct-debit":{"post":{"tags":["Direct-Debit","Account","New-Style"],"summary":"Create Direct Debit (management)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create direct debit for an account.
Authentication is Mandatory
","operationId":"OBPv4.0.0-createDirectDebitManagement","parameters":[{"in":"body","name":"body","description":"PostDirectDebitJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostDirectDebitJsonV400"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/DirectDebitJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/standing-order":{"post":{"tags":["Standing-Order","Account","New-Style"],"summary":"Create Standing Order (management)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create standing order for an account.
when -> frequency = {‘YEARLY’,’MONTHLY, ‘WEEKLY’, ‘BI-WEEKLY’, DAILY’}
when -> detail = { ‘FIRST_MONDAY’, ‘FIRST_DAY’, ‘LAST_DAY’}}
Authentication is Mandatory
","operationId":"OBPv4.0.0-createStandingOrderManagement","parameters":[{"in":"body","name":"body","description":"PostStandingOrderJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostStandingOrderJsonV400"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/StandingOrderJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/banks/{BANK_ID}/cards":{"get":{"tags":["Card","New-Style"],"summary":"Get Cards for the specified bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Should be able to filter on the following fields
eg:/management/banks/BANK_ID/cards?customer_id=66214b8e-259e-44ad-8868-3eb47be70646&account_id=8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0
1 customer_id should be valid customer_id, otherwise, it will return an empty card list.
2 account_id should be valid account_id , otherwise, it will return an empty card list.
Authentication is Mandatory
","operationId":"OBPv3.1.0-getCardsForBank","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/PhysicalCardsJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Card","New-Style"],"summary":"Create Card","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create Card at bank specified by BANK_ID .
Authentication is Mandatory
","operationId":"OBPv3.1.0-addCardForBank","parameters":[{"in":"body","name":"body","description":"CreatePhysicalCardJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreatePhysicalCardJsonV310"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/PhysicalCardJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/banks/{BANK_ID}/cards/{CARD_ID}":{"delete":{"tags":["Card","New-Style"],"summary":"Delete Card","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete a Card at bank specified by CARD_ID .
Authentication is Mandatory
","operationId":"OBPv3.1.0-deleteCardForBank","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"CARD_ID","description":"the card id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["Card","New-Style"],"summary":"Get Card By Id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"This will the datails of the card.
It shows the account infomation which linked the the card.
Also shows the card attributes of the card.
Authentication is Mandatory
","operationId":"OBPv3.1.0-getCardForBank","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"CARD_ID","description":"the card id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/PhysicalCardWithAttributesJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["Card","New-Style"],"summary":"Update Card","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Card at bank specified by CARD_ID .
Authentication is Mandatory
Create Card Attribute
Card Attributes are used to describe a financial Product with a list of typed key value pairs.
Each Card Attribute is linked to its Card by CARD_ID
The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
Authentication is Mandatory
","operationId":"OBPv3.1.0-createCardAttribute","parameters":[{"in":"body","name":"body","description":"CardAttributeJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CardAttributeJson"}},{"in":"path","name":"CARD_ID","description":"the card id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/CardAttributeCommons"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/banks/{BANK_ID}/cards/{CARD_ID}/attributes/{CARD_ATTRIBUTE_ID}":{"put":{"tags":["Card","New-Style"],"summary":"Update Card Attribute","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Card Attribute
Card Attributes are used to describe a financial Product with a list of typed key value pairs.
Each Card Attribute is linked to its Card by CARD_ID
Authentication is Mandatory
","operationId":"OBPv3.1.0-updateCardAttribute","parameters":[{"in":"body","name":"body","description":"CardAttributeJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CardAttributeJson"}},{"in":"path","name":"CARD_ATTRIBUTE_ID","description":"the card attribute id","required":true,"type":"string"},{"in":"path","name":"CARD_ID","description":"the card id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CardAttributeCommons"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/cascading/banks/{BANK_ID}/accounts/{ACCOUNT_ID}":{"delete":{"tags":["Account","API","New-Style"],"summary":"Delete Account Cascade","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete an Account Cascade specified by ACCOUNT_ID.
Authentication is Mandatory
","operationId":"OBPv4.0.0-deleteAccountCascade","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/my/accounts":{"get":{"tags":["Account","Account Information Service (AIS)","PrivateData","PSD2","New-Style"],"summary":"Get Accounts at all Banks (private)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns the list of accounts containing private views for the user.
Each account lists the views available to the user.
optional request parameters:
whole url example:
/my/accounts?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
","operationId":"OBPv3.0.0-corePrivateAccountsAllBanks","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CoreAccountsJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/my/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/account":{"get":{"tags":["Account","Account Information Service (AIS)","PSD2","New-Style"],"summary":"Get Account by Id (Core)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Information returned about the account specified by ACCOUNT_ID:
This call returns the owner view and requires access to that view.
Authentication is Mandatory
","operationId":"OBPv4.0.0-getCoreAccountById","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ModeratedCoreAccountJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/my/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/transactions":{"get":{"tags":["Transaction","Account Information Service (AIS)","Account","PSD2","New-Style"],"summary":"Get Transactions for Account (Core)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns transactions list (Core info) of the account specified by ACCOUNT_ID.
Authentication is Mandatory
Possible custom url parameters for pagination:
eg1:?limit=100&offset=0
eg2:?limit=100&offset=0&sort_direction=ASC
Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.
eg3:?sort_direction=ASC&limit=100&offset=0&from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z
","operationId":"OBPv3.0.0-getCoreTransactionsForBankAccount","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CoreTransactionsJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorFilterSortDirectionError"}}}}}},"definitions":{"ErrorInvalidJsonFormat":{"properties":{"message":{"type":"string","example":"OBP-10001: Incorrect json format."}}},"ErrorFilterSortDirectionError":{"properties":{"message":{"type":"string","example":"OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC!"}}},"ErrorUserNotLoggedIn":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"ErrorBankNotFound":{"properties":{"message":{"type":"string","example":"OBP-30001: Bank not found. Please specify a valid value for BANK_ID."}}},"ErrorBankAccountNotFound":{"properties":{"message":{"type":"string","example":"OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. "}}},"ErrorNoViewPermission":{"properties":{"message":{"type":"string","example":"OBP-30022: The current view does not have the permission: "}}},"ErrorCannotGetAccounts":{"properties":{"message":{"type":"string","example":"OBP-30066: Could not get accounts."}}},"ErrorUnknownError":{"properties":{"message":{"type":"string","example":"OBP-50000: Unknown Error."}}},"AttributeDefinitionResponseJsonV400":{"required":["name","is_active","description","attribute_definition_id","alias","bank_id","can_be_seen_on_views","category","type"],"properties":{"name":{"type":"string","example":"SPECIAL_TAX_NUMBER"},"is_active":{"type":"boolean","example":"true"},"description":{"type":"string","example":"description"},"attribute_definition_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"alias":{"type":"string","example":"STRING"},"bank_id":{"type":"string","example":"gh.29.uk"},"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"category":{"type":"string","example":"Card"},"type":{"type":"string","example":"STRING"}}},"PostRevokeGrantAccountAccessJsonV400":{"required":["views"],"properties":{"views":{"type":"array","items":{"type":"string"}}}},"PhysicalCardsJsonV310":{"required":["cards"],"properties":{"cards":{"type":"array","items":{"$ref":"#/definitions/PhysicalCardJsonV310"}}}},"AmountOfMoneyJsonV121":{"required":["currency","amount"],"properties":{"currency":{"type":"string","example":"EUR"},"amount":{"type":"string","example":"0"}}},"CounterpartyMetadataJson":{"required":["public_alias","physical_location","image_url","private_alias","url","more_info","corporate_location","open_corporates_url"],"properties":{"public_alias":{"type":"string","example":"String"},"physical_location":{"$ref":"#/definitions/LocationJsonV210"},"image_url":{"type":"string","example":"String"},"private_alias":{"type":"string","example":"String"},"url":{"type":"string","example":"String"},"more_info":{"type":"string","example":"String"},"corporate_location":{"$ref":"#/definitions/LocationJsonV210"},"open_corporates_url":{"type":"string","example":"String"}}},"AccountApplicationJson":{"required":["product_code"],"properties":{"product_code":{"type":"string","example":"saveing1"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"}}},"UpdateViewJSON":{"required":["description","is_public","hide_metadata_if_alias_used","which_alias_to_use","metadata_view","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"},"is_firehose":{"type":"boolean","example":""},"metadata_view":{"type":"string","example":"owner"},"allowed_actions":{"type":"array","items":{"type":"string"}}}},"AttributeDefinitionJsonV400":{"required":["name","is_active","description","alias","can_be_seen_on_views","category","type"],"properties":{"name":{"type":"string","example":"SPECIAL_TAX_NUMBER"},"is_active":{"type":"boolean","example":"true"},"description":{"type":"string","example":"description"},"alias":{"type":"string","example":"STRING"},"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"category":{"type":"string","example":"TransactionRequest"},"type":{"type":"string","example":"STRING"}}},"ResourceUserJSON":{"required":["provider","email","username","provider_id","user_id"],"properties":{"provider":{"type":"string","example":"http://127.0.0.1:8080"},"email":{"type":"string","example":"felixsmith@example.com"},"username":{"type":"string","example":"felixsmith"},"provider_id":{"type":"string","example":"Chris"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}},"OtherAccountJsonV300":{"required":["account_routings","holder","id","metadata","bank_routing"],"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"}}},"AttributeDefinitionsResponseJsonV400":{"required":["attributes"],"properties":{"attributes":{"type":"array","items":{"$ref":"#/definitions/AttributeDefinitionResponseJsonV400"}}}},"TransactionMetadataJSON":{"required":["narrative","tags","where","images","comments"],"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"}}}},"PinResetJSON":{"required":["requested_date","reason_requested"],"properties":{"requested_date":{"type":"string","format":"date","example":"2024-03-25T16:24:19Z"},"reason_requested":{"type":"string","example":"GOOD_SECURITY_PRACTICE"}}},"OrderObjectJson":{"required":["order_id","number_of_checkbooks","first_check_number","order_date","status","shipping_code","distribution_channel"],"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"}}},"AccountTagsJSON":{"required":["tags"],"properties":{"tags":{"type":"array","items":{"$ref":"#/definitions/AccountTagJSON"}}}},"AccountApplicationsJsonV310":{"required":["account_applications"],"properties":{"account_applications":{"type":"array","items":{"$ref":"#/definitions/AccountApplicationResponseJson"}}}},"CustomerCreditRatingJSON":{"required":["rating","source"],"properties":{"rating":{"type":"string","example":"OBP"},"source":{"type":"string","example":"OBP"}}},"ThisAccountJsonV300":{"required":["id","bank_routing","account_routings","holders"],"properties":{"id":{"type":"string","example":"String"},"bank_routing":{"$ref":"#/definitions/BankRoutingJsonV121"},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"holders":{"type":"array","items":{"$ref":"#/definitions/AccountHolderJSON"}}}},"BasicAccountJSON":{"required":["id","label","bank_id","views_available"],"properties":{"id":{"type":"string","example":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"},"label":{"type":"string","example":"NoneLabel"},"bank_id":{"type":"string","example":"gh.29.uk"},"views_available":{"type":"array","items":{"$ref":"#/definitions/BasicViewJson"}}}},"OrderJson":{"required":["order"],"properties":{"order":{"$ref":"#/definitions/OrderObjectJson"}}},"CoreAccountJson":{"required":["account_routings","label","account_type","bank_id","id","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/ViewBasicV300"}}}},"SuccessMessage":{"required":["success"],"properties":{"success":{"type":"string","example":"Success"}}},"IbanCheckerJsonV400":{"required":["is_valid"],"properties":{"is_valid":{"type":"boolean","example":"true"},"details":{"$ref":"#/definitions/IbanDetailsJsonV400"}}},"UpdateAccountRequestJsonV310":{"required":["label","type","branch_id","account_routings"],"properties":{"label":{"type":"string","example":"Label"},"type":{"type":"string","example":"CURRENT"},"branch_id":{"type":"string","example":"1234"},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}}}},"RevokedJsonV400":{"required":["revoked"],"properties":{"revoked":{"type":"boolean","example":"true"}}},"CoreCounterpartyJsonV300":{"required":["id","holder","bank_routing","account_routings"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"holder":{"$ref":"#/definitions/AccountHolderJSON"},"bank_routing":{"$ref":"#/definitions/BankRoutingJsonV121"},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}}}},"PhysicalCardWithAttributesJsonV310":{"required":["allows","expires_date","networks","customer_id","issue_number","replacement","enabled","collected","card_number","technology","cancelled","bank_id","card_id","pin_reset","serial_number","account","valid_from_date","card_attributes","name_on_card","posted","card_type","on_hot_list"],"properties":{"allows":{"type":"array","items":{"type":"string"}},"expires_date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"networks":{"type":"array","items":{"type":"string"}},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"issue_number":{"type":"string","example":"1"},"replacement":{"$ref":"#/definitions/ReplacementJSON"},"enabled":{"type":"boolean","example":"true"},"collected":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"card_number":{"type":"string","example":"364435172576215"},"technology":{"type":"string","example":"technologyString1"},"cancelled":{"type":"boolean","example":"true"},"bank_id":{"type":"string","example":"gh.29.uk"},"card_id":{"type":"string","example":"36f8a9e6-c2b1-407a-8bd0-421b7119307e "},"pin_reset":{"type":"array","items":{"$ref":"#/definitions/PinResetJSON"}},"serial_number":{"type":"string","example":"1324234"},"account":{"$ref":"#/definitions/AccountBasicV310"},"valid_from_date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"card_attributes":{"type":"array","items":{"$ref":"#/definitions/CardAttributeCommons"}},"name_on_card":{"type":"string","example":"SusanSmith"},"posted":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"card_type":{"type":"string","example":"Credit"},"on_hot_list":{"type":"boolean","example":"true"}}},"AccountHeldJson":{"required":["number","account_routings","label","bank_id","id"],"properties":{"number":{"type":"string","example":"123"},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"label":{"type":"string","example":"My Account"},"bank_id":{"type":"string","example":"123"},"id":{"type":"string","example":"12314"}}},"PostStandingOrderJsonV400":{"required":["date_starts","customer_id","user_id","amount","counterparty_id","when"],"properties":{"date_starts":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"date_signed":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"amount":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"date_expires":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"when":{"$ref":"#/definitions/When"}}},"AccountRoutingJsonV121":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"AccountNumber"},"address":{"type":"string","example":"4930396"}}},"TransactionAttributeResponseJson":{"required":["transaction_attribute_id","name","type","value"],"properties":{"transaction_attribute_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"name":{"type":"string","example":"HOUSE_RENT"},"type":{"type":"string","example":"DATE_WITH_DAY"},"value":{"type":"string","example":"123456789"}}},"TransactionTagJSON":{"required":["id","value","date","user"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"value":{"type":"string","example":"OBP"},"date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"PostDirectDebitJsonV400":{"required":["date_starts","customer_id","user_id","counterparty_id"],"properties":{"date_starts":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"date_signed":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"date_expires":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"}}},"AccountRouting":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"accountNumber"},"address":{"type":"string","example":"123456"}}},"UpdateAccountJsonV400":{"required":["label"],"properties":{"label":{"type":"string","example":"updated label"}}},"AccountAttributeResponseJson":{"required":["name","account_attribute_id","product_code","type","value"],"properties":{"name":{"type":"string","example":"OVERDRAFT_START_DATE"},"account_attribute_id":{"type":"string","example":"613c83ea-80f9-4560-8404-b9cd4ec42a7f"},"product_code":{"type":"string","example":"saving1"},"type":{"type":"string","example":"DATE_WITH_DAY"},"value":{"type":"string","example":"2012-04-23"}}},"AccountTagJSON":{"required":["id","value","date","user"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"value":{"type":"string","example":"OBP"},"date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"BasicViewJson":{"required":["id","short_name","is_public"],"properties":{"id":{"type":"string","example":"1"},"short_name":{"type":"string","example":"HHH"},"is_public":{"type":"boolean","example":"true"}}},"DirectDebitJsonV400":{"required":["date_starts","customer_id","date_cancelled","date_signed","user_id","bank_id","account_id","date_expires","counterparty_id","direct_debit_id","active"],"properties":{"date_starts":{"type":"string","format":"date","example":"2024-03-25T16:24:19Z"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"date_cancelled":{"type":"string","format":"date","example":"2024-03-25T16:24:19Z"},"date_signed":{"type":"string","format":"date","example":"2024-03-25T16:24:19Z"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"bank_id":{"type":"string","example":"gh.29.uk"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"date_expires":{"type":"string","format":"date","example":"2024-03-25T16:24:19Z"},"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"direct_debit_id":{"type":"string","example":"aa0533bd-eb22-4bff-af75-d45240361b05"},"active":{"type":"boolean","example":"true"}}},"ModeratedCoreAccountJsonV300":{"required":["number","account_routings","label","owners","balance","bank_id","id","type","account_rules"],"properties":{"number":{"type":"string","example":"String"},"account_attributes":{"type":"array","items":{"$ref":"#/definitions/AccountAttributeResponseJson"}},"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"}}}},"CreatePhysicalCardJsonV310":{"required":["allows","expires_date","networks","customer_id","issue_number","enabled","card_number","technology","account_id","pin_reset","serial_number","valid_from_date","name_on_card","card_type"],"properties":{"allows":{"type":"array","items":{"type":"string"}},"expires_date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"networks":{"type":"array","items":{"type":"string"}},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"issue_number":{"type":"string","example":"1"},"replacement":{"$ref":"#/definitions/ReplacementJSON"},"enabled":{"type":"boolean","example":"true"},"collected":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"card_number":{"type":"string","example":"364435172576215"},"technology":{"type":"string","example":"technology1"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"pin_reset":{"type":"array","items":{"$ref":"#/definitions/PinResetJSON"}},"serial_number":{"type":"string","example":"1324234"},"valid_from_date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"name_on_card":{"type":"string","example":"SusanSmith"},"posted":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"card_type":{"type":"string","example":"Credit"}}},"AccountBalanceJsonV400":{"required":["account_routings","label","bank_id","account_id","balances"],"properties":{"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRouting"}},"label":{"type":"string","example":"My Account"},"bank_id":{"type":"string","example":"gh.29.uk"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"balances":{"type":"array","items":{"$ref":"#/definitions/BalanceJsonV400"}}}},"CheckbookOrdersJson":{"required":["account","orders"],"properties":{"account":{"$ref":"#/definitions/AccountV310Json"},"orders":{"type":"array","items":{"$ref":"#/definitions/OrderJson"}}}},"AccountsIdsJsonV300":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/AccountIdJson"}}}},"AccountV310Json":{"required":["account_routings","account_type","bank_id","account_id","branch_routings"],"properties":{"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"account_type":{"type":"string","example":"330"},"bank_id":{"type":"string","example":"gh.29.uk"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"branch_routings":{"type":"array","items":{"$ref":"#/definitions/BranchRoutingJsonV141"}}}},"AccountJSON":{"required":["id","label","views_available","bank_id"],"properties":{"id":{"type":"string","example":"123"},"label":{"type":"string","example":"OBP"},"views_available":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV121"}},"bank_id":{"type":"string","example":"gh.29.uk"}}},"CardAttributeCommons":{"required":["name","attribute_type","value"],"properties":{"name":{"type":"string","example":"OVERDRAFT_START_DATE"},"card_id":{"type":"string","example":"36f8a9e6-c2b1-407a-8bd0-421b7119307e "},"attribute_type":{"type":"string","enum":["STRING","INTEGER","DOUBLE","DATE_WITH_DAY"]},"bank_id":{"$ref":"#/definitions/BankId"},"value":{"type":"string","example":"2012-04-23"},"card_attribute_id":{"type":"string","example":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"}}},"CustomerFaceImageJson":{"required":["url","date"],"properties":{"url":{"type":"string","example":"www.openbankproject"},"date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"}}},"CreateViewJson":{"required":["name","description","is_public","hide_metadata_if_alias_used","which_alias_to_use","metadata_view","allowed_actions"],"properties":{"name":{"type":"string","example":"test"},"description":{"type":"string","example":"This view is for family"},"is_public":{"type":"boolean","example":"false"},"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"}}}},"UpdatePhysicalCardJsonV310":{"required":["allows","expires_date","networks","customer_id","issue_number","replacement","enabled","collected","technology","account_id","pin_reset","serial_number","valid_from_date","name_on_card","posted","card_type"],"properties":{"allows":{"type":"array","items":{"type":"string"}},"expires_date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"networks":{"type":"array","items":{"type":"string"}},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"issue_number":{"type":"string","example":"1"},"replacement":{"$ref":"#/definitions/ReplacementJSON"},"enabled":{"type":"boolean","example":"true"},"collected":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"technology":{"type":"string","example":"technology1"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"pin_reset":{"type":"array","items":{"$ref":"#/definitions/PinResetJSON"}},"serial_number":{"type":"string","example":"1324234"},"valid_from_date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"name_on_card":{"type":"string","example":"SusanSmith"},"posted":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"card_type":{"type":"string","example":"Credit"}}},"PostAccountAccessJsonV400":{"required":["user_id","view"],"properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"view":{"$ref":"#/definitions/PostViewJsonV400"}}},"CoreTransactionDetailsJSON":{"required":["new_balance","description","completed","type","value","posted"],"properties":{"new_balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"description":{"type":"string","example":"OBP"},"completed":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"type":{"type":"string","example":"AC"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"posted":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"}}},"CounterpartyWithMetadataJson400":{"required":["other_account_routing_address","other_account_routing_scheme","created_by_user_id","name","other_account_secondary_routing_address","is_beneficiary","description","other_branch_routing_address","bespoke","other_bank_routing_scheme","other_branch_routing_scheme","this_account_id","this_view_id","currency","metadata","other_bank_routing_address","this_bank_id","counterparty_id","other_account_secondary_routing_scheme"],"properties":{"other_account_routing_address":{"type":"string","example":"36f8a9e6-c2b1-407a-8bd0-421b7119307e"},"other_account_routing_scheme":{"type":"string","example":"OBP"},"created_by_user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"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":"12f8a9e6-c2b1-407a-8bd0-421b7119307e"},"bespoke":{"type":"array","items":{"$ref":"#/definitions/PostCounterpartyBespokeJson"}},"other_bank_routing_scheme":{"type":"string","example":"OBP"},"other_branch_routing_scheme":{"type":"string","example":"OBP"},"this_account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"this_view_id":{"type":"string","example":"owner"},"currency":{"type":"string","example":"EUR"},"metadata":{"$ref":"#/definitions/CounterpartyMetadataJson"},"other_bank_routing_address":{"type":"string","example":"gh.29.uk"},"this_bank_id":{"type":"string","example":"gh.29.uk"},"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"other_account_secondary_routing_scheme":{"type":"string","example":"IBAN"}}},"TransactionJsonV300":{"required":["this_account","id","details","metadata","other_account","transaction_attributes"],"properties":{"this_account":{"$ref":"#/definitions/ThisAccountJsonV300"},"id":{"type":"string","example":"String"},"details":{"$ref":"#/definitions/TransactionDetailsJSON"},"metadata":{"$ref":"#/definitions/TransactionMetadataJSON"},"other_account":{"$ref":"#/definitions/OtherAccountJsonV300"},"transaction_attributes":{"type":"array","items":{"$ref":"#/definitions/TransactionAttributeResponseJson"}}}},"CreateAccountResponseJsonV310":{"required":["account_attributes","branch_id","account_routings","label","balance","user_id","product_code","account_id"],"properties":{"account_attributes":{"type":"array","items":{"$ref":"#/definitions/AccountAttributeResponseJson"}},"branch_id":{"type":"string","example":"DERBY6"},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"label":{"type":"string","example":"My Account"},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"product_code":{"type":"string","example":"AC"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}}},"PermissionJSON":{"required":["user","views"],"properties":{"user":{"$ref":"#/definitions/UserJSONV121"},"views":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV121"}}}},"ViewJSONV121":{"required":["can_see_transaction_start_date","can_add_url","can_add_where_tag","can_see_transaction_this_bank_account","can_see_bank_account_owners","can_see_private_alias","can_edit_owner_comment","can_see_other_account_national_identifier","can_see_public_alias","can_see_physical_location","can_see_owner_comment","can_see_bank_account_iban","can_see_corporate_location","can_see_bank_account_number","can_see_other_account_bank_name","description","can_see_transaction_other_bank_account","can_delete_corporate_location","can_see_comments","can_see_bank_account_bank_name","can_add_more_info","can_see_other_account_number","can_see_other_account_swift_bic","can_add_open_corporates_url","can_see_other_account_kind","can_delete_physical_location","can_see_bank_account_label","can_see_transaction_currency","is_public","can_see_transaction_finish_date","can_add_tag","can_see_images","can_see_bank_account_currency","hide_metadata_if_alias_used","can_delete_where_tag","alias","can_add_image_url","can_add_comment","can_see_image_url","id","can_see_bank_account_national_identifier","can_see_tags","can_see_open_corporates_url","short_name","can_delete_tag","can_see_more_info","can_see_transaction_metadata","can_delete_comment","can_see_where_tag","can_add_private_alias","can_add_public_alias","can_see_bank_account_swift_bic","can_add_image","can_see_transaction_type","can_see_other_account_iban","can_add_physical_location","can_add_corporate_location","can_delete_image","can_see_url","can_see_bank_account_balance","can_see_transaction_balance","can_see_transaction_amount","can_see_other_account_metadata","can_see_bank_account_type","can_see_transaction_description"],"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"}}},"ModeratedFirehoseAccountJsonV400":{"required":["number","account_routings","label","owners","balance","product_code","bank_id","id","account_rules"],"properties":{"number":{"type":"string","example":"String"},"account_attributes":{"type":"array","items":{"$ref":"#/definitions/AccountAttributeResponseJson"}},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"label":{"type":"string","example":"String"},"owners":{"type":"array","items":{"$ref":"#/definitions/UserJSONV121"}},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"product_code":{"type":"string","example":"String"},"bank_id":{"type":"string","example":"String"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"account_rules":{"type":"array","items":{"$ref":"#/definitions/AccountRuleJsonV300"}}}},"CoreTransactionJsonV300":{"required":["this_account","id","details","other_account","transaction_attributes"],"properties":{"this_account":{"$ref":"#/definitions/ThisAccountJsonV300"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"details":{"$ref":"#/definitions/CoreTransactionDetailsJSON"},"other_account":{"$ref":"#/definitions/CoreCounterpartyJsonV300"},"transaction_attributes":{"type":"array","items":{"$ref":"#/definitions/TransactionAttributeResponseJson"}}}},"ReplacementJSON":{"required":["requested_date","reason_requested"],"properties":{"requested_date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"reason_requested":{"type":"string","example":"RENEW"}}},"StandingOrderJsonV400":{"required":["date_starts","customer_id","standing_order_id","date_cancelled","date_signed","user_id","amount","bank_id","account_id","date_expires","counterparty_id","when","active"],"properties":{"date_starts":{"type":"string","format":"date","example":"2024-03-25T16:24:19Z"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"standing_order_id":{"type":"string","example":"aa0533bd-eb22-4bff-af75-d45240361b05"},"date_cancelled":{"type":"string","format":"date","example":"2024-03-25T16:24:19Z"},"date_signed":{"type":"string","format":"date","example":"2024-03-25T16:24:19Z"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"amount":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"bank_id":{"type":"string","example":"gh.29.uk"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"date_expires":{"type":"string","format":"date","example":"2024-03-25T16:24:19Z"},"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"when":{"$ref":"#/definitions/When"},"active":{"type":"boolean","example":"true"}}},"BankId":{"required":["value"],"properties":{"value":{"type":"string","example":"gh.uk.9j"}}},"ViewsJsonV300":{"required":["views"],"properties":{"views":{"type":"array","items":{"$ref":"#/definitions/ViewJsonV300"}}}},"BankRoutingJsonV121":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"Bank_ID"},"address":{"type":"string","example":"gh.29.uk"}}},"CustomerJsonV310":{"required":["customer_id","name_suffix","email","branch_id","mobile_phone_number","customer_number","highest_education_attained","dob_of_dependants","bank_id","date_of_birth","last_ok_date","employment_status","legal_name","title","face_image","dependants","relationship_status","kyc_status"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"name_suffix":{"type":"string","example":"Sr"},"email":{"type":"string","example":"felixsmith@example.com"},"branch_id":{"type":"string","example":"DERBY6"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"customer_number":{"type":"string","example":"5987953"},"highest_education_attained":{"type":"string","example":"Master"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"bank_id":{"type":"string","example":"gh.29.uk"},"date_of_birth":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"employment_status":{"type":"string","example":"worker"},"legal_name":{"type":"string","example":"Eveline Tripman"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"title":{"type":"string","example":"Dr."},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"single"},"kyc_status":{"type":"boolean","example":"true"}}},"PhysicalCardsJSON":{"required":["cards"],"properties":{"cards":{"type":"array","items":{"$ref":"#/definitions/PhysicalCardJSON"}}}},"AccountIdJson":{"required":["id"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"}}},"IbanAddress":{"required":["address"],"properties":{"address":{"type":"string","example":"DE75512108001245126199"}}},"ViewBasic":{"required":["id","name","description"],"properties":{"id":{"type":"string","example":"owner"},"name":{"type":"string","example":"Owner"},"description":{"type":"string","example":"This view is for the owner for the account."}}},"CounterpartiesJson400":{"required":["counterparties"],"properties":{"counterparties":{"type":"array","items":{"$ref":"#/definitions/CounterpartyJson400"}}}},"OtherAccountMetadataJSON":{"required":["public_alias","image_URL","physical_location","private_alias","URL","more_info","corporate_location","open_corporates_URL"],"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"}}},"CoreAccountsHeldJsonV300":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/AccountHeldJson"}}}},"UpdateAccountResponseJsonV310":{"required":["branch_id","account_routings","label","bank_id","account_id","type"],"properties":{"branch_id":{"type":"string","example":"1234"},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"label":{"type":"string","example":"Label"},"bank_id":{"type":"string","example":"gh.29.uk"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"type":{"type":"string","example":"CURRENT"}}},"BasicAccountsJSON":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/BasicAccountJSON"}}}},"ViewJsonV300":{"required":["can_see_transaction_start_date","can_add_url","can_add_where_tag","can_see_transaction_this_bank_account","can_see_bank_account_owners","can_see_bank_routing_address","can_see_private_alias","can_edit_owner_comment","is_system","can_see_other_account_national_identifier","can_see_bank_routing_scheme","can_see_public_alias","can_see_physical_location","can_see_owner_comment","can_see_bank_account_iban","can_see_corporate_location","can_see_bank_account_number","can_see_other_account_bank_name","description","can_see_bank_account_routing_scheme","can_see_transaction_other_bank_account","can_delete_corporate_location","can_see_comments","can_see_bank_account_bank_name","can_add_more_info","can_create_direct_debit","can_see_other_account_number","can_see_other_account_swift_bic","can_add_open_corporates_url","can_see_other_account_kind","can_add_transaction_request_to_own_account","can_delete_physical_location","can_see_bank_account_label","can_see_transaction_currency","is_public","can_see_transaction_finish_date","can_see_bank_account_routing_address","can_add_tag","can_see_images","can_query_available_funds","can_see_bank_account_credit_limit","can_see_bank_account_currency","hide_metadata_if_alias_used","can_delete_where_tag","alias","can_add_image_url","can_add_comment","can_see_image_url","id","can_create_standing_order","can_see_bank_account_national_identifier","can_add_counterparty","can_add_transaction_request_to_any_account","can_see_tags","can_see_open_corporates_url","short_name","can_delete_tag","can_see_other_account_routing_scheme","can_see_more_info","can_see_transaction_metadata","can_delete_comment","can_see_where_tag","can_add_private_alias","can_add_public_alias","can_see_bank_account_swift_bic","can_add_image","can_see_transaction_type","can_see_other_account_routing_address","can_see_other_account_iban","can_add_physical_location","can_add_corporate_location","can_delete_image","can_see_url","can_see_bank_account_balance","can_see_other_bank_routing_address","can_see_transaction_balance","metadata_view","can_see_transaction_amount","can_see_other_account_metadata","can_see_bank_account_type","can_see_other_bank_routing_scheme","can_see_transaction_description"],"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"},"is_system":{"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_create_direct_debit":{"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_create_standing_order":{"type":"boolean","example":"true"},"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"},"is_firehose":{"type":"boolean","example":""},"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"}}},"CardObjectJson":{"required":["card_type","card_description","use_type"],"properties":{"card_type":{"type":"string","example":"5"},"card_description":{"type":"string","example":"good"},"use_type":{"type":"string","example":"3"}}},"PhysicalCardJsonV310":{"required":["allows","expires_date","networks","customer_id","issue_number","replacement","enabled","collected","card_number","technology","cancelled","bank_id","card_id","pin_reset","serial_number","account","valid_from_date","name_on_card","posted","card_type","on_hot_list"],"properties":{"allows":{"type":"array","items":{"type":"string"}},"expires_date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"networks":{"type":"array","items":{"type":"string"}},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"issue_number":{"type":"string","example":"1"},"replacement":{"$ref":"#/definitions/ReplacementJSON"},"enabled":{"type":"boolean","example":"true"},"collected":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"card_number":{"type":"string","example":"364435172576215"},"technology":{"type":"string","example":"technologyString1"},"cancelled":{"type":"boolean","example":"true"},"bank_id":{"type":"string","example":"gh.29.uk"},"card_id":{"type":"string","example":"36f8a9e6-c2b1-407a-8bd0-421b7119307e "},"pin_reset":{"type":"array","items":{"$ref":"#/definitions/PinResetJSON"}},"serial_number":{"type":"string","example":"1324234"},"account":{"$ref":"#/definitions/AccountJSON"},"valid_from_date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"name_on_card":{"type":"string","example":"SusanSmith"},"posted":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"card_type":{"type":"string","example":"Credit"},"on_hot_list":{"type":"boolean","example":"true"}}},"ModeratedCoreAccountJsonV400":{"required":["number","account_routings","label","balance","views_basic","product_code","bank_id","id"],"properties":{"number":{"type":"string","example":"546387432"},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"label":{"type":"string","example":"My Account"},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"views_basic":{"type":"array","items":{"type":"string"}},"product_code":{"type":"string","example":"AC"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}}},"PostCounterpartyBespokeJson":{"required":["key","value"],"properties":{"key":{"type":"string","example":"englishName"},"value":{"type":"string","example":"english Name"}}},"OtherAccountsJsonV300":{"required":["other_accounts"],"properties":{"other_accounts":{"type":"array","items":{"$ref":"#/definitions/OtherAccountJsonV300"}}}},"ViewBasicV300":{"required":["id","short_name","description","is_public"],"properties":{"id":{"type":"string","example":"owner"},"short_name":{"type":"string","example":"Owner"},"description":{"type":"string","example":"This view is for the owner for the account."},"is_public":{"type":"boolean","example":"false"}}},"AccountApplicationUpdateStatusJson":{"required":["status"],"properties":{"status":{"type":"string","example":"ACCEPTED"}}},"TransactionCommentJSON":{"required":["id","value","date","user"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"value":{"type":"string","example":"OBP"},"date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"PostAccountTagJSON":{"required":["value"],"properties":{"value":{"type":"string","example":"String"}}},"TransactionDetailsJSON":{"required":["new_balance","description","completed","type","value","posted"],"properties":{"new_balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"description":{"type":"string","example":"this is for family"},"completed":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"type":{"type":"string","example":"AC"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"posted":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"}}},"CheckFundsAvailableJson":{"required":["answer","date","available_funds_request_id"],"properties":{"answer":{"type":"string","example":"yes"},"date":{"type":"string","format":"date","example":"2024-03-25T16:24:19Z"},"available_funds_request_id":{"type":"string","example":"c4ykz59svsr9b7fmdxk8ezs7"}}},"UserJSONV121":{"required":["id","provider","display_name"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"provider":{"type":"string","example":"http://127.0.0.1:8080"},"display_name":{"type":"string","example":"OBP"}}},"BankAccountRoutingJson":{"required":["account_routing"],"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"account_routing":{"$ref":"#/definitions/AccountRoutingJsonV121"}}},"AccountBasicV310":{"required":["id","label","views_available","bank_id"],"properties":{"id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"label":{"type":"string","example":"My Account"},"views_available":{"type":"array","items":{"$ref":"#/definitions/ViewBasic"}},"bank_id":{"type":"string","example":"gh.29.uk"}}},"PostCounterpartyJson400":{"required":["other_account_routing_address","other_account_routing_scheme","name","other_account_secondary_routing_address","is_beneficiary","description","other_branch_routing_address","bespoke","other_bank_routing_scheme","other_branch_routing_scheme","currency","other_bank_routing_address","other_account_secondary_routing_scheme"],"properties":{"other_account_routing_address":{"type":"string","example":"36f8a9e6-c2b1-407a-8bd0-421b7119307e"},"other_account_routing_scheme":{"type":"string","example":"OBP"},"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":"12f8a9e6-c2b1-407a-8bd0-421b7119307e"},"bespoke":{"type":"array","items":{"$ref":"#/definitions/PostCounterpartyBespokeJson"}},"other_bank_routing_scheme":{"type":"string","example":"OBP"},"other_branch_routing_scheme":{"type":"string","example":"OBP"},"currency":{"type":"string","example":"EUR"},"other_bank_routing_address":{"type":"string","example":"gh.29.uk"},"other_account_secondary_routing_scheme":{"type":"string","example":"IBAN"}}},"AccountsBalancesJsonV400":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/AccountBalanceJsonV400"}}}},"LocationJsonV210":{"required":["latitude","longitude","date","user"],"properties":{"latitude":{"type":"number","format":"double","example":"11.45"},"longitude":{"type":"number","format":"double","example":"11.45"},"date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV210"}}},"CoreTransactionsJsonV300":{"required":["transactions"],"properties":{"transactions":{"type":"array","items":{"$ref":"#/definitions/CoreTransactionJsonV300"}}}},"AccountApplicationResponseJson":{"required":["date_of_application","account_application_id","product_code","status","customer","user"],"properties":{"date_of_application":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"account_application_id":{"type":"string","example":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763"},"product_code":{"type":"string","example":"saveing1"},"status":{"type":"string","example":"REQUESTED"},"customer":{"$ref":"#/definitions/CustomerJsonV310"},"user":{"$ref":"#/definitions/ResourceUserJSON"}}},"ModeratedFirehoseAccountsJsonV400":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/ModeratedFirehoseAccountJsonV400"}}}},"TransactionImageJSON":{"required":["URL","label","id","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":"2017-09-19T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"CreateAccountRequestJsonV310":{"required":["branch_id","account_routings","label","balance","user_id","product_code"],"properties":{"branch_id":{"type":"string","example":"DERBY6"},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"label":{"type":"string","example":"My Account"},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"product_code":{"type":"string","example":"AC"}}},"UserJSONV210":{"required":["id","provider","username"],"properties":{"id":{"type":"string","example":"123"},"provider":{"type":"string","example":"http://127.0.0.1:8080"},"username":{"type":"string","example":"felixsmith"}}},"CreditCardOrderStatusResponseJson":{"required":["cards"],"properties":{"cards":{"type":"array","items":{"$ref":"#/definitions/CardObjectJson"}}}},"BranchRoutingJsonV141":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"BranchNumber"},"address":{"type":"string","example":"678"}}},"ModeratedAccountJSON400":{"required":["number","account_attributes","views_available","tags","account_routings","label","owners","balance","product_code","bank_id","id"],"properties":{"number":{"type":"string","example":"123"},"account_attributes":{"type":"array","items":{"$ref":"#/definitions/AccountAttributeResponseJson"}},"views_available":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV121"}},"tags":{"type":"array","items":{"$ref":"#/definitions/AccountTagJSON"}},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"label":{"type":"string","example":"NoneLabel"},"owners":{"type":"array","items":{"$ref":"#/definitions/UserJSONV121"}},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"product_code":{"type":"string","example":"OBP"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"}}},"AccountHolderJSON":{"required":["name","is_alias"],"properties":{"name":{"type":"string","example":"OBP"},"is_alias":{"type":"boolean","example":"true"}}},"AccountRuleJsonV300":{"required":["scheme","value"],"properties":{"scheme":{"type":"string","example":"OVERDRAFT"},"value":{"type":"string","example":"10"}}},"TransactionsJsonV300":{"required":["transactions"],"properties":{"transactions":{"type":"array","items":{"$ref":"#/definitions/TransactionJsonV300"}}}},"CoreAccountsJsonV300":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/CoreAccountJson"}}}},"PermissionsJSON":{"required":["permissions"],"properties":{"permissions":{"type":"array","items":{"$ref":"#/definitions/PermissionJSON"}}}},"LocationJSONV121":{"required":["latitude","longitude","date","user"],"properties":{"latitude":{"type":"number","format":"double","example":"1.231"},"longitude":{"type":"number","format":"double","example":"1.231"},"date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"AccountAttributeJson":{"required":["name","type","value"],"properties":{"name":{"type":"string","example":"OVERDRAFT_START_DATE"},"type":{"type":"string","example":"DATE_WITH_DAY"},"value":{"type":"string","example":"2012-04-23"}}},"PhysicalCardJSON":{"required":["allows","expires_date","networks","issue_number","replacement","enabled","collected","technology","cancelled","bank_id","pin_reset","serial_number","account","valid_from_date","bank_card_number","name_on_card","posted","on_hot_list"],"properties":{"allows":{"type":"array","items":{"type":"string"}},"expires_date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"networks":{"type":"array","items":{"type":"string"}},"issue_number":{"type":"string","example":"1"},"replacement":{"$ref":"#/definitions/ReplacementJSON"},"enabled":{"type":"boolean","example":"true"},"collected":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"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":"1324234"},"account":{"$ref":"#/definitions/AccountJSON"},"valid_from_date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"bank_card_number":{"type":"string","example":"364435172576215"},"name_on_card":{"type":"string","example":"String"},"posted":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"on_hot_list":{"type":"boolean","example":"true"}}},"CounterpartyJson400":{"required":["other_account_routing_address","other_account_routing_scheme","created_by_user_id","name","other_account_secondary_routing_address","is_beneficiary","description","other_branch_routing_address","bespoke","other_bank_routing_scheme","other_branch_routing_scheme","this_account_id","this_view_id","currency","other_bank_routing_address","this_bank_id","counterparty_id","other_account_secondary_routing_scheme"],"properties":{"other_account_routing_address":{"type":"string","example":"36f8a9e6-c2b1-407a-8bd0-421b7119307e"},"other_account_routing_scheme":{"type":"string","example":"OBP"},"created_by_user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"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":"12f8a9e6-c2b1-407a-8bd0-421b7119307e"},"bespoke":{"type":"array","items":{"$ref":"#/definitions/PostCounterpartyBespokeJson"}},"other_bank_routing_scheme":{"type":"string","example":"OBP"},"other_branch_routing_scheme":{"type":"string","example":"OBP"},"this_account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"this_view_id":{"type":"string","example":"owner"},"currency":{"type":"string","example":"EUR"},"other_bank_routing_address":{"type":"string","example":"gh.29.uk"},"this_bank_id":{"type":"string","example":"gh.29.uk"},"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"other_account_secondary_routing_scheme":{"type":"string","example":"IBAN"}}},"AttributeJsonV400":{"required":["name","value"],"properties":{"name":{"type":"string","example":"country_iso"},"value":{"type":"string","example":""}}},"IbanDetailsJsonV400":{"required":["bank_routings","city","postcode","branch","country","attributes","bank","address","phone"],"properties":{"bank_routings":{"type":"array","items":{"$ref":"#/definitions/BankRoutingJsonV121"}},"city":{"type":"string","example":"Frankfurt am Main"},"postcode":{"type":"string","example":"60311"},"branch":{"type":"string","example":""},"country":{"type":"string","example":"Germany"},"attributes":{"type":"array","items":{"$ref":"#/definitions/AttributeJsonV400"}},"bank":{"type":"string","example":"Societe Generale"},"address":{"type":"string","example":"Neue mainzer strasse 46-50"},"phone":{"type":"string","example":""}}},"When":{"required":["frequency","detail"],"properties":{"frequency":{"type":"string","example":"YEARLY"},"detail":{"type":"string","example":"LAST_DAY"}}},"BalanceJsonV400":{"required":["type","currency","amount"],"properties":{"type":{"type":"string","example":""},"currency":{"type":"string","example":"EUR"},"amount":{"type":"string","example":"10"}}},"PostViewJsonV400":{"required":["view_id","is_system"],"properties":{"view_id":{"type":"string","example":"owner"},"is_system":{"type":"boolean","example":"true"}}},"EmptyClassJson":{"required":["jsonString"],"properties":{"jsonString":{"type":"string","example":"{}"}}},"CardAttributeJson":{"required":["name","type","value"],"properties":{"name":{"type":"string","example":"OVERDRAFT_START_DATE"},"type":{"type":"string","example":"DOUBLE"},"value":{"type":"string","example":"2012-04-23"}}}}}