# Gr4vy

To integrate with Gr4vy, you must first set up and test your integration in the sandbox environment, and then move your integration to the production environment.

---

## Certified payment options

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

For examples of each use case, see our [Postman collection](https://www.postman.com/checkoutdotcom/workspace/gr4vy-checkout-com).

| Payment option | Supported actions |
| --- | --- |
| - Card payments<br>- Apple Pay<br>- Google Pay | - Authorize<br>- Authorize with 3DS<br>- Authorize with dynamic descriptors<br>- Capture<br>- MOTO Authorization<br>- Partial Authorization<br>- Partial capture<br>- Partial and multiple refund<br>- Recurring authorization<br>- Refund<br>- Unscheduled authorization<br>- Verify card<br>- Void |
| - Card payouts | - Online gambling |

Additionally, you can create and delete [payment instruments](https://www.checkout.com/docs/payments/store-and-manage-credentials/store-credentials/payment-instruments.md)

---

## Before you start

You must create a public and 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 [Gr4vy sandbox account](https://gr4vy.com/contact/).

### Create a public API key

1. Sign in to the sandbox environment in the [Dashboard](https://identity-sandbox.checkout.com/).
2. Select _Developers_ in the left navigation bar and open the _Keys_ tab.
3. Select _Create a new key_.
4. When you're prompted for which type of key to create, select _Public API key_.
5. Give the API key a description. This will help you identify what it's used for.
6. Disable the _Allow any processing channel_ setting.
7. Select one processing channel from the list.
8. Select _Submit_ to create the key.

Make a note of your public API key as you'll need it for a later step. You can view your public API key at any time after creation.

### Create a private API key

1. Sign in to the sandbox environment in the [Dashboard](https://identity-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. Give the API key a description. This will help you identify what it's used for.
6. Under _Scopes_, select _Default_.
7. Disable the _Allow any processing channel_ setting.
8. Select the processing channel you want to use for Gr4vy 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, you cannot view the private API key again after you've left the _Create a new key_ page. Ensure you copy its value securely before you exit or close the window.

---

## Configure the gateway integration

In your Gr4vy dashboard:

1. Create a new connection to Checkout.com.
2. Under _Credentials_, enter your the following credentials:
    - Public key
    - Private key, prefixed with Bearer. For example, `Bearer <SECRET_KEY>`.
    - Webhook secret key
    - Payouts funding account – if you will process payouts.
3. Add the Checkout.com connection to the _Card Transactions_ flow.

---

## Test your integration

For information on how to test your connection to Checkout.com, see the [Gr4vy API documentation](https://docs.gr4vy.com/reference/transactions/new-transaction).

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 Gr4vy, you need:
        - Key ID
        - Private key
        - Payment service ID
        - Gr4vy ID
    - From Checkout, you need:
        - Processing channel

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

---

## Move your integration to the production environment

To move your integration to Production, you must:

1. Follow the create a public and private key instructions in Checkout.com's production environment.
2. Configure Gr4vy gateway integration using the new public and private keys.