Open Bank Project
|
OBP v4.0.0 filtered by tag: Account, Card (63 APIs)
API Host: https://apisandbox.strings.my
BankAccountsViewsCounterpartiesTransactionsCheck Available FundsCheck Available Funds
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by checkFundsAvailable
Create AccountCreate Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID. The User can create an Account for themself - or - the User that has the USER_ID specified in the POST body. If the PUT 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 PUT 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. Note: The Amount MUST be zero. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by createAccount
Create Account (POST)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. Note: The Amount MUST be zero. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by addAccount
Create Account AttributeCreate 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) ISSUE_DATE (When the bond was issued in the market) See FPML for more examples. The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY" Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by createAccountAttribute
Create or Update Account Attribute DefinitionCreate 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 Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by createOrUpdateAccountAttributeDefinition
Delete Account Attribute DefinitionDelete Account Attribute Definition by ATTRIBUTE_DEFINITION_ID Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by deleteAccountAttributeDefinition
Delete Account CascadeDelete an Account Cascade specified by ACCOUNT_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by deleteAccountCascade
Get Account Attribute DefinitionGet Account Attribute Definition Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getAccountAttributeDefinition
Get Account by Id (Core)Information returned about the account specified by ACCOUNT_ID:
This call returns the owner view and requires access to that view. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getCoreAccountById
Get Account by Id (Full)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. Authentication is required if the 'is_public' field in view (VIEW_ID) is not set to Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv4.0.0 by getPrivateAccountByIdFull
Get Accounts BalancesGet the Balances for the Accounts of the current User at one bank. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getBankAccountsBalances
Get Accounts HeldGet 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: Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getAccountsHeld
Get Accounts at BankReturns the list of accounts at BANK_ID that the user has access to. optional request parameters for filter with attributes Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getPrivateAccountsAtOneBank
Get Accounts at Bank (IDs only)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: Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getPrivateAccountIdsbyBankId
Get Accounts at Bank (Minimal)Returns the minimal list of private accounts at BANK_ID that the user has access to. If you want to see more information on the Views, use the Account Detail call. optional request parameters:
whole url example: Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by privateAccountsAtOneBank
Get Accounts at all Banks (private)Returns the list of accounts containing private views for the user. optional request parameters:
whole url example: Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by corePrivateAccountsAllBanks
Get Checkbook orders
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getCheckbookOrders
Get Firehose Accounts at BankGet 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 to invalid Browser cache, add timestamp query parameter as follow, the parameter name must be Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.0.0 by getFirehoseAccountsAtOneBank
Update AccountUpdate the account. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by updateAccount
Update Account AttributeUpdate 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) ISSUE_DATE (When the bond was issued in the market) See FPML for more examples. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by updateAccountAttribute
Update Account LabelUpdate 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 Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by updateAccountLabel
Grant User access to ViewGrants 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. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by grantUserAccessToView
Revoke User access to ViewRevoke 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. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by revokeUserAccessToView
Create Account ApplicationCreate Account Application Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv3.1.0 by createAccountApplication
Get Account Application by IdGet the Account Application. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv3.1.0 by getAccountApplication
Get Account ApplicationsGet the Account Applications. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getAccountApplications
Update Account Application StatusUpdate an Account Application status Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv3.1.0 by updateAccountApplicationStatus
Create a tag on accountPosts 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. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by addTagForViewOnAccount
Delete a tag on accountDeletes 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. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by deleteTagForViewOnAccount
Get tags on accountReturns the account ACCOUNT_ID tags made on a view (VIEW_ID). Authentication is required as the tag is linked with the user. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getTagsForViewOnAccount
Get Public Account by IdReturns 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. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getPublicAccountById
Get Public Accounts at BankReturns 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 Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv2.0.0 by publicAccountsAtOneBank
Get Public Accounts at all BanksGet public accounts at all banks (Anonymous access). Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv2.0.0 by publicAccountsAllBanks
Create CardCreate Card at bank specified by BANK_ID . Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by addCardForBank
Create Card AttributeCreate 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 Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv3.1.0 by createCardAttribute
Create or Update Card Attribute DefinitionCreate 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 Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by createOrUpdateCardAttributeDefinition
Delete CardDelete a Card at bank specified by CARD_ID . Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by deleteCardForBank
Delete Card Attribute DefinitionDelete Card Attribute Definition by ATTRIBUTE_DEFINITION_ID Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by deleteCardAttributeDefinition
Get Card Attribute DefinitionGet Card Attribute Definition Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getCardAttributeDefinition
Get Card By IdThis will the datails of the card. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv3.1.0 by getCardForBank
Get Cards for the specified bankShould 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. ${authenticationRequiredMessage(true)} Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getCardsForBank
Get cards for the current userReturns data about all the physical cards a user has been issued. These could be debit cards, credit cards, etc. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.3.0 by getCards
Get status of Credit Card order
Get all orders Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv3.1.0 by getStatusOfCreditCardOrder
Update CardUpdate Card at bank specified by CARD_ID . Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by updatedCardForBank
Update Card AttributeUpdate 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 Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv3.1.0 by updateCardAttribute
Create Counterparty (Explicit)Create Counterparty (Explicit) for an Account. In OBP, there are two types of Counterparty.
Explicit Counterparties are created for the account / view 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: account_routing_scheme : eg: AccountId or AccountNumber or any other strings account_routing_address : eg: 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: is_beneficiary : must be set to 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 A minimal example for TransactionRequestType == SEPA { Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv4.0.0 by createCounterparty
Create Counterparty for any account (Explicit)Create Counterparty for any Account. (Explicit) In OBP, there are two types of Counterparty.
Explicit Counterparties are created for the account / view 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: account_routing_scheme : eg: AccountId or AccountNumber or any other strings account_routing_address : eg: 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: is_beneficiary : must be set to 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 A minimal example for TransactionRequestType == SEPA { Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by createCounterpartyForAnyAccount
Get Counterparties (Explicit)Get the Counterparties (Explicit) for the account / view. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getExplictCounterpartiesForAccount
Get Counterparty by name for any account (Explicit)Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by getCounterpartyByNameForAnyAccount
Get Other Account by IdReturns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID. Authentication is required if the view is not public. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getOtherAccountByIdForBankAccount
Get Other Accounts of one AccountReturns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID. Authentication is required if the view VIEW_ID is not public. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getOtherAccountsForBankAccount
Create Direct DebitCreate direct debit for an account. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv4.0.0 by createDirectDebit
Create Direct Debit (management)Create direct debit for an account. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by createDirectDebitManagement
Create Standing OrderCreate standing order for an account. when -> frequency = {‘YEARLY’,’MONTHLY, ‘WEEKLY’, ‘BI-WEEKLY’, DAILY’} Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv4.0.0 by createStandingOrder
Create Standing Order (management)Create standing order for an account. when -> frequency = {‘YEARLY’,’MONTHLY, ‘WEEKLY’, ‘BI-WEEKLY’, DAILY’} Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by createStandingOrderManagement
Get Transactions for Account (Core)Returns transactions list (Core info) of the account specified by ACCOUNT_ID. Authentication is Mandatory Possible custom headers 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 Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv3.0.0 by getCoreTransactionsForBankAccount
Get Transactions for Account (Full)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 headers 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 Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv3.0.0 by getTransactionsForBankAccount
Create ViewCreate a view on bank account Authentication is Mandatory and the user needs to have access to the owner view.
The 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to 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 You MUST use a leading _ (underscore) in the view name because other view names are reserved for OBP system views. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by createViewForBankAccount
Delete ViewDeletes the view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by deleteViewForBankAccount
Get Account access for UserReturns 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. Authentication is Mandatory The user needs to have access to the owner view. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getPermissionForUserForBankAccount
Get Views for AccountViewsViews 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 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: 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). AllOptional 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. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getViewsForBankAccount
Get accessReturns 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 Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv2.0.0 by getPermissionsForBankAccount
Update ViewUpdate 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 Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by updateViewForBankAccount
|