API Explorer

AUv1.0.0 (99 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get Bank Account By Id

Get Bank Account

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"http://obp_mock//accounts/{account_id}"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "name":"family account", "balance":1 }
Required Roles:
  • CanGetDynamicEndpoint__account202 - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_accounts_ACCOUNT_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_accounts_ACCOUNT_ID Tags: Bank Accounts (Dynamic Endpoint), Dynamic-Endpoint, Dynamic,

Post Accounts

POST Accounts

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"http://obp_mock//accounts"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "name":"family account", "balance":1 }
Required Roles:
  • CanCreateDynamicEndpoint_POST_account118 - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_accounts, operation_id: OBPv4.0.0-dynamicEndpoint_POST_accounts Tags: Bank Accounts (Dynamic Endpoint), Dynamic-Endpoint, Dynamic,