API Explorer
- API
- Account
- Account Public
- Bank
- Branch
- Card
- Counterparty
-
Counterparty Metadata
- Add Corporate Location to Counterparty
- Add Counterparty More Info
- Add Open Corporates URL to Counterparty
- Add image url to other bank account
- Add physical location to other bank account
- Add public alias to other bank account
- Add url to other bank account
- Create Other Account Private Alias
- Delete Counterparty Corporate Location
- Delete Counterparty Image URL
- Delete Counterparty Open Corporates URL
- Delete Counterparty Physical Location
- Delete Counterparty Private Alias
- Delete Counterparty Public Alias
- Delete more info of other bank account
- Delete url of other bank account
- Get Other Account Metadata
- Get Other Account Private Alias
- Get public alias of other bank account
- Update Counterparty Corporate Location
- Update Counterparty Image Url
- Update Counterparty More Info
- Update Counterparty Physical Location
- Update Counterparty Private Alias
- Update Open Corporates Url of Counterparty
- Update public alias of other bank account
- Update url of other bank account
- Customer
- Customer Meeting
- Customer Message
- Data Warehouse
- Documentation
- KYC
- Metric
- Person
- Role
- Transaction
- Transaction Metadata
- Transaction Request
- User
- View (Custom)
-
API
-
Account
- Create Account
- Create View
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts at Bank
- Get Accounts at Bank (Private)
- Get Accounts at all Banks (Private)
- Get all Accounts at all Banks
- Get private accounts at one bank
- Update Account Label
- Update View
-
Account Public
-
Bank
-
Branch
-
Card
-
Counterparty
-
Counterparty Metadata
- Add Corporate Location to Counterparty
- Add Counterparty More Info
- Add Open Corporates URL to Counterparty
- Add image url to other bank account
- Add physical location to other bank account
- Add public alias to other bank account
- Add url to other bank account
- Create Other Account Private Alias
- Delete Counterparty Corporate Location
- Delete Counterparty Image URL
- Delete Counterparty Open Corporates URL
- Delete Counterparty Physical Location
- Delete Counterparty Private Alias
- Delete Counterparty Public Alias
- Delete more info of other bank account
- Delete url of other bank account
- Get Other Account Metadata
- Get Other Account Private Alias
- Get public alias of other bank account
- Update Counterparty Corporate Location
- Update Counterparty Image Url
- Update Counterparty More Info
- Update Counterparty Physical Location
- Update Counterparty Private Alias
- Update Open Corporates Url of Counterparty
- Update public alias of other bank account
- Update url of other bank account
-
Customer
- Add Social Media Handle
- Create Customer
- Create User Customer Link
- Get CRM Events
- Get Customer Social Media Handles
- Get customer for logged in user
-
Customer Meeting
-
Customer Message
-
Data Warehouse
-
Documentation
-
KYC
- Add KYC Check
- Add KYC Document
- Add KYC Media
- Add KYC Status
- Get Customer KYC Checks
- Get Customer KYC Documents
- Get Customer KYC statuses
- Get KYC Media for a customer
-
Metric
-
Person
-
Role
-
Transaction
- Get Other Account of Transaction
- Get Transaction by Id
- Get Transactions for Account (Core)
- Get Transactions for Account (Full)
-
Transaction Metadata
- Add a tag
- Add an image
- Add comment
- Add narrative
- Add where tag
- Delete a tag
- Delete an image
- Delete comment
- Delete narrative
- Delete where tag
- Get comments
- Get images
- Get narrative
- Get tags
- Get where tag
- Update narrative
- Update where tag
-
Transaction Request
- Answer Transaction Request Challenge
- Create Transaction Request
- Get Transaction Request Types for Account
- Get Transaction Requests
-
User
-
View (Custom)
- Delete View
- Get Account access for User
- Get Views for Account
- Get access
- Grant User access to View
- Grant User access to a list of views
- Revoke access to all Views on Account
- Revoke access to one View
v2.0.0 (115 APIs)
Bank
Accounts
Views
Counterparties
Transactions
Get cards for the current user
Returns data about all the physical cards a user has been issued. These could be debit cards, credit cards, etc.
Authentication is Mandatory
JSON response body fields:
-
bank_card_number: 364435172576215
-
bank_id: gh.29.uk
-
can_see_images: true
-
cancelled: true
-
collected: 2020-01-27
-
enabled: true
-
expires_date: 2021-01-27
-
issue_number: 1
-
label: My Account
-
name_on_card: SusanSmith
-
on_hot_list: false
-
posted: 2020-01-27
-
requested_date: 2020-01-27
-
serial_number: 1324234
-
valid_from_date: 2020-01-27
{
"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"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get cards for the specified bank
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
-
bank_card_number: 364435172576215
-
bank_id: gh.29.uk
-
can_see_images: true
-
cancelled: true
-
collected: 2020-01-27
-
enabled: true
-
expires_date: 2021-01-27
-
issue_number: 1
-
label: My Account
-
name_on_card: SusanSmith
-
on_hot_list: false
-
posted: 2020-01-27
-
requested_date: 2020-01-27
-
serial_number: 1324234
-
valid_from_date: 2020-01-27
{
"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"
}]
}
- 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.