> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/checkout.com.md).

# Checkout.com

Request and manage Checkout.com payments, including capture, refund, void, and payment-detail lookups.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector                       | Authentication |
| ------------------------------- | -------------- |
| Checkout.com (Secret API Key)   | Secret API Key |
| Checkout.com (OAuth Access Key) | Credentials    |

#### Checkout.com (Secret API Key)

Connect a Checkout.com merchant account with a secret API key, environment, and account prefix to request and manage payments and payment webhooks.

**Set up in Checkout.com**

1. Prepare the Checkout.com account or service that the workflow will access. Grant access to the required resources and operations.
2. **Account Prefix:** The eight-character prefix in your Checkout.com API base URL: the first eight characters of your client ID after cli\_, under Dashboard Settings > Account structure.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Checkout.com (Secret API Key)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field  | Required | What to enter                                                                                                                                                                                                                                                       |
| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Environment    | Yes      | The Checkout.com environment these credentials belong to: sandbox or production. Credentials are not interchangeable between environments.                                                                                                                          |
| Account Prefix | Yes      | The eight-character prefix in your Checkout.com API base URL: the first eight characters of your client ID after cli\_, under Dashboard Settings > Account structure. [Provider instructions](https://www.checkout.com/docs/developer-resources/api/api-endpoints). |
| Secret API Key | Yes      | A Checkout.com secret API key for server-to-server payments. Use a sandbox key with the sandbox environment and a live key with production. [Provider instructions](https://api-reference.checkout.com/).                                                           |

#### Checkout.com (OAuth Access Key)

Connect a Checkout.com merchant account with its OAuth access-key ID and secret, environment, and account prefix. StackAI mints and caches short-lived access tokens.

**Set up in Checkout.com**

1. Prepare the Checkout.com account or service that the workflow will access. Grant access to the required resources and operations.
2. **Account Prefix:** The eight-character prefix in your Checkout.com API base URL: the first eight characters of your client ID after cli\_, under Dashboard Settings > Account structure.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Checkout.com (OAuth Access Key)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field     | Required | What to enter                                                                                                                                                                                                                                                       |
| ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Environment       | Yes      | The Checkout.com environment these credentials belong to: sandbox or production. Credentials are not interchangeable between environments.                                                                                                                          |
| Account Prefix    | Yes      | The eight-character prefix in your Checkout.com API base URL: the first eight characters of your client ID after cli\_, under Dashboard Settings > Account structure. [Provider instructions](https://www.checkout.com/docs/developer-resources/api/api-endpoints). |
| Access Key ID     | Yes      | The access key ID used as the OAuth client\_id. [Provider instructions](https://api-reference.checkout.com/tag/Access/).                                                                                                                                            |
| Access Key Secret | Yes      | The access key secret used as the OAuth client\_secret. [Provider instructions](https://api-reference.checkout.com/tag/Access/).                                                                                                                                    |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Checkout.com** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Request a Payment

Authorize a tokenized card payment, with an option to capture it immediately.

**Required permissions:** `gateway`, `gateway:payment`.

**Inputs**

| Field                 | Type    | Required | Description                                                          |
| --------------------- | ------- | -------- | -------------------------------------------------------------------- |
| Payment Source        | string  | Yes      | Checkout.com token or reusable source to charge.                     |
| Amount                | integer | Yes      | Payment amount in the currency's smallest unit.                      |
| Currency              | string  | Yes      | Three-letter currency for the payment.                               |
| Reference             | string  | No       | Your order or transaction reference.                                 |
| Capture Immediately   | boolean | No       | Charge now instead of authorizing for later capture. Default: false. |
| Processing Channel ID | string  | No       | Processing channel to use when the account has more than one.        |
| Success URL           | string  | No       | Browser return URL after successful customer authentication.         |
| Failure URL           | string  | No       | Browser return URL after failed customer authentication.             |
| Idempotency Key       | string  | No       | Stable key that prevents an accidental duplicate payment.            |

**Outputs**

| Field               | Type    | Description                                                         |
| ------------------- | ------- | ------------------------------------------------------------------- |
| Payment ID          | string  | Checkout.com identifier for the payment.                            |
| Status              | string  | Current payment status.                                             |
| Approved            | boolean | Whether Checkout.com approved the payment.                          |
| Customer Action URL | string  | URL the customer must open when further authentication is required. |

#### Capture a Payment

Capture all or part of an authorized Checkout.com payment.

**Required permissions:** `gateway`, `gateway:payment-captures`.

**Inputs**

| Field                  | Type    | Required | Description                                                                     |
| ---------------------- | ------- | -------- | ------------------------------------------------------------------------------- |
| Payment ID             | string  | Yes      | Authorized payment to capture.                                                  |
| Amount                 | integer | No       | Amount to capture in the payment currency's smallest unit. Minimum: 0.          |
| Reference              | string  | No       | Your reference for this capture.                                                |
| Allow Further Captures | boolean | No       | Keep the remaining authorization available for another capture. Default: false. |
| Idempotency Key        | string  | No       | Stable key that prevents an accidental duplicate capture.                       |

**Outputs**

| Field      | Type    | Description                                                         |
| ---------- | ------- | ------------------------------------------------------------------- |
| Action ID  | string  | Checkout.com identifier for the capture action.                     |
| Payment ID | string  | Payment that received the capture request.                          |
| Accepted   | boolean | Whether Checkout.com accepted or had already completed the capture. |

#### Refund a Payment

Refund all or part of a captured Checkout.com payment.

**Required permissions:** `gateway`, `gateway:payment-refunds`.

**Inputs**

| Field           | Type    | Required | Description                                               |
| --------------- | ------- | -------- | --------------------------------------------------------- |
| Payment ID      | string  | Yes      | Captured payment to refund.                               |
| Amount          | integer | No       | Amount to refund in the payment currency's smallest unit. |
| Reference       | string  | No       | Your return or refund reference.                          |
| Idempotency Key | string  | No       | Stable key that prevents an accidental duplicate refund.  |

**Outputs**

| Field      | Type    | Description                                                        |
| ---------- | ------- | ------------------------------------------------------------------ |
| Action ID  | string  | Checkout.com identifier for the refund action.                     |
| Payment ID | string  | Payment that received the refund request.                          |
| Accepted   | boolean | Whether Checkout.com accepted or had already completed the refund. |

#### Void a Payment

Void an authorized Checkout.com payment before it is captured.

**Required permissions:** `gateway`, `gateway:payment-voids`.

**Inputs**

| Field           | Type    | Required | Description                                             |
| --------------- | ------- | -------- | ------------------------------------------------------- |
| Payment ID      | string  | Yes      | Authorized payment to void.                             |
| Amount          | integer | No       | Amount to void in the payment currency's smallest unit. |
| Reference       | string  | No       | Your cancellation reference.                            |
| Idempotency Key | string  | No       | Stable key that prevents an accidental duplicate void.  |

**Outputs**

| Field      | Type    | Description                                                      |
| ---------- | ------- | ---------------------------------------------------------------- |
| Action ID  | string  | Checkout.com identifier for the void action.                     |
| Payment ID | string  | Payment that received the void request.                          |
| Accepted   | boolean | Whether Checkout.com accepted or had already completed the void. |

#### Get Payment Details

Get a Checkout.com payment's status, balances, and reconciliation details.

**Required permissions:** `gateway`, `gateway:payment-details`.

**Inputs**

| Field                 | Type   | Required | Description                                          |
| --------------------- | ------ | -------- | ---------------------------------------------------- |
| Payment or Session ID | string | Yes      | Checkout.com payment or redirect-session identifier. |

**Outputs**

| Field                | Type    | Description                                                    |
| -------------------- | ------- | -------------------------------------------------------------- |
| Payment ID           | string  | Checkout.com identifier for the payment.                       |
| Status               | string  | Current payment status.                                        |
| Approved             | boolean | Whether the payment was approved.                              |
| Amount               | integer | Original payment amount in minor currency units.               |
| Currency             | string  | Payment currency.                                              |
| Amount Captured      | integer | Amount captured so far in minor currency units.                |
| Available to Capture | integer | Remaining amount available to capture in minor currency units. |
| Available to Refund  | integer | Remaining amount available to refund in minor currency units.  |
| Available to Void    | integer | Remaining amount available to void in minor currency units.    |
| Total Refunded       | integer | Amount refunded so far in minor currency units.                |
| Reference            | string  | Merchant reference attached to the payment.                    |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/checkout.com.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
