# Recurly

To get started using the Checkout.com Recurly plugin, you must first set up and test your integration in the sandbox environment, and then move your integration to the production environment.

The plugin supports the following payment methods:

- Card payments
- Apple Pay
- Google Pay

---

## Before you start

Before you configure the plugin, create a public and secret API key in the Checkout.com Dashboard.

### Create a public API key

1. Sign in to the sandbox environment in the [Dashboard](https://dashboard.checkout.com/).
2. Select _Developers_ in the left navigation bar and open the _Keys_ tab.
3. Select _Create a new key_.
4. Under _Type of key_, select _Public API key_.
5. Give the API key a description. This helps you identify what it's used for.
6. Select _Create key_.
7. Copy your public API key. You'll need it to configure the plugin.

> **Information**
>
> You can view your public API key in the Dashboard at any time.

### Create a secret API key

1. Sign in to the sandbox environment in the [Dashboard](https://dashboard.checkout.com/).
2. Select _Developers_ in the left navigation bar and open the _Keys_ tab.
3. Select _Create a new key_.
4. Under _Type of key_, select _Secret API key_.
5. Give the API key a description. This helps you identify what it's used for.
6. Under _Scopes_, select _Default_.
7. Select _Create key_.
8. Copy your secret API key securely. You'll need it to configure the plugin.

> **Note**
>
> For security, you cannot view the secret API key again after you've left the _Create a new key_ page. Copy the value securely before you exit or close the window.

---

## Configure the plugin

### Configure the app settings

1. Sign in to your Recurly account.
2. Go to _Configuration_ > _Payment Gateways_ > _Add Payment Gateway_.
3. Select the Checkout.com gateway, and select _Edit_.
4. In the _API Public Key_ field, enter the public API key you created in the Dashboard sandbox environment.
5. In the _Processing Channel ID_ field, enter the processing channel ID for your business.
6. In the _API Secret Key_ field, enter the secret key you created in the Dashboard sandbox environment.

### Configure webhooks

To enable communication between Checkout.com and Recurly, you must set up webhooks:

1. Sign in to the [Dashboard](https://dashboard.checkout.com/) (sandbox environment).
2. Select _Developers_ > _Webhooks_, and then select _Create configuration_.
3. Enter a descriptive name for the webhook, for example, _Recurly integration_.
4. In the _Endpoint URL_ field, enter `https://callbacks.recurly.com/checkout/{{your-subdomain}}`.
5. Under _Events_, select the event types you want to receive.
   - To minimize future updates, select all events.
   - Include, at minimum, payment and dispute events.
6. If required, select specific entities and processing channels. If left blank, the webhook applies to the parent entity by default.
7. Copy and securely store the _Signature Key_ (Source Verification Key). You'll need it when configuring webhook verification in Recurly.
8. Select _Create webhook_ to complete the setup.

---

## Test your integration

1. In your Recurly account, go to _Configuration_ > _Payment Gateways_.
2. Select your Checkout.com integration, and then select _Options_ > _Test Configuration_ to confirm that Recurly can communicate with your Checkout.com account.

A confirmation appears if your credentials are correct.

---

## Move your integration to the production environment

1. Sign in to the production environment in the [Dashboard](https://dashboard.checkout.com/).
2. Follow the previous steps to [create a public API key](#create-a-public-api-key) and [create a secret API key](#create-a-secret-api-key).
3. Follow the previous steps to [configure webhooks](#configure-webhooks). Use the secret key you created as the signature key.

---

## Manage refund, return, and void transaction data

You can refund, return, or void an order from the Dashboard.

Recurly updates the status of the order automatically.