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, 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]; the accepted fields are mapped by CheckbookAuthType and sent by get_auth_header(). 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.

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 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(). 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() and get_webhook_source_verification_message().

The HMAC key is the Source verification key you configure, which the config names at [checkbook.connector_webhook_details]. The connector's own methods take the webhook secret unused, because supplying it is not their job: the shared verify_webhook_source() 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 and Checkbook transformers.