Skip to main content
The Co-operative Bank and smile
Register
Register

CBPI (Card-Based Payment Instrument) APIs

Providing a Card-Based Payment Instrument (CBPI) means providing a virtual card or e-wallet which is linked to a customer’s payment account. Customers must explicitly give permission for the CBPII to set up funds-checks functionality and give permission again each time they wish to use the card or e-wallet.

CBPI documentation
CBPI specifications
CBPI endpoints and errors

CBPI specifications

Here is information on where our implementation of CBPI (Card-Based Payment Instrument) APIs deviates from the Open Banking specifications.

Below you can read about:

Payment accounts
Fields
Consent
General specifications

Payment accounts

We support current accounts and credit cards for CBPI APIs.

Back to the top

Fields

Only the below Identification schemes are accepted by the Bank:

  • UK.OBIE.PAN
  • UK.OBIE.SortCodeAccountNumber

Back to the top

Consent

As part of the CBPI consent process, you will redirect the PSU (customer) to The Co-operative Bank or smile login page, where they can authenticate themselves using our Online Banking services or Mobile App. They will then be able to provide consent after which they will be re-directed back to the AISP.

Then the PSU will see screens showing:

  • The account number sent by the TPP for the confirmation of funds
  • The expiry date for the consent the TPP has provided, if no expiry date is supplied by the PSU/TPP this will display as 'Ongoing'
  • The information about the consent related to confirmation of funds
  • The option to either click ‘Continue’ or ‘Cancel’ buttons.

Back to the top

General specifications

To read about settings and specifications which apply to all of our APIs, see our general specifications.

Back to the top