> For the complete documentation index, see [llms.txt](https://docs.hyperswitch.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyperswitch.io/integrations/connectors-integrations/payment-processor-capabilities/available-connectors/checkbook.md).

# Checkbook

Connect Checkbook through Hyperswitch.

Checkbook lets merchants receive ACH payments through a bank-transfer integration. The connector is in beta, and payment callbacks use a signed `signature` header that Checkbook provides with the webhook request.

To connect Checkbook to your Hyperswitch account, follow [Activate a connector on Hyperswitch](/integrations/connectors-integrations/activate-connector-on-hyperswitch.md), then return here for connector-specific behavior.

This connector is in beta status. Check with the Hyperswitch team before enabling it in production.

### Status and capabilities

**Integration status:** beta

**Category:** payment gateway

**Webhook flows:** payments

| Payment method | Type             | Mandates      | Refunds       | Capture methods | Countries | Currencies |
| -------------- | ---------------- | ------------- | ------------- | --------------- | --------- | ---------- |
| bank transfer  | ACH Direct Debit | not supported | not supported | automatic       | USA       | USD        |

### Authentication

Enter **Checkbook Publishable key** and **Checkbook API Secret key**. Checkbook combines them as `publishable_key:secret_key` for the `Authorization` header. The control-center labels are defined in [`[checkbook.connector_auth.BodyKey]`](https://github.com/juspay/hyperswitch/blob/ec9d1d22bf0257b7de4d4d8bbba4e27fd520bdf7/crates/connector_configs/toml/sandbox.toml#L1842-L1846); the accepted fields are mapped by [`CheckbookAuthType`](https://github.com/juspay/hyperswitch/blob/ec9d1d22bf0257b7de4d4d8bbba4e27fd520bdf7/crates/hyperswitch_connectors/src/connectors/checkbook/transformers.rs#L53-L69) and sent by [`get_auth_header()`](https://github.com/juspay/hyperswitch/blob/ec9d1d22bf0257b7de4d4d8bbba4e27fd520bdf7/crates/hyperswitch_connectors/src/connectors/checkbook.rs#L120-L136). The control center shows a third field, **Source verification key**. It is not an authentication credential, and `CheckbookAuthType` never sees it, but it is not unused either: it is the HMAC key for webhook verification. Set it if you take callbacks. See [Webhooks](#webhooks).

### Before you start

1. Create or sign in to your Checkbook account and obtain the **Checkbook Publishable key** and **Checkbook API Secret key**.
2. Sign in to the [Hyperswitch control center](https://app.hyperswitch.io/) and open Checkbook.
3. Enter those two credentials.
4. If you take webhooks, enter your Checkbook webhook secret in **Source verification key**. Callbacks fail verification without it.

No provider dashboard path beyond account setup was verified for this page.

### Webhooks

Checkbook maps the webhook status in the request body to a payment event through [`get_webhook_event_type()`](https://github.com/juspay/hyperswitch/blob/ec9d1d22bf0257b7de4d4d8bbba4e27fd520bdf7/crates/hyperswitch_connectors/src/connectors/checkbook.rs#L554-L567). It verifies the callback with HMAC-SHA256. The `signature` header carries a comma-separated `signature=<hex>` and `nonce=<value>`, and the signed message is the request body followed by that nonce. See [`get_webhook_source_verification_signature()`](https://github.com/juspay/hyperswitch/blob/ec9d1d22bf0257b7de4d4d8bbba4e27fd520bdf7/crates/hyperswitch_connectors/src/connectors/checkbook.rs#L587-L607) and [`get_webhook_source_verification_message()`](https://github.com/juspay/hyperswitch/blob/ec9d1d22bf0257b7de4d4d8bbba4e27fd520bdf7/crates/hyperswitch_connectors/src/connectors/checkbook.rs#L609-L628).

The HMAC key is the **Source verification key** you configure, which the config names at [`[checkbook.connector_webhook_details]`](https://github.com/juspay/hyperswitch/blob/ec9d1d22bf0257b7de4d4d8bbba4e27fd520bdf7/crates/connector_configs/toml/sandbox.toml#L1845-L1846). The connector's own methods take the webhook secret unused, because supplying it is not their job: the shared [`verify_webhook_source()`](https://github.com/juspay/hyperswitch/blob/ec9d1d22bf0257b7de4d4d8bbba4e27fd520bdf7/crates/hyperswitch_interfaces/src/webhooks.rs#L266-L302) passes `connector_webhook_secrets.secret` to the algorithm as the key. Leave the field blank and every callback fails verification.

### Source reference

Authentication and webhook behavior on this page is tied to Hyperswitch `ec9d1d22bf0257b7de4d4d8bbba4e27fd520bdf7`. See [Checkbook connector source](https://github.com/juspay/hyperswitch/blob/ec9d1d22bf0257b7de4d4d8bbba4e27fd520bdf7/crates/hyperswitch_connectors/src/connectors/checkbook.rs) and [Checkbook transformers](https://github.com/juspay/hyperswitch/blob/ec9d1d22bf0257b7de4d4d8bbba4e27fd520bdf7/crates/hyperswitch_connectors/src/connectors/checkbook/transformers.rs).


---

# 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.hyperswitch.io/integrations/connectors-integrations/payment-processor-capabilities/available-connectors/checkbook.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.