Recurly
Last updated: April 8, 2026
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 configure the plugin, create a public and secret API key in the Checkout.com Dashboard.
- Sign in to the sandbox environment in the Dashboard.
- Select the Developers icon in the top navigation bar and open the Keys tab.
- Select Create a new key.
- Under Type of key, select Public API key.
- Give the API key a description. This helps you identify what it's used for.
- Select Create key.
- 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.
- Sign in to the sandbox environment in the Dashboard.
- Select the Developers icon in the top navigation bar and open the Keys tab.
- Select Create a new key.
- Under Type of key, select Secret API key.
- Give the API key a description. This helps you identify what it's used for.
- Under Scopes, select Default.
- Select Create key.
- 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.
- Sign in to your Recurly account.
- Go to Configuration > Payment Gateways > Add Payment Gateway.
- Select the Checkout.com gateway, and select Edit.
- In the API Public Key field, enter the public API key you created in the Dashboard sandbox environment.
- In the Processing Channel ID field, enter the processing channel ID for your business.
- In the API Secret Key field, enter the secret key you created in the Dashboard sandbox environment.
To enable communication between Checkout.com and Recurly, you must set up webhooks:
- Sign in to the Dashboard (sandbox environment).
- Select Developers > Webhooks, and then select Create configuration.
- Enter a descriptive name for the webhook, for example, Recurly integration.
- In the Endpoint URL field, enter
https://callbacks.recurly.com/checkout/{{your-subdomain}}. - Under Events, select the event types you want to receive.
- To minimize future updates, select all events.
- Include, at minimum, payment and dispute events.
- If required, select specific entities and processing channels. If left blank, the webhook applies to the parent entity by default.
- Copy and securely store the Signature Key (Source Verification Key). You'll need it when configuring webhook verification in Recurly.
- Select Create webhook to complete the setup.
- In your Recurly account, go to Configuration > Payment Gateways.
- 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.
- Sign in to the production environment in the Dashboard.
- Follow the previous steps to create a public API key and create a secret API key.
- Follow the previous steps to configure webhooks. Use the secret key you created as the signature key.
You can refund, return, or void an order from the Dashboard.
Recurly updates the status of the order automatically.