Skip to content

Recurly

Last updated: August 03, 2022

From setting up the integration to requesting your first test payment, learn how to get started with the Checkout.com integration with Recurly.


Supported features

  • Card payments
  • Automatic capture
  • Refund from the Recurly Admin Console
  • Invoice generation

Before you start

Create a test account

If you haven't already, create a test Checkout.com account.

Get your API keys

To set up the Recurly integration, you'll need 2 API keys: a secret key and a public key. You can create your secret and public keys in the Dashboard.

Send us your Recurly details

  1. Create a Recurly test account and sign in.
  2. In the Recurly Admin Console, go to Integrations > API Credentials, and make a note of your private API key.
  3. Go to Configuration > Site Settings to find your Recurly subdomain.
  4. Send your Recurly private API key and subdomain to our Sales team. We will then configure the Checkout.com payment gateway on your Recurly test account.

Set up the integration

  1. Once the payment gateway is set up, go to Configuration > Payment Gateways.
  2. In the top-right corner of the Checkout.com payment gateway, select Options > Edit Gateway.
  3. Enter the Checkout.com secret API key from your sandbox Dashboard account and select Update Payment Gateway.

That's it! You're ready to start testing card payments.


Test your integration

Follow these steps to test a cardholder-initiated transaction (CIT):

  1. Once the set up is complete, go to Configurations > Plans and create a new plan.
  2. In the newly created plan, under Hosted Payment Page, you can find the hosted page URL. This will be used for customer-initiated payments.
  3. Copy the URL and paste it into a new tab, or click View next to Hosted Payment Page.
  4. On the hosted payment page, enter the required contact and shipping details.
  5. Under Billing Information, enter the following card details:
    • Number: 4242 4242 4242 4242
    • Expiry date: any future date
    • CVV: 100
  6. Enter the billing address and select Subscribe. You'll be redirected to the subscription confirmation page.
  7. Go back to the Recurly Admin Console and go to Customers > Transactions. Your test transaction will be displayed there with a Success status, indicating that the payment was successfully captured.
  8. Go to Customers > Subscriptions to find the newly created subscription for this transaction.

Follow these steps to test a merchant-initiated transaction (MIT):

  1. Go to Customers > Accounts and create a new account.
  2. Select Add Billing Info and add the required billing details.
  3. Under Credit Card Information, enter the following card details:
    • Number: 4242 4242 4242 4242
    • Expiry date: any future date
    • CVV: 100
  4. Select Save Changes.
  5. Select Add Subscription.
  6. In the Subscription Details section, choose the plan you previously created.
  7. Select Add Subscription to save the subscription configuration.
  8. Go to Customers > Transactions. Your verification and payment transactions will be displayed there with a Success status, indicating that the payment was successfully captured.
  9. Go to Customers > Subscriptions to find the newly created subscription for this transaction.

Go live

If you're happy with the outcome of your testing and want to start taking payments right away, please contact our Sales team in order to move to a live account.