-
Card
-
Create Card
-
Create Card Attribute
-
Create or Update Card Attribute Definition
-
Delete Card
-
Delete Card Attribute Definition
-
Get Card Attribute Definition
-
Get Card By Id
-
Get Cards for the specified bank
-
Get cards for the current user
-
Get status of Credit Card order
-
Update Card
-
Update Card Attribute
-
Create Card
v5.1.0 filtered by tag: Card (12 APIs)
Create Card
Create Card at bank specified by BANK_ID .
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
allows: [credit,debit,cash_withdrawal]
brand: Visa
card_number: 364435172576215
card_type: Credit
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
enabled: false
expires_date: 2021-01-27
issue_number: 1
name_on_card: SusanSmith
requested_date: 2020-01-27
serial_number: 1324234
technology: technology1
valid_from_date: 2020-01-27
collected: 2020-01-27
posted: 2020-01-27
JSON response body fields:
allows: [credit,debit,cash_withdrawal]
bank_id: gh.29.uk
brand: Visa
can_add_image_url: false
can_add_more_info: false
can_add_tag: false
can_delete_corporate_location: false
can_delete_image: false
can_delete_where_tag: false
can_edit_owner_comment: false
can_see_bank_account_bank_name: false
can_see_bank_account_currency:
can_see_bank_account_label: false
can_see_bank_account_national_identifier:
can_see_bank_account_number: false
can_see_bank_account_owners: false
can_see_bank_account_swift_bic:
can_see_corporate_location: false
can_see_image_url: false
can_see_images: false
can_see_other_account_bank_name:
can_see_other_account_metadata:
can_see_other_account_national_identifier: false
can_see_other_account_number: false
can_see_other_account_swift_bic: false
can_see_transaction_amount: false
can_see_transaction_description: false
can_see_transaction_finish_date:
can_see_transaction_other_bank_account:
can_see_transaction_start_date:
can_see_transaction_this_bank_account:
can_see_url: false
can_see_where_tag: false
cancelled: false
card_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
card_number: 364435172576215
card_type: Credit
collected: 2020-01-27
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
cvv: 123
description: Description of the object. Maximum length is 2000. It can be any characters here.
enabled: false
expires_date: 2021-01-27
hide_metadata_if_alias_used: false
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_public: false
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
technology: technology1
valid_from_date: 2020-01-27
{
"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":"1100-01-01T00:00:00Z",
"expires_date":"1100-01-01T00:00:00Z",
"enabled":true,
"cancelled":true,
"on_hot_list":true,
"technology":"technology1",
"networks":[""],
"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":"1100-01-01T00:00:00Z",
"reason_requested":"RENEW"
},
"pin_reset":[{
"requested_date":"1100-01-01T00:00:00Z",
"reason_requested":"FORGOT"
}],
"collected":"1100-01-01T00:00:00Z",
"posted":"1100-01-01T00:00:00Z",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"cvv":"123",
"brand":"Visa"
}
-
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-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20006: User is missing one or more roles:
- OBP-10015: Allowed values are:
- OBP-50000: Unknown Error.
Create Card Attribute
Create Card Attribute
Card Attributes are used to describe a financial Product with a list of typed key value pairs.
Each Card Attribute is linked to its Card by CARD_ID
The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
CARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
JSON request body fields:
name: ACCOUNT_MANAGEMENT_FEE
type:
value: 5987953
JSON response body fields:
name: ACCOUNT_MANAGEMENT_FEE
value: 5987953
{
"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.
Create or Update Card Attribute Definition
Create or Update Card Attribute Definition
The category field must be Card
The type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
bank_id: gh.29.uk
can_be_seen_on_views: false
description: Description of the object. Maximum length is 2000. It can be any characters here.
is_active: false
name: ACCOUNT_MANAGEMENT_FEE
type:
{
"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:
Delete Card
-
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.
Delete Card Attribute Definition
Delete Card Attribute Definition by ATTRIBUTE_DEFINITION_ID
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
-
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:
Get Card Attribute Definition
Get Card Attribute Definition
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
attributes: attribute value in form of (name, value)
bank_id: gh.29.uk
can_be_seen_on_views: false
description: Description of the object. Maximum length is 2000. It can be any characters here.
is_active: false
name: ACCOUNT_MANAGEMENT_FEE
type:
{
"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:
Get Card By Id
This will the datails of the card.
It shows the account infomation which linked the the card.
Also shows the card attributes of the card.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
CARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
JSON response body fields:
allows: [credit,debit,cash_withdrawal]
bank_id: gh.29.uk
cancelled: false
card_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
card_number: 364435172576215
card_type: Credit
collected: 2020-01-27
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
description: Description of the object. Maximum length is 2000. It can be any characters here.
enabled: false
expires_date: 2021-01-27
id: d8839721-ad8f-45dd-9f78-2080414b93f9
issue_number: 1
label: My Account
name: ACCOUNT_MANAGEMENT_FEE
name_on_card: SusanSmith
on_hot_list: false
posted: 2020-01-27
requested_date: 2020-01-27
serial_number: 1324234
technology: technology1
valid_from_date: 2020-01-27
value: 5987953
{
"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":"1100-01-01T00:00:00Z",
"expires_date":"1100-01-01T00: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":"1100-01-01T00:00:00Z",
"reason_requested":"RENEW"
},
"pin_reset":[{
"requested_date":"1100-01-01T00:00:00Z",
"reason_requested":"FORGOT"
}],
"collected":"1100-01-01T00:00:00Z",
"posted":"1100-01-01T00: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"
}]
}
-
CanGetCardsForBank
- 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:
Get Cards for the specified bank
Should be able to filter on the following fields
eg:/management/banks/BANK_ID/cards?customer_id=66214b8e-259e-44ad-8868-3eb47be70646&account_id=8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0
1 customer_id should be valid customer_id, otherwise, it will return an empty card list.
2 account_id should be valid account_id , otherwise, it will return an empty card list.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
allows: [credit,debit,cash_withdrawal]
bank_id: gh.29.uk
can_add_image_url: false
can_add_more_info: false
can_add_tag: false
can_delete_corporate_location: false
can_delete_image: false
can_delete_where_tag: false
can_edit_owner_comment: false
can_see_bank_account_bank_name: false
can_see_bank_account_currency:
can_see_bank_account_label: false
can_see_bank_account_national_identifier:
can_see_bank_account_number: false
can_see_bank_account_owners: false
can_see_bank_account_swift_bic:
can_see_corporate_location: false
can_see_image_url: false
can_see_images: false
can_see_other_account_bank_name:
can_see_other_account_metadata:
can_see_other_account_national_identifier: false
can_see_other_account_number: false
can_see_other_account_swift_bic: false
can_see_transaction_amount: false
can_see_transaction_description: false
can_see_transaction_finish_date:
can_see_transaction_other_bank_account:
can_see_transaction_start_date:
can_see_transaction_this_bank_account:
can_see_url: false
can_see_where_tag: false
cancelled: false
card_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
card_number: 364435172576215
card_type: Credit
collected: 2020-01-27
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
description: Description of the object. Maximum length is 2000. It can be any characters here.
enabled: false
expires_date: 2021-01-27
hide_metadata_if_alias_used: false
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_public: false
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
technology: technology1
valid_from_date: 2020-01-27
{
"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":"1100-01-01T00:00:00Z",
"expires_date":"1100-01-01T00: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":"1100-01-01T00:00:00Z",
"reason_requested":"RENEW"
},
"pin_reset":[{
"requested_date":"1100-01-01T00:00:00Z",
"reason_requested":"FORGOT"
}],
"collected":"1100-01-01T00:00:00Z",
"posted":"1100-01-01T00: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.
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:
allows: [credit,debit,cash_withdrawal]
bank_card_number: 364435172576215
bank_id: gh.29.uk
can_add_image_url: false
can_add_more_info: false
can_add_tag: false
can_delete_corporate_location: false
can_delete_image: false
can_delete_where_tag: false
can_edit_owner_comment: false
can_see_bank_account_bank_name: false
can_see_bank_account_currency:
can_see_bank_account_label: false
can_see_bank_account_national_identifier:
can_see_bank_account_number: false
can_see_bank_account_owners: false
can_see_bank_account_swift_bic:
can_see_corporate_location: false
can_see_image_url: false
can_see_images: false
can_see_other_account_bank_name:
can_see_other_account_metadata:
can_see_other_account_national_identifier: false
can_see_other_account_number: false
can_see_other_account_swift_bic: false
can_see_transaction_amount: false
can_see_transaction_description: false
can_see_transaction_finish_date:
can_see_transaction_other_bank_account:
can_see_transaction_start_date:
can_see_transaction_this_bank_account:
can_see_url: false
can_see_where_tag: false
cancelled: false
collected: 2020-01-27
description: Description of the object. Maximum length is 2000. It can be any characters here.
enabled: false
expires_date: 2021-01-27
hide_metadata_if_alias_used: false
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_public: false
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
technology: technology1
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":"1100-01-01T00:00:00Z",
"expires_date":"1100-01-01T00: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":"1100-01-01T00:00:00Z",
"reason_requested":"RENEW"
},
"pin_reset":[{
"requested_date":"1100-01-01T00:00:00Z",
"reason_requested":"FORGOT"
}],
"collected":"1100-01-01T00:00:00Z",
"posted":"1100-01-01T00:00:00Z"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get status of Credit Card order
Get status of Credit Card orders
Get all orders
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON response body fields:
card_type: Credit
{
"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.
Update Card
Update Card at bank specified by CARD_ID .
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
CARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
JSON response body fields:
allows: [credit,debit,cash_withdrawal]
bank_id: gh.29.uk
can_add_image_url: false
can_add_more_info: false
can_add_tag: false
can_delete_corporate_location: false
can_delete_image: false
can_delete_where_tag: false
can_edit_owner_comment: false
can_see_bank_account_bank_name: false
can_see_bank_account_currency:
can_see_bank_account_label: false
can_see_bank_account_national_identifier:
can_see_bank_account_number: false
can_see_bank_account_owners: false
can_see_bank_account_swift_bic:
can_see_corporate_location: false
can_see_image_url: false
can_see_images: false
can_see_other_account_bank_name:
can_see_other_account_metadata:
can_see_other_account_national_identifier: false
can_see_other_account_number: false
can_see_other_account_swift_bic: false
can_see_transaction_amount: false
can_see_transaction_description: false
can_see_transaction_finish_date:
can_see_transaction_other_bank_account:
can_see_transaction_start_date:
can_see_transaction_this_bank_account:
can_see_url: false
can_see_where_tag: false
cancelled: false
card_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
card_number: 364435172576215
card_type: Credit
collected: 2020-01-27
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
description: Description of the object. Maximum length is 2000. It can be any characters here.
enabled: false
expires_date: 2021-01-27
hide_metadata_if_alias_used: false
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_public: false
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
technology: technology1
valid_from_date: 2020-01-27
{
"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":"1100-01-01T00:00:00Z",
"expires_date":"1100-01-01T00: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":"1100-01-01T00:00:00Z",
"reason_requested":"RENEW"
},
"pin_reset":[{
"requested_date":"1100-01-01T00:00:00Z",
"reason_requested":"FORGOT"
}],
"collected":"1100-01-01T00:00:00Z",
"posted":"1100-01-01T00:00:00Z",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
-
CanUpdateCardsForBank
- 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.
Update Card Attribute
Update Card Attribute
Card Attributes are used to describe a financial Product with a list of typed key value pairs.
Each Card Attribute is linked to its Card by CARD_ID
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
CARD_ATTRIBUTE_ID: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
CARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
JSON response body fields:
name: ACCOUNT_MANAGEMENT_FEE
value: 5987953
{
"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.