openbankproject_client.card module

Card endpoints for the OpenBankProject API Client.

class openbankproject_client.card.CardEndpoints(client)[source]

Bases: object

Card-related API endpoints.

__init__(client)[source]

Initialize the endpoint group.

Parameters:

client – OpenBankProjectClient instance

create_card(bank_id: str, data: Dict) → Dict[source]

Create a new card.

Parameters:

  • bank_id – Bank identifier

  • data – Card data

Returns:

Dict containing created card information

get_card_by_id(bank_id: str, card_id: str) → Dict[source]

Get card by ID.

Parameters:

  • bank_id – Bank identifier

  • card_id – Card identifier

Returns:

Dict containing card information

get_cards_for_bank(bank_id: str) → Dict[source]

Get cards for the specified bank.

Parameters:

bank_id – Bank identifier

Returns:

Dict containing cards information

get_cards_for_current_user() → Dict[source]

Get cards for the current user.

Returns:

Dict containing user’s cards information

update_card(bank_id: str, card_id: str, data: Dict) → Dict[source]

Update an existing card.

Parameters:

  • bank_id – Bank identifier

  • card_id – Card identifier

  • data – Updated card data

Returns:

Dict containing updated card information

delete_card(bank_id: str, card_id: str) → Dict[source]

Delete a card.

Parameters:

  • bank_id – Bank identifier

  • card_id – Card identifier

Returns:

Dict containing deletion status

create_card_attribute(bank_id: str, card_id: str, data: Dict) → Dict[source]

Create a card attribute.

Parameters:

  • bank_id – Bank identifier

  • card_id – Card identifier

  • data – Attribute data

Returns:

Dict containing created attribute information

update_card_attribute(bank_id: str, card_id: str, attribute_id: str, data: Dict) → Dict[source]

Update a card attribute.

Parameters:

  • bank_id – Bank identifier

  • card_id – Card identifier

  • attribute_id – Attribute identifier

  • data – Updated attribute data

Returns:

Dict containing updated attribute information

get_card_attribute_definition(bank_id: str) → Dict[source]

Get card attribute definition.

Parameters:

bank_id – Bank identifier

Returns:

Dict containing card attribute definition

create_or_update_card_attribute_definition(bank_id: str, data: Dict) → Dict[source]

Create or update card attribute definition.

Parameters:

  • bank_id – Bank identifier

  • data – Attribute definition data

Returns:

Dict containing created or updated attribute definition

delete_card_attribute_definition(bank_id: str, attribute_definition_id: str) → Dict[source]

Delete card attribute definition.

Parameters:

  • bank_id – Bank identifier

  • attribute_definition_id – Attribute definition identifier

Returns:

Dict containing deletion status

get_credit_card_order_status(bank_id: str, account_id: str) → Dict[source]

Get status of Credit Card order.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

Returns:

Dict containing credit card order status