> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yapily.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Lloyds

## Links

* [Lloyds Banking Group Developer Portal](https://developer.lloydsbanking.com/)

## Scopes

* Open Data 🌐
* Account Information 🔒
* Payment Initiation 🔒
* VRP 🔒

## Live Environment

<Info>
  If you have completed the steps below for any of the other institutions in the Lloyds Banking Group (`halifax`, `bankofscotland`, `bankofscotlandbusiness`) then you can use their existing registration credentials and jump to Step 7 for both `lloyds` and `lloydsbusiness`.
</Info>

**Precondition**: To connect to live Open Banking entities, whether you are accessing account information or initiating payments, your business must have the right regulatory permissions as per the [Open Banking Guide](/tools-and-services/open-banking/enrolment-guide).

1. Upload your transport and signing certificates (PEMs) created in the Open Banking directory, along with the keys into Yapily's [certificate vault](https://console.yapily.com/#!certificates).

2. Add **Lloyds** from the **Live** tab to your Dashboard application and add your `Signing key Id`, which can be obtained from the Open Banking Directory.

3. Select your Open Banking transport and signing certificates from the relevant drop-downs lists then click *Next*.

4. Click the 'download the SSA' button to download your Software Statement Assertion from the Open Banking Directory. This is the token that the Open Banking UK institutions will use during registration to verify your enrolment and possibly create your application.

5. Log in to the developer portal: [https://developer.lloydsbanking.com](https://developer.lloydsbanking.com/)

6. Create an app using the SSA to get *`Client ID`* and *`Client secret`*

7. Copy the credentials for this app from the Lloyds developer portal into the credentials view for Lloyds in the Yapily dashboard. Add the obtained *`Client ID`* as **Key** and the *`Client secret`* as **Secret**. Click 'Next' to save.

## Payments

### Bulk Payments

* Domestic payments and Scheduled Payments are supported
* Maximum 25 payments per request
* Minimum total payments amount is £0.01 (1p)
* Maximum total payments amount would be determined by the account limits on the specific accounts being used.
* The property `requestedExecutionDateTime` is not supported for this bank
* A reference for every payment is required
* One payer must be specified

## VRP Sweeping Access

In order to access the VRP endpoints we have to grant your Yapily application additional scopes. If you do not have these scopes then please contact your customer success manager to get them added.

> **The following steps are not intended for Yapily Connect customers**

Precondition: To use VRP on `lloyds` or `lloydsbusiness` a manual registration via API is required.

Pre-requisites for Manual registration:

* Valid OBWAC / OBSEAL certificates
* PIS registration details for `lloyds` or `lloydsbusiness`

<Info>
  You can use existing PIS registration details for this institution to gain VRP sweeping access. The registration details can be found on the Yapily Console for the given application. If a new registration is required (e.g. if you are using a new redirectUri for VRP and it is not covered in the existing registration) then you will have to manage your applications on the institution developer portal. Ensure that the application is subscribed to the latest API version on the institution portal. The existing or new registration credentials from the Yapily Console will be used in the steps below.
</Info>

### Steps Required for Manual registration

1. Upload the signing (OBSEAL) and transport (OBWAC) certificates if not already present

You can check if the certificate is present already by navigating to the Console -> Certificates. If absent please upload the certificate.

Once confirmed, we need the UUID of the certificate which can be found in the Console -> Certificates -> Certificate; the UUID will appear in the browser URL bar as follows:
`https://console.yapily.com/certificates/<UUID>`

Save the `UUID` and remember for which kind of key it corresponds to:
e.g. `SIGNING_KEY_UUID = d16f87d3-4222-4173-b8b9-44aeccacae7d`

Once you have done it for the signing key, repeat the process for your transport certificate.

2. Call the manual registration endpoint

The final step is to call the manual registration endpoint with the certificate UUIDs and credentials from your application created on the portal.

The `apiTypes` field in the example has both types but if the registration in question grants PIS access only then only provide `PISP`.

If a custom redirect URI (not Yapily's) is used for the registration then you can provide it in the `redirectUri` field.

The `clientId` field corresponds to the `key` field on the Yapily Console.

Request

```shell theme={null}
curl --location --request POST 'https://api.yapily.com/institutions/lloyds/manual/register' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Basic ...' \
     --data-raw '{
            "signingKeyID": "$SIGNING_KEY_UUID",
            "transportKeyID": "$TRANSPORT_KEY_UUID",
            "clientId": "$CLIENT_ID",
            "softwareStatementId": "$SSA_ID",
            "organisationId": "$ORGANISATION_ID",
            "apiTypes" : ["AISP", "PISP"],
            "redirectUri" : "<optional-redirect>"
            }'
```

Response

```shell theme={null}
{
"id": "a0460a91-4b4c-422a-bbe6-bebe0b92e308"
}
```

This is the Yapily registration `id` which can be used to Get, Modify, Delete the registration.

## Sandbox Environment

To connect to the Lloyds Sandbox, select *Lloyds Sandbox* from the pre-configured institutions.

Or if you like to register with your own credentials, please follow the steps below:

1. Upload your transport and signing certificates (PEMs) created in the Open Banking directory, along with the keys into Yapily's [certificate vault](https://console.yapily.com/certificates).

2. Add **Lloyds Sandbox** from the **Sandbox** tab to your Dashboard application and add your `Signing key Id`, which can be obtained from the Open Banking Directory.

3. Select your Open Banking transport and signing certificates from the relevant drop-downs lists then click *Next*.

4. Click the 'download the SSA' button to download your Software Statement Assertion from the Open Banking Directory. This is the token that the Open Banking UK institutions will use during registration to verify your enrolment and possibly create your application.

5. For sandbox setup and registration instructions, see the [Lloyds Banking Group Sandbox Support Guide](https://developer.lloydsbanking.com/prod01/lbg/lbg-support#sandbox)

6. Create an app using the SSA you downloaded in the previous step to get *`Client ID`* and *`Client secret`*

7. Copy the credentials for this app from the Lloyds developer portal into the credentials view for Lloyds in the Yapily dashboard. Add the obtained *`Client ID`* as **Key** and the *`Client secret`* as **Secret**. Click 'Next' to save.

Note: Halifax Sandbox, MBNA Bank Sandbox and Lloyds are using the same Lloyds Banking Group API. If you have already register with one of the above institutions just copy the credentials (key and secret) to this one and you are ready to go.

## Support

If you require technical support with certificate management, please contact [Support](/resources/support).