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

Our APIs

Our APIs are designed to help you securely manage your connection with us. To allow you to do this, we provide a common interface through our RESTful API.

APIs overview
General specifications

Explore our APIs

Our APIs are available for both The Co-operative Bank and smile, and include:

Group_coop.svg
AIS (Account Information Service)

Can retrieve our customers’ account information and transaction data.

Our AIS APIs

credit-card_coop.svg
PIS (Payment Initiation Service)

Can set-up and submit payments on our customers’ behalf.

Our PIS APIs

Correct_coop.svg
CBPI (Card-Based Payment Instrument)

Can receive authorised confirmation of customers’ funds.

Our CBPI APIs

General specifications

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

AIS (Account Information Service) APIs

Providing an AIS means providing bank account information on behalf of a customer, such as their balance and transaction history. Customers must explicitly grant permission for the bank to allow an AISP access to this information.

Our AIS APIs are:

Account-access-consents

Retrieve and manage customers’ consent for account access

Accounts

Retrieve customers’ account information

Balances

Retrieve customers’ balance information

Transactions

Retrieve customers’ transaction details

Direct-debits

Retrieve customers’ Direct Debit details

Standing-orders

Retrieve customers’ standing order details

Scheduled-payments

Retrieve customers’ scheduled payment details

View all our AIS APIs

PIS (Payment Initiation Service) APIs

Providing a PIS means providing payment instruments and initiating payments directly from a customer’s bank account. Customers must explicitly grant permission for the PISP to connect to the bank system and debit the payment account.

Our PIS APIs are:

Domestic-payment-consents

Retrieve customers’ consent for domestic payment initiation

Domestic-payments

Initiate customers’ domestic payments

Domestic-scheduled-payment-consents

Retrieve customers’ consent for scheduled payment initiation

Domestic-scheduled-payments

Initiate customers’ scheduled payments

Domestic-standing order-consents

Retrieve customers’ consent for standing order initiation

Domestic-standing orders

Initiate customers’ standing orders

View all our PIS APIs

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 to check that they have the necessary funds available in their account each time they wish to make a payment using their virtual card or e-wallet, and give permission again each time they wish to make such a payment.

Our CBPI APIs are:

Funds-confirmation-consent

Retrieve and manage customers’ consent for confirmation of funds

Funds-confirmation

Retrieve confirmation of customers’ funds

View all our CBPI APIs