API Explorer

⯆

API Explorer

My Collections

API
- The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeably
  More...
- Get API Info (root)
Account
- The thing that tokens of value (money) come in and out of. An account has one or more `owners` which
  More...
- Create View
- Get access for specific user
- Get account by id
- Get accounts at all banks (Private, inc views)
- Get accounts at bank (Private)
- Get private accounts at all banks (Authenticated access)
- Get private accounts at one bank
- Get public accounts at all banks (Anonymous access)
- Update Account Label
- Update View
Account Public
- Get public accounts at one bank (Anonymous access)
Bank
- A Bank (aka Space) represents a financial institution, brand or organizational unit under which res
  More...
- Get Bank
- Get Bank ATMS
- Get Bank Products
- Get Banks
Branch
- Get Bank Branches
Card
Counterparty
Counterparty Metadata
Customer
- The legal entity that has the relationship to the bank. Customers are linked to Users via `User Cus
  More...
- Add a customer
- Get CRM Events
- Get customer for logged in user
Customer Message
Documentation
Transaction
- Records of successful movements of money from / to an `Account`. OBP Transactions don't contain any
  More...
- Get Other Account of Transaction
- Get Transaction by Id
- Get Transactions for Account (Full)
Transaction Metadata
Transaction Request
View Custom

Log off

v1.4.0 (87 APIs)

API Host: https://api3.openbankproject.com

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_add_image_url: true
can_add_more_info: true
can_add_tag: true
can_delete_corporate_location: true
can_delete_image: true
can_delete_where_tag: true
can_edit_owner_comment: true
can_see_bank_account_bank_name: true
can_see_bank_account_label: true
can_see_bank_account_number: true
can_see_bank_account_owners: true
can_see_corporate_location: true
can_see_image_url: true
can_see_images: true
can_see_other_account_national_identifier: true
can_see_other_account_number: true
can_see_other_account_swift_bic: true
can_see_transaction_amount: true
can_see_transaction_description: true
can_see_url: true
can_see_where_tag: true
cancelled: true
collected: 2020-01-27
description: This an optional field. Maximum length is 2000. It can be any characters here.
enabled: true
expires_date: 2021-01-27
is_public: true
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

Typical Successful Response

								
									{
  "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"
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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

Connector Methods:

Version: OBPv1.3.0, function_name: by getCards, operation_id: OBPv1.3.0-getCards Tags: Card,

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_add_image_url: true
can_add_more_info: true
can_add_tag: true
can_delete_corporate_location: true
can_delete_image: true
can_delete_where_tag: true
can_edit_owner_comment: true
can_see_bank_account_bank_name: true
can_see_bank_account_label: true
can_see_bank_account_number: true
can_see_bank_account_owners: true
can_see_corporate_location: true
can_see_image_url: true
can_see_images: true
can_see_other_account_national_identifier: true
can_see_other_account_number: true
can_see_other_account_swift_bic: true
can_see_transaction_amount: true
can_see_transaction_description: true
can_see_url: true
can_see_where_tag: true
cancelled: true
collected: 2020-01-27
description: This an optional field. Maximum length is 2000. It can be any characters here.
enabled: true
expires_date: 2021-01-27
is_public: true
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

Typical Successful Response

								
									{
  "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"
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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.

Connector Methods:

Version: OBPv1.3.0, function_name: by getCardsForBank, operation_id: OBPv1.3.0-getCardsForBank Tags: Card,

Get documentation about the selected endpoints as:

Resource Docs JSON
Swagger 2 JSON
中文版本
Partial Functions

Note: You can list just the APIs that are implemented in a certain version by appending &native=true to the index URL.
API_Explorer Commit

Featured APIs

API Explorer

v1.4.0 (87 APIs)

Get cards for the current user

Get cards for the specified bank