Configure your PaymentKit account settings to customize branding, billing behavior, notifications, and more.

Account settings

Access settings through the dashboard sidebar under Settings.

Brand & Identity

Customize how your business appears to customers:

Custom domain

Use your own domain for hosted pages:

1. Navigate to Settings > Custom Domain
2. Enter your desired subdomain (e.g., pay.yourcompany.com)
3. Add the provided DNS records to your domain
4. Wait for verification (usually within an hour)

Once configured, your checkout and portal URLs will use your custom domain instead of paymentkit.com.

Business details

Configure your business information for invoices and tax compliance:

Billing settings

Invoice settings

Configure default invoice behavior:

Preview an invoice PDF

Generate a sample invoice PDF that uses your account’s real invoice settings and branding (logo, address, tax IDs, footer) but with mock line-item data. Use it to iterate on invoice styling without issuing a real invoice.

$
curl -X POST https://app.paymentkit.com/api/accounts/{account_id}/invoice-pdf/preview \
>
  -H "Authorization: Bearer sk_live_..." \
>
  --output invoice-preview.pdf

The endpoint takes no request body and returns the PDF bytes directly (Content-Type: application/pdf, served inline as invoice-preview.pdf).

Dunning behavior

Configure what happens when payments fail:

Notification settings

Notification settings control the merchant-facing alerts your team receives about payment activity — both via Slack and via email to your own team (distinct from the customer-facing emails below). Configure them under Settings > Notifications or via the API.

Slack notifications

Send real-time alerts to your team’s Slack channels when payments succeed or fail. PaymentKit posts to one or more Slack incoming webhook URLs.

Get notification settings

$
curl https://app.paymentkit.com/api/accounts/{account_id}/notification-settings \
>
  -H "Authorization: Bearer sk_live_..."

Response:

1
{
2
  "invoice": {
3
    "on_finalized": false,
4
    "on_paid": false
5
  },
6
  "dunning": {
7
    "failed_payment": false
8
  },
9
  "slack_enabled": true,
10
  "slack_webhook_urls": [
11
    "https://hooks.slack.com/services/T***/B***/***"
12
  ],
13
  "slack_payment_succeeded": true,
14
  "slack_payment_failed": true,
15
  "email_enabled": true,
16
  "emails_to_notify": ["ops@example.com"],
17
  "email_payment_succeeded": false,
18
  "email_payment_failed": true,
19
  "email_config": {
20
    "from_email": "billing@example.com",
21
    "reply_to_email": "support@example.com",
22
    "email_signature_name": "John Smith",
23
    "email_signature_title": "Billing Department",
24
    "cc_recipients": ["cc1@merchant.com"],
25
    "bcc_recipients": ["bcc1@merchant.com"],
26
    "primary_color": "#FF5733",
27
    "background_color": "#E8E8E8",
28
    "text_color": "#333333"
29
  }
30
}

Update notification settings

Send only the fields you want to change. Omitted fields are left untouched.

$
curl -X PATCH https://app.paymentkit.com/api/accounts/{account_id}/notification-settings \
>
  -H "Authorization: Bearer sk_live_..." \
>
  -H "Content-Type: application/json" \
>
  -d '{
>
    "slack_enabled": true,
>
    "slack_webhook_urls": [
>
      "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
>
    ]
>
  }'

Settings fields:

Reset notification settings

Restore notification settings to their defaults with a DELETE. The response returns the reset (default) settings.

$
curl -X DELETE https://app.paymentkit.com/api/accounts/{account_id}/notification-settings \
>
  -H "Authorization: Bearer sk_live_..."

Email settings

Email notifications

Configure which emails are sent to customers:

Email templates

Customize the content of customer emails:

1. Navigate to Settings > Email Templates
2. Select the template to customize
3. Edit the subject line and body content
4. Preview and save changes

Checkout settings

Payment methods

Enable the payment methods available at checkout:

• Credit/debit cards - Visa, Mastercard, Amex, etc.
• Digital wallets - Apple Pay, Google Pay
• Bank payments - ACH, SEPA (where supported)
• Buy now, pay later - Klarna, Afterpay (where supported)

Checkout options

Team settings

Team members

Invite team members to access your PaymentKit account:

1. Navigate to Settings > Team
2. Click Invite Member
3. Enter their email and select a role
4. They’ll receive an invitation email

Roles and permissions

API settings

API keys

Manage your API keys:

• Create new keys - Generate secret and publishable keys
• Rotate keys - Create new keys while keeping old ones active
• Revoke keys - Immediately disable compromised keys

Webhooks

Configure webhook endpoints to receive event notifications:

Test mode

Toggle between test and live modes at the top of the dashboard:

Sandbox accounts

Sandbox accounts are isolated child accounts linked to a parent account, used to test integrations without touching live data. Manage them under Settings or via the API.

Creating and archiving sandbox accounts require a signed-in user — these endpoints reject API keys and return 400 with "API keys not supported for this endpoint". Use a user session token (not an sk_live_... API key) in the Authorization header for those two operations. Listing sandbox accounts accepts either a user session token or an API key.

List sandbox accounts

Returns a paginated response. Accepts an API key or a user session token.

$
curl https://app.paymentkit.com/api/accounts/{account_id}/sandbox-accounts \
>
  -H "Authorization: Bearer sk_live_..."

Create a sandbox account

Requires a signed-in user (API keys are rejected). The request body takes a required name and an optional description. Returns the created sandbox account object.

$
curl -X POST https://app.paymentkit.com/api/accounts/{account_id}/sandbox-accounts \
>
  -H "Authorization: Bearer <user_session_token>" \
>
  -H "Content-Type: application/json" \
>
  -d '{ "name": "QA sandbox", "description": "Integration testing" }'

Archive a sandbox account

Requires a signed-in user (API keys are rejected). Archiving hides a sandbox from the UI and blocks further access. The underlying data is preserved in the database, not deleted.

$
curl -X POST https://app.paymentkit.com/api/accounts/{account_id}/sandbox-accounts/{sandbox_id}/archive \
>
  -H "Authorization: Bearer <user_session_token>"

A successful archive returns 204 No Content.