{
  "answer":"yes",
  "date":"2021-04-19T15:43:07Z",
  "available_funds_request_id":"c4ykz59svsr9b7fmdxk8ezs7"
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-20054: Invalid amount. Please specify a valid value for amount.
• OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
• OBP-50000: Unknown Error.

• obp.checkBankAccountExists
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "label":"My Account",
  "product_code":"AC",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "branch_id":"DERBY6",
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "account_attributes":[{
    "product_code":"saving1",
    "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
    "name":"OVERDRAFT_START_DATE",
    "type":"DATE_WITH_DAY",
    "value":"2012-04-23"
  }]
}
								
							

• CanCreateAccount - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-10001: Incorrect json format.
• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-30106: Invalid Balance Amount.
• OBP-30112: Invalid Number. Initial balance must be a number, e.g 1000.00
• OBP-30109: Initial Balance of Account must be Zero (0).
• OBP-30105: Invalid Balance Currency.
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser
• obp.createAccountAttributes
• obp.getProductAttributesByBankAndCode
• obp.addBankAccount
• obp.getBank

								
									
{
  "product_code":"saving1",
  "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
  "name":"OVERDRAFT_START_DATE",
  "type":"DATE_WITH_DAY",
  "value":"2012-04-23"
}
								
							

• CanCreateAccountAttributeAtOneBank - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-10001: Incorrect json format.
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

• obp.getProduct
• obp.createOrUpdateAccountAttribute
• obp.checkBankAccountExists
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "bank_id":"gh.29.uk",
  "name":"SPECIAL_TAX_NUMBER",
  "category":"Account",
  "type":"STRING",
  "description":"description",
  "alias":"STRING",
  "can_be_seen_on_views":["bank"],
  "is_active":true
}
								
							

• CanCreateAccountAttributeDefinitionAtOneBank - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-10001: Incorrect json format.
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

• obp.getBankAccountsForUser
• obp.getBank
• obp.createOrUpdateAttributeDefinition

								
									
{
  "jsonString":"{}"
}
								
							

• CanDeleteAccountAttributeDefinitionAtOneBank - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

• obp.getBankAccountsForUser
• obp.getBank
• obp.deleteAttributeDefinition

								
									
{
  "jsonString":"{}"
}
								
							

• CanDeleteAccountCascade - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser
• obp.getBank
• obp.checkBankAccountExists

								
									
{
  "attributes":[{
    "attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "bank_id":"gh.29.uk",
    "name":"SPECIAL_TAX_NUMBER",
    "category":"Account",
    "type":"STRING",
    "description":"description",
    "alias":"STRING",
    "can_be_seen_on_views":["bank"],
    "is_active":true
  }]
}
								
							

• CanGetAccountAttributeDefinitionAtOneBank - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

• obp.getBankAccountsForUser
• obp.getBank
• obp.getAttributeDefinition

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "label":"NoneLabel",
  "number":"123",
  "owners":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"http://127.0.0.1:8080",
    "display_name":"OBP"
  }],
  "product_code":"OBP",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "views_available":[{
    "id":"123",
    "short_name":"short_name",
    "description":"description",
    "is_public":true,
    "alias":"None",
    "hide_metadata_if_alias_used":true,
    "can_add_comment":true,
    "can_add_corporate_location":true,
    "can_add_image":true,
    "can_add_image_url":true,
    "can_add_more_info":true,
    "can_add_open_corporates_url":true,
    "can_add_physical_location":true,
    "can_add_private_alias":true,
    "can_add_public_alias":true,
    "can_add_tag":true,
    "can_add_url":true,
    "can_add_where_tag":true,
    "can_delete_comment":true,
    "can_delete_corporate_location":true,
    "can_delete_image":true,
    "can_delete_physical_location":true,
    "can_delete_tag":true,
    "can_delete_where_tag":true,
    "can_edit_owner_comment":true,
    "can_see_bank_account_balance":true,
    "can_see_bank_account_bank_name":true,
    "can_see_bank_account_currency":true,
    "can_see_bank_account_iban":true,
    "can_see_bank_account_label":true,
    "can_see_bank_account_national_identifier":true,
    "can_see_bank_account_number":true,
    "can_see_bank_account_owners":true,
    "can_see_bank_account_swift_bic":true,
    "can_see_bank_account_type":true,
    "can_see_comments":true,
    "can_see_corporate_location":true,
    "can_see_image_url":true,
    "can_see_images":true,
    "can_see_more_info":true,
    "can_see_open_corporates_url":true,
    "can_see_other_account_bank_name":true,
    "can_see_other_account_iban":true,
    "can_see_other_account_kind":true,
    "can_see_other_account_metadata":true,
    "can_see_other_account_national_identifier":true,
    "can_see_other_account_number":true,
    "can_see_other_account_swift_bic":true,
    "can_see_owner_comment":true,
    "can_see_physical_location":true,
    "can_see_private_alias":true,
    "can_see_public_alias":true,
    "can_see_tags":true,
    "can_see_transaction_amount":true,
    "can_see_transaction_balance":true,
    "can_see_transaction_currency":true,
    "can_see_transaction_description":true,
    "can_see_transaction_finish_date":true,
    "can_see_transaction_metadata":true,
    "can_see_transaction_other_bank_account":true,
    "can_see_transaction_start_date":true,
    "can_see_transaction_this_bank_account":true,
    "can_see_transaction_type":true,
    "can_see_url":true,
    "can_see_where_tag":true
  }],
  "bank_id":"gh.29.uk",
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "account_attributes":[{
    "product_code":"saving1",
    "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
    "name":"OVERDRAFT_START_DATE",
    "type":"DATE_WITH_DAY",
    "value":"2012-04-23"
  }],
  "tags":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "value":"OBP",
    "date":"2017-09-19T00:00:00Z",
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser
• obp.getAccountAttributesByAccount

								
									
{
  "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "bank_id":"gh.29.uk",
  "label":"My Account",
  "number":"546387432",
  "product_code":"AC",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "views_basic":["owner"]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser
• obp.checkBankAccountExists

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "label":"NoneLabel",
  "number":"123",
  "owners":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"http://127.0.0.1:8080",
    "display_name":"OBP"
  }],
  "product_code":"OBP",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "views_available":[{
    "id":"123",
    "short_name":"short_name",
    "description":"description",
    "is_public":true,
    "alias":"None",
    "hide_metadata_if_alias_used":true,
    "can_add_comment":true,
    "can_add_corporate_location":true,
    "can_add_image":true,
    "can_add_image_url":true,
    "can_add_more_info":true,
    "can_add_open_corporates_url":true,
    "can_add_physical_location":true,
    "can_add_private_alias":true,
    "can_add_public_alias":true,
    "can_add_tag":true,
    "can_add_url":true,
    "can_add_where_tag":true,
    "can_delete_comment":true,
    "can_delete_corporate_location":true,
    "can_delete_image":true,
    "can_delete_physical_location":true,
    "can_delete_tag":true,
    "can_delete_where_tag":true,
    "can_edit_owner_comment":true,
    "can_see_bank_account_balance":true,
    "can_see_bank_account_bank_name":true,
    "can_see_bank_account_currency":true,
    "can_see_bank_account_iban":true,
    "can_see_bank_account_label":true,
    "can_see_bank_account_national_identifier":true,
    "can_see_bank_account_number":true,
    "can_see_bank_account_owners":true,
    "can_see_bank_account_swift_bic":true,
    "can_see_bank_account_type":true,
    "can_see_comments":true,
    "can_see_corporate_location":true,
    "can_see_image_url":true,
    "can_see_images":true,
    "can_see_more_info":true,
    "can_see_open_corporates_url":true,
    "can_see_other_account_bank_name":true,
    "can_see_other_account_iban":true,
    "can_see_other_account_kind":true,
    "can_see_other_account_metadata":true,
    "can_see_other_account_national_identifier":true,
    "can_see_other_account_number":true,
    "can_see_other_account_swift_bic":true,
    "can_see_owner_comment":true,
    "can_see_physical_location":true,
    "can_see_private_alias":true,
    "can_see_public_alias":true,
    "can_see_tags":true,
    "can_see_transaction_amount":true,
    "can_see_transaction_balance":true,
    "can_see_transaction_currency":true,
    "can_see_transaction_description":true,
    "can_see_transaction_finish_date":true,
    "can_see_transaction_metadata":true,
    "can_see_transaction_other_bank_account":true,
    "can_see_transaction_start_date":true,
    "can_see_transaction_this_bank_account":true,
    "can_see_transaction_type":true,
    "can_see_url":true,
    "can_see_where_tag":true
  }],
  "bank_id":"gh.29.uk",
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "account_attributes":[{
    "product_code":"saving1",
    "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
    "name":"OVERDRAFT_START_DATE",
    "type":"DATE_WITH_DAY",
    "value":"2012-04-23"
  }],
  "tags":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "value":"OBP",
    "date":"2017-09-19T00:00:00Z",
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser
• obp.getBank
• obp.checkBankAccountExists
• obp.getAccountAttributesByAccount

								
									
{
  "accounts":[{
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "bank_id":"gh.29.uk",
    "account_routings":[{
      "scheme":"accountNumber",
      "address":"123456"
    }],
    "label":"My Account",
    "balances":[{
      "type":"",
      "currency":"EUR",
      "amount":"10"
    }]
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser
• obp.getBank
• obp.getBankAccountsBalances

								
									
{
  "accounts":[{
    "id":"12314",
    "label":"My Account",
    "bank_id":"123",
    "number":"123",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }]
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-50000: Unknown Error.

• obp.getCoreBankAccounts
• obp.getBankAccountsHeld
• obp.getAccountsHeld
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "accounts":[{
    "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "label":"NoneLabel",
    "bank_id":"gh.29.uk",
    "views_available":[{
      "id":"1",
      "short_name":"HHH",
      "is_public":true
    }]
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser
• obp.getBank
• obp.getBankAccounts

								
									
{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf"
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.

• obp.getCoreBankAccounts
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "label":"String",
    "bank_id":"gh.29.uk",
    "account_type":"330",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "views":[{
      "id":"owner",
      "short_name":"Owner",
      "description":"This view is for the owner for the account.",
      "is_public":false
    }]
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.

• obp.getCoreBankAccounts
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "label":"String",
    "bank_id":"gh.29.uk",
    "account_type":"330",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "views":[{
      "id":"owner",
      "short_name":"Owner",
      "description":"This view is for the owner for the account.",
      "is_public":false
    }]
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-50000: Unknown Error.

• obp.getCoreBankAccounts
• obp.getBankAccountsForUser

								
									
{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "label":"NoneLabel",
    "number":"123",
    "owners":[{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }],
    "product_code":"OBP",
    "balance":{
      "currency":"EUR",
      "amount":"0"
    },
    "views_available":[{
      "id":"123",
      "short_name":"short_name",
      "description":"description",
      "is_public":true,
      "alias":"None",
      "hide_metadata_if_alias_used":true,
      "can_add_comment":true,
      "can_add_corporate_location":true,
      "can_add_image":true,
      "can_add_image_url":true,
      "can_add_more_info":true,
      "can_add_open_corporates_url":true,
      "can_add_physical_location":true,
      "can_add_private_alias":true,
      "can_add_public_alias":true,
      "can_add_tag":true,
      "can_add_url":true,
      "can_add_where_tag":true,
      "can_delete_comment":true,
      "can_delete_corporate_location":true,
      "can_delete_image":true,
      "can_delete_physical_location":true,
      "can_delete_tag":true,
      "can_delete_where_tag":true,
      "can_edit_owner_comment":true,
      "can_see_bank_account_balance":true,
      "can_see_bank_account_bank_name":true,
      "can_see_bank_account_currency":true,
      "can_see_bank_account_iban":true,
      "can_see_bank_account_label":true,
      "can_see_bank_account_national_identifier":true,
      "can_see_bank_account_number":true,
      "can_see_bank_account_owners":true,
      "can_see_bank_account_swift_bic":true,
      "can_see_bank_account_type":true,
      "can_see_comments":true,
      "can_see_corporate_location":true,
      "can_see_image_url":true,
      "can_see_images":true,
      "can_see_more_info":true,
      "can_see_open_corporates_url":true,
      "can_see_other_account_bank_name":true,
      "can_see_other_account_iban":true,
      "can_see_other_account_kind":true,
      "can_see_other_account_metadata":true,
      "can_see_other_account_national_identifier":true,
      "can_see_other_account_number":true,
      "can_see_other_account_swift_bic":true,
      "can_see_owner_comment":true,
      "can_see_physical_location":true,
      "can_see_private_alias":true,
      "can_see_public_alias":true,
      "can_see_tags":true,
      "can_see_transaction_amount":true,
      "can_see_transaction_balance":true,
      "can_see_transaction_currency":true,
      "can_see_transaction_description":true,
      "can_see_transaction_finish_date":true,
      "can_see_transaction_metadata":true,
      "can_see_transaction_other_bank_account":true,
      "can_see_transaction_start_date":true,
      "can_see_transaction_this_bank_account":true,
      "can_see_transaction_type":true,
      "can_see_url":true,
      "can_see_where_tag":true
    }],
    "bank_id":"gh.29.uk",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "account_attributes":[{
      "product_code":"saving1",
      "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
      "name":"OVERDRAFT_START_DATE",
      "type":"DATE_WITH_DAY",
      "value":"2012-04-23"
    }],
    "tags":[{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "value":"OBP",
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"http://127.0.0.1:8080",
        "display_name":"OBP"
      }
    }]
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser
• obp.getAccountAttributesByAccount
• obp.checkBankAccountExists
• obp.getAccountRoutingsByScheme

								
									
{
  "account":{
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "account_type":"330",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "branch_routings":[{
      "scheme":"BranchNumber",
      "address":"678"
    }]
  },
  "orders":[{
    "order":{
      "order_id":"xjksajfkj",
      "order_date":"07082013",
      "number_of_checkbooks":"4",
      "distribution_channel":"1201",
      "status":"2",
      "first_check_number":"5165276",
      "shipping_code":"1"
    }
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-50211: Connector did not return the set of check book.
• OBP-50000: Unknown Error.

• obp.getCheckbookOrders
• obp.checkBankAccountExists
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "bank_id":"String",
    "label":"String",
    "number":"String",
    "owners":[{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }],
    "product_code":"String",
    "balance":{
      "currency":"EUR",
      "amount":"0"
    },
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "account_rules":[{
      "scheme":"OVERDRAFT",
      "value":"10"
    }]
  }]
}
								
							

• CanUseAccountFirehoseAtAnyBank - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

• obp.getBankAccountsForUser
• obp.getBank
• obp.getBankLegacy
• obp.getBankAccountOld
• obp.getAccountAttributesByAccount

								
									
{
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "label":"Label",
  "type":"CURRENT",
  "branch_id":"1234",
  "account_routings":[{
    "scheme":"IBAN",
    "address":"DE91 1000 0000 0123 4567 89"
  }]
}
								
							

• CanUpdateAccount - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-10001: Incorrect json format.
• OBP-20001: User not logged in. Authentication is required!
• OBP-50000: Unknown Error.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-20006: User is missing one or more roles:

• obp.updateBankAccount
• obp.checkBankAccountExists
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "product_code":"saving1",
  "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
  "name":"OVERDRAFT_START_DATE",
  "type":"DATE_WITH_DAY",
  "value":"2012-04-23"
}
								
							

• CanUpdateAccountAttribute - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-10001: Incorrect json format.
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

• obp.createOrUpdateAccountAttribute
• obp.getAccountAttributeById
• obp.checkBankAccountExists
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "success":"Success"
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-10001: Incorrect json format.
• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• user does not have access to owner view on account

• obp.getBankAccountsForUser
• obp.getBank
• obp.checkBankAccountExists
• obp.updateAccountLabel

								
									
{
  "is_valid":true,
  "details":{
    "bank_routings":[{
      "scheme":"BIC",
      "address":"SOGEDEFF"
    }],
    "bank":"Societe Generale",
    "branch":"",
    "address":"Neue mainzer strasse 46-50",
    "city":"Frankfurt am Main",
    "postcode":"60311",
    "phone":"",
    "country":"Germany",
    "attributes":[{
      "name":"country_iso",
      "value":""
    },{
      "name":"sepa_credit_transfer",
      "value":"YES"
    },{
      "name":"sepa_direct_debit",
      "value":"YES"
    },{
      "name":"sepa_sdd_core",
      "value":"YES"
    },{
      "name":"sepa_b2b",
      "value":"YES"
    },{
      "name":"sepa_card_clearing",
      "value":"YES"
    }]
  }
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser
• obp.validateAndCheckIbanNumber

								
									
{
  "id":"1234",
  "short_name":"short_name",
  "description":"description",
  "metadata_view":"owner",
  "is_public":true,
  "is_system":true,
  "alias":"No",
  "hide_metadata_if_alias_used":true,
  "can_add_comment":true,
  "can_add_corporate_location":true,
  "can_add_image":true,
  "can_add_image_url":true,
  "can_add_more_info":true,
  "can_add_open_corporates_url":true,
  "can_add_physical_location":true,
  "can_add_private_alias":true,
  "can_add_public_alias":true,
  "can_add_tag":true,
  "can_add_url":true,
  "can_add_where_tag":true,
  "can_delete_comment":true,
  "can_add_counterparty":true,
  "can_delete_corporate_location":true,
  "can_delete_image":true,
  "can_delete_physical_location":true,
  "can_delete_tag":true,
  "can_delete_where_tag":true,
  "can_edit_owner_comment":true,
  "can_see_bank_account_balance":true,
  "can_query_available_funds":true,
  "can_see_bank_account_bank_name":true,
  "can_see_bank_account_currency":true,
  "can_see_bank_account_iban":true,
  "can_see_bank_account_label":true,
  "can_see_bank_account_national_identifier":true,
  "can_see_bank_account_number":true,
  "can_see_bank_account_owners":true,
  "can_see_bank_account_swift_bic":true,
  "can_see_bank_account_type":true,
  "can_see_comments":true,
  "can_see_corporate_location":true,
  "can_see_image_url":true,
  "can_see_images":true,
  "can_see_more_info":true,
  "can_see_open_corporates_url":true,
  "can_see_other_account_bank_name":true,
  "can_see_other_account_iban":true,
  "can_see_other_account_kind":true,
  "can_see_other_account_metadata":true,
  "can_see_other_account_national_identifier":true,
  "can_see_other_account_number":true,
  "can_see_other_account_swift_bic":true,
  "can_see_owner_comment":true,
  "can_see_physical_location":true,
  "can_see_private_alias":true,
  "can_see_public_alias":true,
  "can_see_tags":true,
  "can_see_transaction_amount":true,
  "can_see_transaction_balance":true,
  "can_see_transaction_currency":true,
  "can_see_transaction_description":true,
  "can_see_transaction_finish_date":true,
  "can_see_transaction_metadata":true,
  "can_see_transaction_other_bank_account":true,
  "can_see_transaction_start_date":true,
  "can_see_transaction_this_bank_account":true,
  "can_see_transaction_type":true,
  "can_see_url":true,
  "can_see_where_tag":true,
  "can_see_bank_routing_scheme":true,
  "can_see_bank_routing_address":true,
  "can_see_bank_account_routing_scheme":true,
  "can_see_bank_account_routing_address":true,
  "can_see_other_bank_routing_scheme":true,
  "can_see_other_bank_routing_address":true,
  "can_see_other_account_routing_scheme":true,
  "can_see_other_account_routing_address":true,
  "can_add_transaction_request_to_own_account":true,
  "can_add_transaction_request_to_any_account":true,
  "can_see_bank_account_credit_limit":true,
  "can_create_direct_debit":true,
  "can_create_standing_order":true
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-20047: User must have access to the owner view or must be an account holder.
• OBP-10001: Incorrect json format.
• OBP-20005: User not found. Please specify a valid value for USER_ID.
• OBP-30252: System view not found. Please specify a valid value for VIEW_ID
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-30063: Cannot grant account access.
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser

								
									
{
  "revoked":true
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-20047: User must have access to the owner view or must be an account holder.
• OBP-10001: Incorrect json format.
• OBP-20005: User not found. Please specify a valid value for USER_ID.
• OBP-30252: System view not found. Please specify a valid value for VIEW_ID
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-30064: Cannot revoke account access.
• OBP-30065: Cannot find account access.
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser

								
									
{
  "revoked":true
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-20047: User must have access to the owner view or must be an account holder.
• OBP-10001: Incorrect json format.
• OBP-20005: User not found. Please specify a valid value for USER_ID.
• OBP-30252: System view not found. Please specify a valid value for VIEW_ID
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-30064: Cannot revoke account access.
• OBP-30065: Cannot find account access.
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser

								
									
{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"saveing1",
  "user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "customer":{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "legal_name":"Eveline Tripman",
    "mobile_phone_number":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-19T00:00:00Z"
    },
    "date_of_birth":"2017-09-19T00:00:00Z",
    "relationship_status":"single",
    "dependants":1,
    "dob_of_dependants":["2017-09-19T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"0"
    },
    "highest_education_attained":"Master",
    "employment_status":"worker",
    "kyc_status":true,
    "last_ok_date":"2017-09-19T00:00:00Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  },
  "date_of_application":"2017-09-19T00:00:00Z",
  "status":"REQUESTED"
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-10001: Incorrect json format.
• OBP-50000: Unknown Error.
• OBP-20001: User not logged in. Authentication is required!

• obp.getCustomerByCustomerId
• obp.createAccountApplication
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"saveing1",
  "user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "customer":{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "legal_name":"Eveline Tripman",
    "mobile_phone_number":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-19T00:00:00Z"
    },
    "date_of_birth":"2017-09-19T00:00:00Z",
    "relationship_status":"single",
    "dependants":1,
    "dob_of_dependants":["2017-09-19T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"0"
    },
    "highest_education_attained":"Master",
    "employment_status":"worker",
    "kyc_status":true,
    "last_ok_date":"2017-09-19T00:00:00Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  },
  "date_of_application":"2017-09-19T00:00:00Z",
  "status":"REQUESTED"
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-50000: Unknown Error.

• obp.getCustomerByCustomerId
• obp.getAccountApplicationById
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "account_applications":[{
    "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
    "product_code":"saveing1",
    "user":{
      "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "email":"felixsmith@example.com",
      "provider_id":"Chris",
      "provider":"http://127.0.0.1:8080",
      "username":"felixsmith"
    },
    "customer":{
      "bank_id":"gh.29.uk",
      "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customer_number":"5987953",
      "legal_name":"Eveline Tripman",
      "mobile_phone_number":"+44 07972 444 876",
      "email":"felixsmith@example.com",
      "face_image":{
        "url":"www.openbankproject",
        "date":"2017-09-19T00:00:00Z"
      },
      "date_of_birth":"2017-09-19T00:00:00Z",
      "relationship_status":"single",
      "dependants":1,
      "dob_of_dependants":["2017-09-19T00:00:00Z"],
      "credit_rating":{
        "rating":"OBP",
        "source":"OBP"
      },
      "credit_limit":{
        "currency":"EUR",
        "amount":"0"
      },
      "highest_education_attained":"Master",
      "employment_status":"worker",
      "kyc_status":true,
      "last_ok_date":"2017-09-19T00:00:00Z",
      "title":"Dr.",
      "branch_id":"DERBY6",
      "name_suffix":"Sr"
    },
    "date_of_application":"2017-09-19T00:00:00Z",
    "status":"REQUESTED"
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-50000: Unknown Error.

• obp.getAllAccountApplication
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"saveing1",
  "user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "customer":{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "legal_name":"Eveline Tripman",
    "mobile_phone_number":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-19T00:00:00Z"
    },
    "date_of_birth":"2017-09-19T00:00:00Z",
    "relationship_status":"single",
    "dependants":1,
    "dob_of_dependants":["2017-09-19T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"0"
    },
    "highest_education_attained":"Master",
    "employment_status":"worker",
    "kyc_status":true,
    "last_ok_date":"2017-09-19T00:00:00Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  },
  "date_of_application":"2017-09-19T00:00:00Z",
  "status":"REQUESTED"
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-50000: Unknown Error.

• obp.getCustomerByCustomerId
• obp.createBankAccount
• obp.updateAccountApplicationStatus
• obp.getAccountApplicationById
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "value":"OBP",
  "date":"2017-09-19T00:00:00Z",
  "user":{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"http://127.0.0.1:8080",
    "display_name":"OBP"
  }
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• OBP-30022: The current view does not have the permission:
• OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser
• obp.getBank
• obp.checkBankAccountExists

								
									
{
  "jsonString":"{}"
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-30022: The current view does not have the permission:
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser
• obp.getBank
• obp.checkBankAccountExists

								
									
{
  "tags":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "value":"OBP",
    "date":"2017-09-19T00:00:00Z",
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-30022: The current view does not have the permission:
• OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser
• obp.getBank
• obp.checkBankAccountExists

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "bank_id":"String",
  "label":"String",
  "number":"String",
  "owners":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"http://127.0.0.1:8080",
    "display_name":"OBP"
  }],
  "type":"String",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "account_rules":[{
    "scheme":"OVERDRAFT",
    "value":"10"
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-50000: Unknown Error.

• obp.checkBankAccountExists

								
									
{
  "accounts":[{
    "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "label":"NoneLabel",
    "bank_id":"gh.29.uk",
    "views_available":[{
      "id":"1",
      "short_name":"HHH",
      "is_public":true
    }]
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-50000: Unknown Error.

• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "accounts":[{
    "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "label":"NoneLabel",
    "bank_id":"gh.29.uk",
    "views_available":[{
      "id":"1",
      "short_name":"HHH",
      "is_public":true
    }]
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-30066: Could not get accounts.
• OBP-50000: Unknown Error.

								
									
{
  "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "bank_id":"gh.29.uk",
  "card_number":"364435172576215",
  "card_type":"Credit",
  "name_on_card":"SusanSmith",
  "issue_number":"1",
  "serial_number":"1324234",
  "valid_from_date":"2017-09-19T00:00:00Z",
  "expires_date":"2017-09-19T00:00:00Z",
  "enabled":true,
  "cancelled":true,
  "on_hot_list":true,
  "technology":"technologyString1",
  "networks":["networks1"],
  "allows":["credit","debit"],
  "account":{
    "id":"123",
    "label":"OBP",
    "views_available":[{
      "id":"123",
      "short_name":"short_name",
      "description":"description",
      "is_public":true,
      "alias":"None",
      "hide_metadata_if_alias_used":true,
      "can_add_comment":true,
      "can_add_corporate_location":true,
      "can_add_image":true,
      "can_add_image_url":true,
      "can_add_more_info":true,
      "can_add_open_corporates_url":true,
      "can_add_physical_location":true,
      "can_add_private_alias":true,
      "can_add_public_alias":true,
      "can_add_tag":true,
      "can_add_url":true,
      "can_add_where_tag":true,
      "can_delete_comment":true,
      "can_delete_corporate_location":true,
      "can_delete_image":true,
      "can_delete_physical_location":true,
      "can_delete_tag":true,
      "can_delete_where_tag":true,
      "can_edit_owner_comment":true,
      "can_see_bank_account_balance":true,
      "can_see_bank_account_bank_name":true,
      "can_see_bank_account_currency":true,
      "can_see_bank_account_iban":true,
      "can_see_bank_account_label":true,
      "can_see_bank_account_national_identifier":true,
      "can_see_bank_account_number":true,
      "can_see_bank_account_owners":true,
      "can_see_bank_account_swift_bic":true,
      "can_see_bank_account_type":true,
      "can_see_comments":true,
      "can_see_corporate_location":true,
      "can_see_image_url":true,
      "can_see_images":true,
      "can_see_more_info":true,
      "can_see_open_corporates_url":true,
      "can_see_other_account_bank_name":true,
      "can_see_other_account_iban":true,
      "can_see_other_account_kind":true,
      "can_see_other_account_metadata":true,
      "can_see_other_account_national_identifier":true,
      "can_see_other_account_number":true,
      "can_see_other_account_swift_bic":true,
      "can_see_owner_comment":true,
      "can_see_physical_location":true,
      "can_see_private_alias":true,
      "can_see_public_alias":true,
      "can_see_tags":true,
      "can_see_transaction_amount":true,
      "can_see_transaction_balance":true,
      "can_see_transaction_currency":true,
      "can_see_transaction_description":true,
      "can_see_transaction_finish_date":true,
      "can_see_transaction_metadata":true,
      "can_see_transaction_other_bank_account":true,
      "can_see_transaction_start_date":true,
      "can_see_transaction_this_bank_account":true,
      "can_see_transaction_type":true,
      "can_see_url":true,
      "can_see_where_tag":true
    }],
    "bank_id":"gh.29.uk"
  },
  "replacement":{
    "requested_date":"2017-09-19T00:00:00Z",
    "reason_requested":"RENEW"
  },
  "pin_reset":[{
    "requested_date":"2017-09-19T00:00:00Z",
    "reason_requested":"FORGOT"
  }],
  "collected":"2017-09-19T00:00:00Z",
  "posted":"2017-09-19T00:00:00Z",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
								
							

• CanCreateCardsForBank - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-10015: Allowed values are:
• OBP-50000: Unknown Error.

• obp.createPhysicalCard
• obp.getCustomerByCustomerId
• obp.checkBankAccountExists
• obp.getBankAccountsForUser

								
									
{
  "name":"OVERDRAFT_START_DATE",
  "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "attribute_type":"DOUBLE",
  "bank_id":{
    "value":"gh.29.uk"
  },
  "value":"2012-04-23",
  "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-10001: Incorrect json format.
• OBP-50000: Unknown Error.

• obp.createOrUpdateCardAttribute
• obp.getPhysicalCardForBank
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "bank_id":"gh.29.uk",
  "name":"SPECIAL_TAX_NUMBER",
  "category":"Card",
  "type":"STRING",
  "description":"description",
  "alias":"STRING",
  "can_be_seen_on_views":["bank"],
  "is_active":true
}
								
							

• CanCreateCardAttributeDefinitionAtOneBank - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-10001: Incorrect json format.
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

• obp.getBankAccountsForUser
• obp.getBank
• obp.createOrUpdateAttributeDefinition

								
									
{
  "jsonString":"{}"
}
								
							

• CanCreateCardsForBank - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-10015: Allowed values are:
• OBP-50000: Unknown Error.

• obp.deletePhysicalCardForBank
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "jsonString":"{}"
}
								
							

• CanDeleteCardAttributeDefinitionAtOneBank - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

• obp.getBankAccountsForUser
• obp.getBank
• obp.deleteAttributeDefinition

								
									
{
  "attributes":[{
    "attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "bank_id":"gh.29.uk",
    "name":"SPECIAL_TAX_NUMBER",
    "category":"Card",
    "type":"STRING",
    "description":"description",
    "alias":"STRING",
    "can_be_seen_on_views":["bank"],
    "is_active":true
  }]
}
								
							

• CanGetCardAttributeDefinitionAtOneBank - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

• obp.getBankAccountsForUser
• obp.getBank
• obp.getAttributeDefinition

								
									
{
  "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "bank_id":"gh.29.uk",
  "card_number":"364435172576215",
  "card_type":"Credit",
  "name_on_card":"SusanSmith",
  "issue_number":"1",
  "serial_number":"1324234",
  "valid_from_date":"2017-09-19T00:00:00Z",
  "expires_date":"2017-09-19T00:00:00Z",
  "enabled":true,
  "cancelled":true,
  "on_hot_list":true,
  "technology":"technologyString1",
  "networks":["networks1"],
  "allows":["credit","debit"],
  "account":{
    "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "label":"My Account",
    "views_available":[{
      "id":"owner",
      "name":"Owner",
      "description":"This view is for the owner for the account."
    }],
    "bank_id":"gh.29.uk"
  },
  "replacement":{
    "requested_date":"2017-09-19T00:00:00Z",
    "reason_requested":"RENEW"
  },
  "pin_reset":[{
    "requested_date":"2017-09-19T00:00:00Z",
    "reason_requested":"FORGOT"
  }],
  "collected":"2017-09-19T00:00:00Z",
  "posted":"2017-09-19T00:00:00Z",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "card_attributes":[{
    "name":"OVERDRAFT_START_DATE",
    "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
    "attribute_type":"STRING",
    "bank_id":{
      "value":"gh.29.uk"
    },
    "value":"2012-04-23",
    "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.

• obp.getCardAttributesFromProvider
• obp.getPhysicalCardForBank
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "cards":[{
    "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
    "bank_id":"gh.29.uk",
    "card_number":"364435172576215",
    "card_type":"Credit",
    "name_on_card":"SusanSmith",
    "issue_number":"1",
    "serial_number":"1324234",
    "valid_from_date":"2017-09-19T00:00:00Z",
    "expires_date":"2017-09-19T00:00:00Z",
    "enabled":true,
    "cancelled":true,
    "on_hot_list":true,
    "technology":"technologyString1",
    "networks":["networks1"],
    "allows":["credit","debit"],
    "account":{
      "id":"123",
      "label":"OBP",
      "views_available":[{
        "id":"123",
        "short_name":"short_name",
        "description":"description",
        "is_public":true,
        "alias":"None",
        "hide_metadata_if_alias_used":true,
        "can_add_comment":true,
        "can_add_corporate_location":true,
        "can_add_image":true,
        "can_add_image_url":true,
        "can_add_more_info":true,
        "can_add_open_corporates_url":true,
        "can_add_physical_location":true,
        "can_add_private_alias":true,
        "can_add_public_alias":true,
        "can_add_tag":true,
        "can_add_url":true,
        "can_add_where_tag":true,
        "can_delete_comment":true,
        "can_delete_corporate_location":true,
        "can_delete_image":true,
        "can_delete_physical_location":true,
        "can_delete_tag":true,
        "can_delete_where_tag":true,
        "can_edit_owner_comment":true,
        "can_see_bank_account_balance":true,
        "can_see_bank_account_bank_name":true,
        "can_see_bank_account_currency":true,
        "can_see_bank_account_iban":true,
        "can_see_bank_account_label":true,
        "can_see_bank_account_national_identifier":true,
        "can_see_bank_account_number":true,
        "can_see_bank_account_owners":true,
        "can_see_bank_account_swift_bic":true,
        "can_see_bank_account_type":true,
        "can_see_comments":true,
        "can_see_corporate_location":true,
        "can_see_image_url":true,
        "can_see_images":true,
        "can_see_more_info":true,
        "can_see_open_corporates_url":true,
        "can_see_other_account_bank_name":true,
        "can_see_other_account_iban":true,
        "can_see_other_account_kind":true,
        "can_see_other_account_metadata":true,
        "can_see_other_account_national_identifier":true,
        "can_see_other_account_number":true,
        "can_see_other_account_swift_bic":true,
        "can_see_owner_comment":true,
        "can_see_physical_location":true,
        "can_see_private_alias":true,
        "can_see_public_alias":true,
        "can_see_tags":true,
        "can_see_transaction_amount":true,
        "can_see_transaction_balance":true,
        "can_see_transaction_currency":true,
        "can_see_transaction_description":true,
        "can_see_transaction_finish_date":true,
        "can_see_transaction_metadata":true,
        "can_see_transaction_other_bank_account":true,
        "can_see_transaction_start_date":true,
        "can_see_transaction_this_bank_account":true,
        "can_see_transaction_type":true,
        "can_see_url":true,
        "can_see_where_tag":true
      }],
      "bank_id":"gh.29.uk"
    },
    "replacement":{
      "requested_date":"2017-09-19T00:00:00Z",
      "reason_requested":"RENEW"
    },
    "pin_reset":[{
      "requested_date":"2017-09-19T00:00:00Z",
      "reason_requested":"FORGOT"
    }],
    "collected":"2017-09-19T00:00:00Z",
    "posted":"2017-09-19T00:00:00Z",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.

• obp.getPhysicalCardsForBank
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "cards":[{
    "bank_id":"gh.29.uk",
    "bank_card_number":"364435172576215",
    "name_on_card":"String",
    "issue_number":"1",
    "serial_number":"1324234",
    "valid_from_date":"2017-09-19T00:00:00Z",
    "expires_date":"2017-09-19T00:00:00Z",
    "enabled":true,
    "cancelled":true,
    "on_hot_list":true,
    "technology":"String",
    "networks":["String"],
    "allows":["String"],
    "account":{
      "id":"123",
      "label":"OBP",
      "views_available":[{
        "id":"123",
        "short_name":"short_name",
        "description":"description",
        "is_public":true,
        "alias":"None",
        "hide_metadata_if_alias_used":true,
        "can_add_comment":true,
        "can_add_corporate_location":true,
        "can_add_image":true,
        "can_add_image_url":true,
        "can_add_more_info":true,
        "can_add_open_corporates_url":true,
        "can_add_physical_location":true,
        "can_add_private_alias":true,
        "can_add_public_alias":true,
        "can_add_tag":true,
        "can_add_url":true,
        "can_add_where_tag":true,
        "can_delete_comment":true,
        "can_delete_corporate_location":true,
        "can_delete_image":true,
        "can_delete_physical_location":true,
        "can_delete_tag":true,
        "can_delete_where_tag":true,
        "can_edit_owner_comment":true,
        "can_see_bank_account_balance":true,
        "can_see_bank_account_bank_name":true,
        "can_see_bank_account_currency":true,
        "can_see_bank_account_iban":true,
        "can_see_bank_account_label":true,
        "can_see_bank_account_national_identifier":true,
        "can_see_bank_account_number":true,
        "can_see_bank_account_owners":true,
        "can_see_bank_account_swift_bic":true,
        "can_see_bank_account_type":true,
        "can_see_comments":true,
        "can_see_corporate_location":true,
        "can_see_image_url":true,
        "can_see_images":true,
        "can_see_more_info":true,
        "can_see_open_corporates_url":true,
        "can_see_other_account_bank_name":true,
        "can_see_other_account_iban":true,
        "can_see_other_account_kind":true,
        "can_see_other_account_metadata":true,
        "can_see_other_account_national_identifier":true,
        "can_see_other_account_number":true,
        "can_see_other_account_swift_bic":true,
        "can_see_owner_comment":true,
        "can_see_physical_location":true,
        "can_see_private_alias":true,
        "can_see_public_alias":true,
        "can_see_tags":true,
        "can_see_transaction_amount":true,
        "can_see_transaction_balance":true,
        "can_see_transaction_currency":true,
        "can_see_transaction_description":true,
        "can_see_transaction_finish_date":true,
        "can_see_transaction_metadata":true,
        "can_see_transaction_other_bank_account":true,
        "can_see_transaction_start_date":true,
        "can_see_transaction_this_bank_account":true,
        "can_see_transaction_type":true,
        "can_see_url":true,
        "can_see_where_tag":true
      }],
      "bank_id":"gh.29.uk"
    },
    "replacement":{
      "requested_date":"2017-09-19T00:00:00Z",
      "reason_requested":"RENEW"
    },
    "pin_reset":[{
      "requested_date":"2017-09-19T00:00:00Z",
      "reason_requested":"FORGOT"
    }],
    "collected":"2017-09-19T00:00:00Z",
    "posted":"2017-09-19T00:00:00Z"
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser

								
									
{
  "cards":[{
    "card_type":"5",
    "card_description":"good",
    "use_type":"3"
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-50212: Connector did not return the set of status of credit card.
• OBP-50000: Unknown Error.

• obp.getStatusOfCreditCardOrder
• obp.checkBankAccountExists
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "bank_id":"gh.29.uk",
  "card_number":"364435172576215",
  "card_type":"Credit",
  "name_on_card":"SusanSmith",
  "issue_number":"1",
  "serial_number":"1324234",
  "valid_from_date":"2017-09-19T00:00:00Z",
  "expires_date":"2017-09-19T00:00:00Z",
  "enabled":true,
  "cancelled":true,
  "on_hot_list":true,
  "technology":"technologyString1",
  "networks":["networks1"],
  "allows":["credit","debit"],
  "account":{
    "id":"123",
    "label":"OBP",
    "views_available":[{
      "id":"123",
      "short_name":"short_name",
      "description":"description",
      "is_public":true,
      "alias":"None",
      "hide_metadata_if_alias_used":true,
      "can_add_comment":true,
      "can_add_corporate_location":true,
      "can_add_image":true,
      "can_add_image_url":true,
      "can_add_more_info":true,
      "can_add_open_corporates_url":true,
      "can_add_physical_location":true,
      "can_add_private_alias":true,
      "can_add_public_alias":true,
      "can_add_tag":true,
      "can_add_url":true,
      "can_add_where_tag":true,
      "can_delete_comment":true,
      "can_delete_corporate_location":true,
      "can_delete_image":true,
      "can_delete_physical_location":true,
      "can_delete_tag":true,
      "can_delete_where_tag":true,
      "can_edit_owner_comment":true,
      "can_see_bank_account_balance":true,
      "can_see_bank_account_bank_name":true,
      "can_see_bank_account_currency":true,
      "can_see_bank_account_iban":true,
      "can_see_bank_account_label":true,
      "can_see_bank_account_national_identifier":true,
      "can_see_bank_account_number":true,
      "can_see_bank_account_owners":true,
      "can_see_bank_account_swift_bic":true,
      "can_see_bank_account_type":true,
      "can_see_comments":true,
      "can_see_corporate_location":true,
      "can_see_image_url":true,
      "can_see_images":true,
      "can_see_more_info":true,
      "can_see_open_corporates_url":true,
      "can_see_other_account_bank_name":true,
      "can_see_other_account_iban":true,
      "can_see_other_account_kind":true,
      "can_see_other_account_metadata":true,
      "can_see_other_account_national_identifier":true,
      "can_see_other_account_number":true,
      "can_see_other_account_swift_bic":true,
      "can_see_owner_comment":true,
      "can_see_physical_location":true,
      "can_see_private_alias":true,
      "can_see_public_alias":true,
      "can_see_tags":true,
      "can_see_transaction_amount":true,
      "can_see_transaction_balance":true,
      "can_see_transaction_currency":true,
      "can_see_transaction_description":true,
      "can_see_transaction_finish_date":true,
      "can_see_transaction_metadata":true,
      "can_see_transaction_other_bank_account":true,
      "can_see_transaction_start_date":true,
      "can_see_transaction_this_bank_account":true,
      "can_see_transaction_type":true,
      "can_see_url":true,
      "can_see_where_tag":true
    }],
    "bank_id":"gh.29.uk"
  },
  "replacement":{
    "requested_date":"2017-09-19T00:00:00Z",
    "reason_requested":"RENEW"
  },
  "pin_reset":[{
    "requested_date":"2017-09-19T00:00:00Z",
    "reason_requested":"FORGOT"
  }],
  "collected":"2017-09-19T00:00:00Z",
  "posted":"2017-09-19T00:00:00Z",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
								
							

• CanCreateCardsForBank - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-10015: Allowed values are:
• OBP-50000: Unknown Error.

• obp.updatePhysicalCard
• obp.getCustomerByCustomerId
• obp.getPhysicalCardForBank
• obp.checkBankAccountExists
• obp.getBankAccountsForUser

								
									
{
  "name":"OVERDRAFT_START_DATE",
  "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "attribute_type":"DOUBLE",
  "bank_id":{
    "value":"gh.29.uk"
  },
  "value":"2012-04-23",
  "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-10001: Incorrect json format.
• OBP-50000: Unknown Error.

• obp.createOrUpdateCardAttribute
• obp.getCardAttributeById
• obp.getPhysicalCardForBank
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "name":"CounterpartyName",
  "description":"My landlord",
  "currency":"EUR",
  "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "this_bank_id":"gh.29.uk",
  "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "this_view_id":"owner",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "other_bank_routing_scheme":"OBP",
  "other_bank_routing_address":"gh.29.uk",
  "other_branch_routing_scheme":"OBP",
  "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_routing_scheme":"OBP",
  "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_secondary_routing_scheme":"IBAN",
  "other_account_secondary_routing_address":"DE89370400440532013000",
  "is_beneficiary":true,
  "bespoke":[{
    "key":"englishName",
    "value":"english Name"
  }],
  "metadata":{
    "public_alias":"String",
    "more_info":"String",
    "url":"String",
    "image_url":"String",
    "open_corporates_url":"String",
    "corporate_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "physical_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "private_alias":"String"
  }
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
• OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
• OBP-10001: Incorrect json format.
• OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-30014: Counterparty already exists. Please specify a different value for BANK_ID or ACCOUNT_ID or VIEW_ID or NAME.
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser
• obp.getBank
• obp.checkBankAccountExists
• obp.checkCounterpartyExists

								
									
{
  "name":"CounterpartyName",
  "description":"My landlord",
  "currency":"EUR",
  "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "this_bank_id":"gh.29.uk",
  "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "this_view_id":"owner",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "other_bank_routing_scheme":"OBP",
  "other_bank_routing_address":"gh.29.uk",
  "other_branch_routing_scheme":"OBP",
  "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_routing_scheme":"OBP",
  "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_secondary_routing_scheme":"IBAN",
  "other_account_secondary_routing_address":"DE89370400440532013000",
  "is_beneficiary":true,
  "bespoke":[{
    "key":"englishName",
    "value":"english Name"
  }],
  "metadata":{
    "public_alias":"String",
    "more_info":"String",
    "url":"String",
    "image_url":"String",
    "open_corporates_url":"String",
    "corporate_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "physical_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "private_alias":"String"
  }
}
								
							

• CanCreateCounterparty - Please login to request this Role
• CanCreateCounterpartyAtAnyBank - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
• OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-30014: Counterparty already exists. Please specify a different value for BANK_ID or ACCOUNT_ID or VIEW_ID or NAME.
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

• obp.getBankAccountsForUser
• obp.getBank
• obp.checkBankAccountExists
• obp.checkCounterpartyExists

								
									
{
  "counterparties":[{
    "name":"CounterpartyName",
    "description":"My landlord",
    "currency":"EUR",
    "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "this_bank_id":"gh.29.uk",
    "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "this_view_id":"owner",
    "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "other_bank_routing_scheme":"OBP",
    "other_bank_routing_address":"gh.29.uk",
    "other_branch_routing_scheme":"OBP",
    "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
    "other_account_routing_scheme":"OBP",
    "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
    "other_account_secondary_routing_scheme":"IBAN",
    "other_account_secondary_routing_address":"DE89370400440532013000",
    "is_beneficiary":true,
    "bespoke":[{
      "key":"englishName",
      "value":"english Name"
    }]
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-30022: The current view does not have the permission:
• OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser
• obp.checkBankAccountExists
• obp.getCounterparties

								
									
{
  "name":"CounterpartyName",
  "description":"My landlord",
  "currency":"EUR",
  "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "this_bank_id":"gh.29.uk",
  "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "this_view_id":"owner",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "other_bank_routing_scheme":"OBP",
  "other_bank_routing_address":"gh.29.uk",
  "other_branch_routing_scheme":"OBP",
  "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_routing_scheme":"OBP",
  "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_secondary_routing_scheme":"IBAN",
  "other_account_secondary_routing_address":"DE89370400440532013000",
  "is_beneficiary":true,
  "bespoke":[{
    "key":"englishName",
    "value":"english Name"
  }],
  "metadata":{
    "public_alias":"String",
    "more_info":"String",
    "url":"String",
    "image_url":"String",
    "open_corporates_url":"String",
    "corporate_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "physical_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "private_alias":"String"
  }
}
								
							

• CanGetCounterpartyAtAnyBank - Please login to request this Role
• CanGetCounterparty - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
• OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

• obp.getBankAccountsForUser
• obp.getBank
• obp.checkBankAccountExists
• obp.checkCounterpartyExists

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "holder":{
    "name":"OBP",
    "is_alias":true
  },
  "bank_routing":{
    "scheme":"Bank_ID",
    "address":"gh.29.uk"
  },
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "metadata":{
    "public_alias":"NONE",
    "private_alias":"NONE",
    "more_info":"www.openbankproject.com",
    "URL":"www.openbankproject.com",
    "image_URL":"www.openbankproject.com",
    "open_corporates_URL":"www.openbankproject.com",
    "corporate_location":{
      "latitude":1.231,
      "longitude":1.231,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"http://127.0.0.1:8080",
        "display_name":"OBP"
      }
    },
    "physical_location":{
      "latitude":1.231,
      "longitude":1.231,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"http://127.0.0.1:8080",
        "display_name":"OBP"
      }
    }
  }
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-50200: Connector cannot return the data we requested.
• OBP-50000: Unknown Error.

• obp.checkBankAccountExists
• obp.getBankAccountsForUser

								
									
{
  "other_accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "holder":{
      "name":"OBP",
      "is_alias":true
    },
    "bank_routing":{
      "scheme":"Bank_ID",
      "address":"gh.29.uk"
    },
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "metadata":{
      "public_alias":"NONE",
      "private_alias":"NONE",
      "more_info":"www.openbankproject.com",
      "URL":"www.openbankproject.com",
      "image_URL":"www.openbankproject.com",
      "open_corporates_URL":"www.openbankproject.com",
      "corporate_location":{
        "latitude":1.231,
        "longitude":1.231,
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"http://127.0.0.1:8080",
          "display_name":"OBP"
        }
      },
      "physical_location":{
        "latitude":1.231,
        "longitude":1.231,
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"http://127.0.0.1:8080",
          "display_name":"OBP"
        }
      }
    }
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-50200: Connector cannot return the data we requested.
• OBP-50000: Unknown Error.

• obp.checkBankAccountExists
• obp.getBankAccountsForUser

								
									
{
  "direct_debit_id":"aa0533bd-eb22-4bff-af75-d45240361b05",
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "date_signed":"2021-04-19T15:43:07Z",
  "date_starts":"2021-04-19T15:43:07Z",
  "date_expires":"2021-04-19T15:43:07Z",
  "date_cancelled":"2021-04-19T15:43:07Z",
  "active":true
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-30022: The current view does not have the permission:
• OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
• OBP-10001: Incorrect json format.
• OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
• OBP-20057: User not found by userId.
• OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser
• obp.getBank
• obp.checkBankAccountExists
• obp.createDirectDebit
• obp.getCounterpartyByCounterpartyId
• obp.getCustomerByCustomerId

								
									
{
  "direct_debit_id":"aa0533bd-eb22-4bff-af75-d45240361b05",
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "date_signed":"2021-04-19T15:43:07Z",
  "date_starts":"2021-04-19T15:43:07Z",
  "date_expires":"2021-04-19T15:43:07Z",
  "date_cancelled":"2021-04-19T15:43:07Z",
  "active":true
}
								
							

• CanCreateDirectDebitAtOneBank - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-30022: The current view does not have the permission:
• OBP-10001: Incorrect json format.
• OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
• OBP-20057: User not found by userId.
• OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

• obp.getBankAccountsForUser
• obp.getBank
• obp.checkBankAccountExists
• obp.createDirectDebit
• obp.getCounterpartyByCounterpartyId
• obp.getCustomerByCustomerId

								
									
{
  "standing_order_id":"aa0533bd-eb22-4bff-af75-d45240361b05",
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "amount":{
    "currency":"EUR",
    "amount":"0"
  },
  "when":{
    "frequency":"WEEKLY",
    "detail":"FIRST_DAY"
  },
  "date_signed":"2021-04-19T15:43:07Z",
  "date_starts":"2021-04-19T15:43:07Z",
  "date_expires":"2021-04-19T15:43:07Z",
  "date_cancelled":"2021-04-19T15:43:07Z",
  "active":true
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-30022: The current view does not have the permission:
• OBP-10001: Incorrect json format.
• OBP-10002: Invalid Number. Could not convert value to a number.
• OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
• OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
• OBP-20057: User not found by userId.
• OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
• OBP-50000: Unknown Error.

• obp.getBankAccountsForUser
• obp.getBank
• obp.checkBankAccountExists
• obp.createStandingOrder
• obp.getCounterpartyByCounterpartyId
• obp.getCustomerByCustomerId

								
									
{
  "standing_order_id":"aa0533bd-eb22-4bff-af75-d45240361b05",
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "amount":{
    "currency":"EUR",
    "amount":"0"
  },
  "when":{
    "frequency":"WEEKLY",
    "detail":"FIRST_DAY"
  },
  "date_signed":"2021-04-19T15:43:07Z",
  "date_starts":"2021-04-19T15:43:07Z",
  "date_expires":"2021-04-19T15:43:07Z",
  "date_cancelled":"2021-04-19T15:43:07Z",
  "active":true
}
								
							

• CanCreateStandingOrderAtOneBank - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-30022: The current view does not have the permission:
• OBP-10001: Incorrect json format.
• OBP-10002: Invalid Number. Could not convert value to a number.
• OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
• OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
• OBP-20057: User not found by userId.
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

• obp.getBankAccountsForUser
• obp.getBank
• obp.checkBankAccountExists
• obp.createStandingOrder
• obp.getCounterpartyByCounterpartyId
• obp.getCustomerByCustomerId

								
									
{
  "transactions":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "this_account":{
      "id":"String",
      "bank_routing":{
        "scheme":"Bank_ID",
        "address":"gh.29.uk"
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }],
      "holders":[{
        "name":"OBP",
        "is_alias":true
      }]
    },
    "other_account":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "holder":{
        "name":"OBP",
        "is_alias":true
      },
      "bank_routing":{
        "scheme":"Bank_ID",
        "address":"gh.29.uk"
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }]
    },
    "details":{
      "type":"AC",
      "description":"OBP",
      "posted":"2017-09-19T00:00:00Z",
      "completed":"2017-09-19T00:00:00Z",
      "new_balance":{
        "currency":"EUR",
        "amount":"0"
      },
      "value":{
        "currency":"EUR",
        "amount":"0"
      }
    },
    "transaction_attributes":[{
      "transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "name":"HOUSE_RENT",
      "type":"DATE_WITH_DAY",
      "value":"123456789"
    }]
  }]
}
								
							

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC!
• OBP-10024: wrong value for obp_offset parameter. Please send a positive integer (=>0)!
• OBP-10025: wrong value for obp_limit parameter. Please send a positive integer (=>1)!
• OBP-10026: Failed to parse date string. Please use this format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'!
• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-50000: Unknown Error.

• obp.getTransactionAttributes
• obp.getTransactionsCore
• obp.checkBankAccountExists
• obp.getBank
• obp.getBankAccountsForUser