Skip to navigation

Overview: Settings

View as Markdown

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:

SettingDescription
Company nameYour business name shown on invoices and checkout
LogoDisplayed on hosted pages, emails, and invoices
Primary colorBrand color used in checkout and portal
Support emailContact email shown to customers
Support URLLink to your help center or support page

Upload a high-resolution logo (at least 512x512px) for best results across all devices and email clients.

Custom domain

Serve checkout and the customer portal on your own subdomain (for example pay.yourcompany.com). You add two DNS records; PaymentKit does the rest, including issuing and installing the TLS certificate. There is nothing to download or upload.

A domain moves through four states: Pending → Verified → Active, or Failed if a step can’t complete. The dashboard shows the current state and the exact record to add at each step.

1

Add your domain

Go to Settings > Custom domains and enter the subdomain you want to use (for example pay.yourcompany.com). The domain starts as Pending.

2

Add the routing CNAME

The dashboard shows a CNAME record. In your DNS provider, point your subdomain at PaymentKit:

TypeHostValue
CNAMEpay.yourcompany.comapp.paymentkit.com

PaymentKit checks DNS on a schedule. When the record resolves, the domain becomes Verified — usually within an hour of the record propagating.

3

Add the certificate CNAME

Once the domain is Verified, the dashboard shows a second CNAME (a certificate-validation record). Add it the same way. This record proves you control the domain so a certificate can be issued for it.

4

PaymentKit issues the certificate

With the validation record in place, PaymentKit automatically requests a managed TLS certificate, waits for it to be issued, and installs it on your domain. No action is needed here. When it’s done, the domain becomes Active.

Once a domain is Active, your checkout and portal URLs use it instead of paymentkit.com, served over HTTPS.

Add both CNAME records and leave them in place. The routing record keeps traffic flowing to your domain, and the certificate record is checked when the certificate is renewed. Removing either one can take the domain out of service.

DNS changes can take time to propagate. If a record isn’t found yet, the domain stays on its current step and PaymentKit retries automatically — you don’t need to re-add anything. If a step can’t complete, the domain shows Failed with the reason; fix the named record and it retries on the next check.

Business details

Configure your business information for invoices and tax compliance:

FieldDescription
Business addressYour registered business address
Tax IDVAT, GST, or other tax identification number
Default currencyPrimary currency for new prices
Default timezoneUsed for reports and scheduled operations

Billing settings

Invoice settings

Configure default invoice behavior:

SettingDefaultDescription
Invoice numberingSequentialNumber format (e.g., INV-0001, INV-0002)
Invoice prefixINVPrefix for invoice numbers
Footer textEmptyCustom text shown at bottom of invoices
Payment termsDue immediatelyDefault days until payment is due

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).

The preview reflects your current invoice settings and brand settings — update those first, then regenerate the preview to see your changes.

This endpoint requires the Settings · View permission.

Dunning behavior

Configure what happens when payments fail:

BehaviorSubscriptionInvoiceDescription
Cancel and mark uncollectibleCancelledUncollectibleDefault - clean break
Cancel and keep openCancelledOpenPursue collection externally
Keep past due and mark uncollectiblePast DueUncollectibleMaintain service, write off debt
Keep past due and keep openPast DueOpenMaintain service, continue collection

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:

{
"invoice": {
"on_finalized": false,
"on_paid": false
},
"dunning": {
"failed_payment": false
},
"slack_enabled": true,
"slack_webhook_urls": [
"https://hooks.slack.com/services/T***/B***/***"
],
"slack_payment_succeeded": true,
"slack_payment_failed": true,
"email_enabled": true,
"emails_to_notify": ["ops@example.com"],
"email_payment_succeeded": false,
"email_payment_failed": true,
"email_config": {
"from_email": "billing@example.com",
"reply_to_email": "support@example.com",
"email_signature_name": "John Smith",
"email_signature_title": "Billing Department",
"cc_recipients": ["cc1@merchant.com"],
"bcc_recipients": ["bcc1@merchant.com"],
"primary_color": "#FF5733",
"background_color": "#E8E8E8",
"text_color": "#333333"
}
}

Slack webhook URLs are secrets. The GET response redacts each stored URL to a masked sentinel (https://hooks.slack.com/services/T***/B***/***) so it never exposes the raw URL. Use it only to display that webhooks are configured — never re-send a masked value back to the API.

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:

FieldTypeDescription
invoiceobjectInvoice notification toggles (on_finalized, on_paid; both boolean)
dunningobjectDunning notification toggles (failed_payment; boolean)
slack_enabledbooleanMaster switch for Slack notifications (default: false)
slack_webhook_urlsstring[]One or more Slack incoming webhook URLs to post to
slack_payment_succeededbooleanPost to Slack when a payment succeeds
slack_payment_failedbooleanPost to Slack when a payment fails
email_enabledbooleanMaster switch for team email notifications (default: false)
emails_to_notifystring[]Team email addresses that receive notifications
email_payment_succeededbooleanEmail your team when a payment succeeds
email_payment_failedbooleanEmail your team when a payment fails
email_configobjectEmail sender, signature, copy-recipient, and color settings (from_email, reply_to_email, email_signature_name, email_signature_title, cc_recipients, bcc_recipients, primary_color, background_color, text_color). To send from from_email, verify its domain.

Because GET returns masked webhook URLs, only include slack_webhook_urls in a PATCH when the user has actually entered or edited a URL. To keep existing webhooks unchanged, omit the field entirely. The API rejects any payload containing the redaction marker *** to prevent silently overwriting a real webhook with a masked placeholder.

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_..."

Send emails from your own domain

Verify your domain to send customer emails from your own address (for example, billing@example.com). Verification adds DNS records that let email providers trust mail sent from your domain.

Before you begin

  • You need access to the DNS settings of your domain.
  • Use an address on a domain you own. Free mail addresses (for example, gmail.com) cannot be verified. For these addresses, the field shows no badge and no Verify button.

Verify your domain

  1. Go to Settings > Communication, on the Email configuration tab.

  2. Enter your address in Send emails from and click Save. The field shows Needs verification.

  3. Click Verify. The Add and verify DNS records dialog lists three CNAME records. It also lists a DMARC record, which is optional (see below).

    The Add and verify DNS records dialog with three pending CNAME records

  4. Sign in to your DNS provider and add each CNAME record. Use the copy buttons to copy each host and value.

  5. Go back to the dialog and click Verify. When PaymentKit finds the records, the button changes to Continue.

  6. Click Continue to close the dialog. The field shows Verified.

    The Send emails from field with the Verified badge

DNS changes can take up to 48 hours. If PaymentKit does not find the records yet, it shows Not verified yet. Wait, then click Verify again. If you click Verify twice within 30 seconds, PaymentKit does not run a new check and asks you to wait.

Before your domain is verified

PaymentKit does not block your emails while your domain is not verified. It sends them from a PaymentKit address. Your business name stays as the sender name. If you set Receive replies to, replies go to that address. When your domain is verified, emails are sent from your address.

When you open the Notifications page, PaymentKit re-checks your domain, at most once an hour. If you remove the CNAME records, the field changes back to Needs verification.

[Optional] Add a DMARC record

Gmail and Yahoo require a DMARC record for bulk senders. Without one, your emails may go to spam. DMARC does not affect your domain verification.

If your domain has no DMARC record, the field shows a DMARC missing badge next to Verified.

Click the badge to open the Add and verify DNS records dialog. Open How to add a DMARC record and follow these steps:

  1. In your DNS provider, add a TXT record.
    • Host: _dmarc (some providers need the full name, for example _dmarc.example.com)
    • Value: v=DMARC1; p=none;
  2. Save the record.
  3. In the dialog, click Check again. PaymentKit shows DMARC record found or DMARC record not found yet.

The DMARC missing warning with the steps to add a DMARC record

p=none only monitors your mail. You can change it to p=quarantine or p=reject later.

Email settings

Email notifications

Configure which emails are sent to customers:

EmailDefaultDescription
Invoice createdEnabledWhen a new invoice is generated
Invoice paidEnabledPayment confirmation receipt
Payment failedEnabledNotification when payment fails
Subscription createdEnabledWelcome email for new subscriptions
Subscription cancelledEnabledConfirmation of cancellation
Trial endingEnabledReminder before trial period ends

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

Use template variables like {{customer_name}} and {{invoice_total}} to personalize emails.

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)

Available payment methods depend on your connected payment processors and their capabilities.

Checkout options

SettingDescription
Allow promotion codesLet customers enter discount codes
Collect billing addressRequire full billing address
Collect shipping addressRequire shipping address (for physical goods)
Terms and conditions URLLink to your terms (shown at checkout)

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

RolePermissions
OwnerFull access, can manage billing and delete account
AdminFull access except account deletion
DeveloperAPI keys, webhooks, and test mode
SupportRead-only access, can issue refunds
ViewerRead-only access

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

Always use separate API keys for test and production environments. Never share secret keys.

Webhooks

Configure webhook endpoints to receive event notifications:

Test mode

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

ModeDescription
Test modeUse test API keys, process test payments
Live modeUse live API keys, process real payments

Always test your integration thoroughly in test mode before going live. Test mode data is separate from live data.

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.

Archiving a sandbox account is a one-way operation — the sandbox cannot be un-archived or accessed again afterward.