# Primer

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

---

## Certified payment options

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

See the Primer [Postman collection](https://www.postman.com/primerio/primer-docs/request/q78ahm0/create-a-payment) 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 a card<br>- Void |

---

## Before you start

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

### 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 Primer.io 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 integration

In your Primer.io dashboard:

1. Select _Integrations_ > _New integration_.
2. Search for _Checkout.com_, and select _Connect_.
3. Configure your account details:
    1. Under _Account_, enter your merchant trading name.
    2. Under _Secret key_, enter the private API key you generated in the Dashboard, prefixed with Bearer. For example, `Bearer <SECRET_KEY>`.
    3. Under _Processing channel ID_, enter the ID of the processing channel you want to use for Primer.io.

---

## Configure webhooks

Checkout.com communicates status updates for your payments through webhooks. To configure your Primer.io endpoint to receive webhooks:

1. Sign in to the [Dashboard](https://dashboard.checkout.com).
2. Select _Developers_ in the left navigation bar and open the _Webhooks_ tab.
3. Select _Create configuration_.
4. Add a name for your webhook.
5. In the _Endpoint URL_ field, enter one of the following URLs depending on the environment you want to configure:
    - Sandbox – `https://api.sandbox.primer.io/callbacks/checkout?api_key={YOUR_PRIMER_API_KEY}`
    - Production – `https://api.primer.io/callbacks/checkout?api_key={YOUR_PRIMER_API_KEY}`
6. Under _Events_, select all the event checkboxes.
7. Under _Entities and processing channels_, select _All entities and processing channels_.
8. Select _Create webhook_.