# Spreedly

You can use Checkout.com as a payment processor using Spreedly.

Spreedly is a [certified partner](https://developer.spreedly.com/docs/spreedly-one-certification) with Checkout.com.

---

## Certified payment options

Checkout.com has tested and verified the following actions for this payment method.

See our [Postman collection](https://www.postman.com/checkoutdotcom/spreedly-checkout-com) for examples of each use case.

| Payment option | Supported actions |
| --- | --- |
| - Card payments<br>- Apple Pay<br>- Google Pay | - Authorize<br>- Authorize account funding transactions (AFTs)<br>- Authorize with 3DS<br>- Authorize with dynamic descriptors<br>- Authorize with level 2 and 3 data<br>- Authorize with surcharge<br>- Capture<br>- Combined authorize and capture<br>- Partial and multiple capture<br>- Partial and multiple refund<br>- Recurring authorization<br>- Refund<br>- Unscheduled authorization<br>- Verify card<br>- Void |
| - Card payouts | - Money transfer<br>- Non-money transfer<br>- Online gambling |

---

## Before you start

You must set up your accounts with Checkout.com and Spreedly, and create a private key to configure the integration.

### Set up your accounts

1. Request a [test account](https://www.checkout.com/get-test-account) with Checkout.com.
2. Request a [Spreedly trial](https://www.spreedly.com/production-trial-access-request).

### Create a private API key

1. Sign in to the sandbox environment in the [Dashboard](https://dashboard.sandbox.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. Enter a description for the API key to help you identify what it's used for.
6. Under _Scopes_, select _Default_.
7. Turn off the _Allow any processing channel_ setting.
8. Select the processing channel you want to use for Spreedly payments from the list.
9. Select _Create key_.
10. Copy your private API key securely. You'll need it to configure the plugin.

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

---

## Configure the gateway integration

In your Spreedly dashboard:

1. Create a new connection to Checkout.com.
2. Under _authentication mode_, select:
    - _Default – To connect to Checkout.com using the private API key you generated in the Dashboard, prefixed with Bearer. For example, `Bearer <SECRET_KEY>`.
    - _OAuth_ – To connect using OAuth authentication
3. If you're connecting to the Checkout.com sandbox environment, select the _Sandbox_ checkbox.
4. Create a Composer Workflow to direct traffic to the Checkout.com connection.

> **Note**
>
> Some transactions like level 2 and 3 data do not work without a workflow.

---

## Test your integration

See the [Spreedly API documentation](https://docs.spreedly.com/reference/api/v1/#authentication) for testing your connection to Checkout.com.

Optionally, you can use our Postman collection to test payment actions.

### Test using Postman

1. Ensure you set up your Postman environment with the following data:
    - From Spreedly, you need:
        - Environment key
        - Environment access secret
        - Checkout.com gateway token
        - Workflow key
    - From Checkout.com, you need:
        - Processing channel
        - Currency account – if processing card payments

See the [Postman collection](https://www.postman.com/checkoutdotcom/workspace/spreedly-checkout-com) for the actions to test in sandbox.

---

## Move your integration to the production environment

To move your integration into production, generate a private key for your production environment and use those credentials.