# Knox

> Knox is a payments gateway with an API identical to Stripe's for the operations listed below. Use a Stripe SDK and point its API base URL at Knox.

## Integrate

- Base URL: https://api.knoxapi.com (local development: http://localhost:8000).
- Auth: `Authorization: Bearer sk_test_...` on the server. Publishable keys (`pk_test_...`) work only for tokens, payment methods, and retrieving or confirming PaymentIntents and SetupIntents with their client_secret.
- Requests are form-encoded with Stripe's bracket notation; responses, errors, pagination, and `Idempotency-Key` behave as in Stripe's API.
- API version: 2026-08-26.dahlia.
- Python: `stripe.StripeClient(key, base_addresses={"api": "https://api.knoxapi.com"})`. Node: `new Stripe(key, {host: "api.knoxapi.com"})`.
- Webhooks: signed with the `Stripe-Signature` header; verify with the Stripe SDK's webhook helper and the endpoint secret.
- Test mode only. Use Stripe test payment methods (`pm_card_visa`, `tok_visa`, `pm_card_chargeDeclined`) and never send real card numbers.
- Integrate one way only: server-side PaymentIntents, client-side confirmation with the client_secret, and webhooks for fulfillment.

## Reference

- Documentation: https://docs.knoxapi.com
- API reference: https://docs.knoxapi.com/api
- Payments dashboard login: https://dashboard.knoxapi.com/login
- Meta Knox is a separate routing product: https://meta.knoxapi.com/dashboard (login /dashboard/login).
- Meta control API base: https://meta.knoxapi.com/v1. Routing rules and gateways belong here, not on the Stripe API host.
- Meta requests use a server-side secret key. GET /v1/gateways, GET/POST /v1/routing_rules and /v1/traffic are control operations, not Stripe operations.
- OpenAPI document for exactly these operations: https://docs.knoxapi.com/openapi/knox.json

## Operations

### account
- GET /v1/account

### account_links
- POST /v1/account_links

### account_sessions
- POST /v1/account_sessions

### accounts
- DELETE /v1/accounts/{account}
- DELETE /v1/accounts/{account}/bank_accounts/{id}
- DELETE /v1/accounts/{account}/external_accounts/{id}
- DELETE /v1/accounts/{account}/people/{person}
- DELETE /v1/accounts/{account}/persons/{person}
- GET /v1/accounts
- GET /v1/accounts/{account}
- GET /v1/accounts/{account}/bank_accounts/{id}
- GET /v1/accounts/{account}/capabilities
- GET /v1/accounts/{account}/capabilities/{capability}
- GET /v1/accounts/{account}/external_accounts
- GET /v1/accounts/{account}/external_accounts/{id}
- GET /v1/accounts/{account}/people
- GET /v1/accounts/{account}/people/{person}
- GET /v1/accounts/{account}/persons
- GET /v1/accounts/{account}/persons/{person}
- POST /v1/accounts
- POST /v1/accounts/{account}
- POST /v1/accounts/{account}/bank_accounts
- POST /v1/accounts/{account}/bank_accounts/{id}
- POST /v1/accounts/{account}/capabilities/{capability}
- POST /v1/accounts/{account}/external_accounts
- POST /v1/accounts/{account}/external_accounts/{id}
- POST /v1/accounts/{account}/login_links
- POST /v1/accounts/{account}/people
- POST /v1/accounts/{account}/people/{person}
- POST /v1/accounts/{account}/persons
- POST /v1/accounts/{account}/persons/{person}
- POST /v1/accounts/{account}/reject
- POST /v1/accounts/{account}/unreject

### apple_pay
- DELETE /v1/apple_pay/domains/{domain}
- GET /v1/apple_pay/domains
- GET /v1/apple_pay/domains/{domain}
- POST /v1/apple_pay/domains

### apps
- GET /v1/apps/secrets
- GET /v1/apps/secrets/find
- POST /v1/apps/secrets
- POST /v1/apps/secrets/delete

### balance
- GET /v1/balance
- GET /v1/balance/history
- GET /v1/balance/history/{id}

### balance_settings
- GET /v1/balance_settings
- POST /v1/balance_settings

### balance_transactions
- GET /v1/balance_transactions
- GET /v1/balance_transactions/{id}

### billing
- GET /v1/billing/alerts
- GET /v1/billing/alerts/{id}
- GET /v1/billing/credit_balance_summary
- GET /v1/billing/credit_balance_transactions
- GET /v1/billing/credit_balance_transactions/{id}
- GET /v1/billing/credit_grants
- GET /v1/billing/credit_grants/{id}
- GET /v1/billing/feedback_options
- GET /v1/billing/feedback_options/{id}
- GET /v1/billing/meters
- GET /v1/billing/meters/{id}
- GET /v1/billing/meters/{id}/event_summaries
- POST /v1/billing/alerts
- POST /v1/billing/alerts/{id}/activate
- POST /v1/billing/alerts/{id}/archive
- POST /v1/billing/alerts/{id}/deactivate
- POST /v1/billing/credit_grants
- POST /v1/billing/credit_grants/{id}
- POST /v1/billing/credit_grants/{id}/expire
- POST /v1/billing/credit_grants/{id}/void
- POST /v1/billing/feedback_options
- POST /v1/billing/feedback_options/{id}
- POST /v1/billing/feedback_options/{id}/deactivate
- POST /v1/billing/meter_event_adjustments
- POST /v1/billing/meter_events
- POST /v1/billing/meters
- POST /v1/billing/meters/{id}
- POST /v1/billing/meters/{id}/deactivate
- POST /v1/billing/meters/{id}/reactivate

### billing_portal
- GET /v1/billing_portal/configurations
- GET /v1/billing_portal/configurations/{configuration}
- POST /v1/billing_portal/configurations
- POST /v1/billing_portal/configurations/{configuration}
- POST /v1/billing_portal/sessions

### charges
- GET /v1/charges
- GET /v1/charges/search
- GET /v1/charges/{charge}
- GET /v1/charges/{charge}/dispute
- GET /v1/charges/{charge}/refunds
- GET /v1/charges/{charge}/refunds/{refund}
- POST /v1/charges
- POST /v1/charges/{charge}
- POST /v1/charges/{charge}/capture
- POST /v1/charges/{charge}/dispute
- POST /v1/charges/{charge}/dispute/close
- POST /v1/charges/{charge}/refund
- POST /v1/charges/{charge}/refunds
- POST /v1/charges/{charge}/refunds/{refund}

### checkout
- GET /v1/checkout/sessions
- GET /v1/checkout/sessions/{session}
- GET /v1/checkout/sessions/{session}/line_items
- POST /v1/checkout/sessions
- POST /v1/checkout/sessions/{session}
- POST /v1/checkout/sessions/{session}/expire

### confirmation_tokens
- GET /v1/confirmation_tokens/{confirmation_token}

### country_specs
- GET /v1/country_specs
- GET /v1/country_specs/{country}

### coupons
- DELETE /v1/coupons/{coupon}
- GET /v1/coupons
- GET /v1/coupons/{coupon}
- POST /v1/coupons
- POST /v1/coupons/{coupon}

### credit_notes
- GET /v1/credit_notes
- GET /v1/credit_notes/preview
- GET /v1/credit_notes/preview/lines
- GET /v1/credit_notes/{credit_note}/lines
- GET /v1/credit_notes/{id}
- POST /v1/credit_notes
- POST /v1/credit_notes/{id}
- POST /v1/credit_notes/{id}/void

### customer_sessions
- POST /v1/customer_sessions

### customers
- DELETE /v1/customers/{customer}
- DELETE /v1/customers/{customer}/bank_accounts/{id}
- DELETE /v1/customers/{customer}/cards/{id}
- DELETE /v1/customers/{customer}/discount
- DELETE /v1/customers/{customer}/sources/{id}
- DELETE /v1/customers/{customer}/subscriptions/{subscription_exposed_id}
- DELETE /v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount
- DELETE /v1/customers/{customer}/tax_ids/{id}
- GET /v1/customers
- GET /v1/customers/search
- GET /v1/customers/{customer}
- GET /v1/customers/{customer}/balance_transactions
- GET /v1/customers/{customer}/balance_transactions/{transaction}
- GET /v1/customers/{customer}/bank_accounts
- GET /v1/customers/{customer}/bank_accounts/{id}
- GET /v1/customers/{customer}/cards
- GET /v1/customers/{customer}/cards/{id}
- GET /v1/customers/{customer}/cash_balance
- GET /v1/customers/{customer}/cash_balance_transactions
- GET /v1/customers/{customer}/cash_balance_transactions/{transaction}
- GET /v1/customers/{customer}/discount
- GET /v1/customers/{customer}/payment_methods
- GET /v1/customers/{customer}/payment_methods/{payment_method}
- GET /v1/customers/{customer}/sources
- GET /v1/customers/{customer}/sources/{id}
- GET /v1/customers/{customer}/subscriptions
- GET /v1/customers/{customer}/subscriptions/{subscription_exposed_id}
- GET /v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount
- GET /v1/customers/{customer}/tax_ids
- GET /v1/customers/{customer}/tax_ids/{id}
- POST /v1/customers
- POST /v1/customers/{customer}
- POST /v1/customers/{customer}/balance_transactions
- POST /v1/customers/{customer}/balance_transactions/{transaction}
- POST /v1/customers/{customer}/bank_accounts
- POST /v1/customers/{customer}/bank_accounts/{id}
- POST /v1/customers/{customer}/bank_accounts/{id}/verify
- POST /v1/customers/{customer}/cards
- POST /v1/customers/{customer}/cards/{id}
- POST /v1/customers/{customer}/cash_balance
- POST /v1/customers/{customer}/funding_instructions
- POST /v1/customers/{customer}/sources
- POST /v1/customers/{customer}/sources/{id}
- POST /v1/customers/{customer}/sources/{id}/verify
- POST /v1/customers/{customer}/subscriptions
- POST /v1/customers/{customer}/subscriptions/{subscription_exposed_id}
- POST /v1/customers/{customer}/tax_ids

### disputes
- GET /v1/disputes
- GET /v1/disputes/{dispute}
- POST /v1/disputes/{dispute}
- POST /v1/disputes/{dispute}/close

### entitlements
- GET /v1/entitlements/active_entitlements
- GET /v1/entitlements/active_entitlements/{id}
- GET /v1/entitlements/features
- GET /v1/entitlements/features/{id}
- POST /v1/entitlements/features
- POST /v1/entitlements/features/{id}

### ephemeral_keys
- DELETE /v1/ephemeral_keys/{key}
- POST /v1/ephemeral_keys

### events
- GET /v1/events
- GET /v1/events/{id}

### exchange_rates
- GET /v1/exchange_rates
- GET /v1/exchange_rates/{rate_id}

### external_accounts
- POST /v1/external_accounts/{id}

### file_links
- GET /v1/file_links
- GET /v1/file_links/{link}
- POST /v1/file_links
- POST /v1/file_links/{link}

### files
- GET /v1/files
- GET /v1/files/{file}
- POST /v1/files

### financial_connections
- GET /v1/financial_connections/accounts
- GET /v1/financial_connections/accounts/{account}
- GET /v1/financial_connections/accounts/{account}/owners
- GET /v1/financial_connections/sessions/{session}
- GET /v1/financial_connections/transactions
- GET /v1/financial_connections/transactions/{transaction}
- POST /v1/financial_connections/accounts/{account}/disconnect
- POST /v1/financial_connections/accounts/{account}/refresh
- POST /v1/financial_connections/accounts/{account}/subscribe
- POST /v1/financial_connections/accounts/{account}/unsubscribe
- POST /v1/financial_connections/sessions

### forwarding
- GET /v1/forwarding/requests
- GET /v1/forwarding/requests/{id}
- POST /v1/forwarding/requests

### identity
- GET /v1/identity/verification_reports
- GET /v1/identity/verification_reports/{report}
- GET /v1/identity/verification_sessions
- GET /v1/identity/verification_sessions/{session}
- POST /v1/identity/verification_sessions
- POST /v1/identity/verification_sessions/{session}
- POST /v1/identity/verification_sessions/{session}/cancel
- POST /v1/identity/verification_sessions/{session}/redact

### invoiceitems
- DELETE /v1/invoiceitems/{invoiceitem}
- GET /v1/invoiceitems
- GET /v1/invoiceitems/{invoiceitem}
- POST /v1/invoiceitems
- POST /v1/invoiceitems/{invoiceitem}

### invoices
- DELETE /v1/invoices/{invoice}
- GET /v1/invoices
- GET /v1/invoices/search
- GET /v1/invoices/{invoice}
- GET /v1/invoices/{invoice}/lines
- POST /v1/invoices
- POST /v1/invoices/create_preview
- POST /v1/invoices/{invoice}
- POST /v1/invoices/{invoice}/add_lines
- POST /v1/invoices/{invoice}/attach_payment
- POST /v1/invoices/{invoice}/finalize
- POST /v1/invoices/{invoice}/lines/{line_item_id}
- POST /v1/invoices/{invoice}/mark_uncollectible
- POST /v1/invoices/{invoice}/pay
- POST /v1/invoices/{invoice}/remove_lines
- POST /v1/invoices/{invoice}/send
- POST /v1/invoices/{invoice}/update_lines
- POST /v1/invoices/{invoice}/void

### linked_accounts
- GET /v1/linked_accounts
- GET /v1/linked_accounts/{account}
- GET /v1/linked_accounts/{account}/owners
- POST /v1/linked_accounts/{account}/disconnect
- POST /v1/linked_accounts/{account}/refresh

### mandates
- GET /v1/mandates/{mandate}

### payment_attempt_records
- GET /v1/payment_attempt_records
- GET /v1/payment_attempt_records/{id}

### payment_intents
- GET /v1/payment_intents
- GET /v1/payment_intents/search
- GET /v1/payment_intents/{intent}
- GET /v1/payment_intents/{intent}/amount_details_line_items
- POST /v1/payment_intents
- POST /v1/payment_intents/{intent}
- POST /v1/payment_intents/{intent}/cancel
- POST /v1/payment_intents/{intent}/capture
- POST /v1/payment_intents/{intent}/confirm
- POST /v1/payment_intents/{intent}/increment_authorization

### payment_links
- GET /v1/payment_links
- GET /v1/payment_links/{payment_link}
- GET /v1/payment_links/{payment_link}/line_items
- POST /v1/payment_links
- POST /v1/payment_links/{payment_link}

### payment_method_configurations
- GET /v1/payment_method_configurations
- GET /v1/payment_method_configurations/{configuration}
- POST /v1/payment_method_configurations
- POST /v1/payment_method_configurations/{configuration}

### payment_method_domains
- GET /v1/payment_method_domains
- GET /v1/payment_method_domains/{payment_method_domain}
- POST /v1/payment_method_domains
- POST /v1/payment_method_domains/{payment_method_domain}
- POST /v1/payment_method_domains/{payment_method_domain}/validate

### payment_methods
- GET /v1/payment_methods
- GET /v1/payment_methods/{payment_method}
- POST /v1/payment_methods
- POST /v1/payment_methods/{payment_method}
- POST /v1/payment_methods/{payment_method}/attach
- POST /v1/payment_methods/{payment_method}/detach

### payment_records
- GET /v1/payment_records
- GET /v1/payment_records/{id}
- POST /v1/payment_records/report_payment
- POST /v1/payment_records/{id}/report_payment_attempt
- POST /v1/payment_records/{id}/report_payment_attempt_canceled
- POST /v1/payment_records/{id}/report_payment_attempt_failed
- POST /v1/payment_records/{id}/report_payment_attempt_guaranteed
- POST /v1/payment_records/{id}/report_payment_attempt_informational
- POST /v1/payment_records/{id}/report_refund

### payouts
- GET /v1/payouts
- GET /v1/payouts/{payout}
- POST /v1/payouts
- POST /v1/payouts/{payout}
- POST /v1/payouts/{payout}/cancel
- POST /v1/payouts/{payout}/reverse

### plans
- DELETE /v1/plans/{plan}
- GET /v1/plans
- GET /v1/plans/{plan}
- POST /v1/plans
- POST /v1/plans/{plan}

### prices
- GET /v1/prices
- GET /v1/prices/search
- GET /v1/prices/{price}
- POST /v1/prices
- POST /v1/prices/{price}

### products
- DELETE /v1/products/{id}
- DELETE /v1/products/{product}/features/{id}
- GET /v1/products
- GET /v1/products/search
- GET /v1/products/{id}
- GET /v1/products/{product}/features
- GET /v1/products/{product}/features/{id}
- POST /v1/products
- POST /v1/products/{id}
- POST /v1/products/{product}/features

### promotion_codes
- GET /v1/promotion_codes
- GET /v1/promotion_codes/{promotion_code}
- POST /v1/promotion_codes
- POST /v1/promotion_codes/{promotion_code}

### quotes
- GET /v1/quotes
- GET /v1/quotes/{quote}
- GET /v1/quotes/{quote}/computed_upfront_line_items
- GET /v1/quotes/{quote}/line_items
- GET /v1/quotes/{quote}/pdf
- POST /v1/quotes
- POST /v1/quotes/{quote}
- POST /v1/quotes/{quote}/accept
- POST /v1/quotes/{quote}/cancel
- POST /v1/quotes/{quote}/finalize

### radar
- DELETE /v1/radar/value_list_items/{item}
- DELETE /v1/radar/value_lists/{value_list}
- GET /v1/radar/early_fraud_warnings
- GET /v1/radar/early_fraud_warnings/{early_fraud_warning}
- GET /v1/radar/value_list_items
- GET /v1/radar/value_list_items/{item}
- GET /v1/radar/value_lists
- GET /v1/radar/value_lists/{value_list}
- POST /v1/radar/payment_evaluations
- POST /v1/radar/value_list_items
- POST /v1/radar/value_lists
- POST /v1/radar/value_lists/{value_list}

### refunds
- GET /v1/refunds
- GET /v1/refunds/{refund}
- POST /v1/refunds
- POST /v1/refunds/{refund}
- POST /v1/refunds/{refund}/cancel

### reporting
- GET /v1/reporting/report_runs
- GET /v1/reporting/report_runs/{report_run}
- GET /v1/reporting/report_types
- GET /v1/reporting/report_types/{report_type}
- POST /v1/reporting/report_runs

### reviews
- GET /v1/reviews
- GET /v1/reviews/{review}
- POST /v1/reviews/{review}/approve

### setup_attempts
- GET /v1/setup_attempts

### setup_intents
- GET /v1/setup_intents
- GET /v1/setup_intents/{intent}
- POST /v1/setup_intents
- POST /v1/setup_intents/{intent}
- POST /v1/setup_intents/{intent}/cancel
- POST /v1/setup_intents/{intent}/confirm

### shipping_rates
- GET /v1/shipping_rates
- GET /v1/shipping_rates/{shipping_rate_token}
- POST /v1/shipping_rates
- POST /v1/shipping_rates/{shipping_rate_token}

### subscription_items
- DELETE /v1/subscription_items/{item}
- GET /v1/subscription_items
- GET /v1/subscription_items/{item}
- POST /v1/subscription_items
- POST /v1/subscription_items/{item}

### subscription_schedules
- GET /v1/subscription_schedules
- GET /v1/subscription_schedules/{schedule}
- POST /v1/subscription_schedules
- POST /v1/subscription_schedules/{schedule}
- POST /v1/subscription_schedules/{schedule}/cancel
- POST /v1/subscription_schedules/{schedule}/release

### subscriptions
- DELETE /v1/subscriptions/{subscription_exposed_id}
- DELETE /v1/subscriptions/{subscription_exposed_id}/discount
- GET /v1/subscriptions
- GET /v1/subscriptions/search
- GET /v1/subscriptions/{subscription_exposed_id}
- POST /v1/subscriptions
- POST /v1/subscriptions/{subscription_exposed_id}
- POST /v1/subscriptions/{subscription}/migrate
- POST /v1/subscriptions/{subscription}/resume

### tax_ids
- DELETE /v1/tax_ids/{id}
- GET /v1/tax_ids
- GET /v1/tax_ids/{id}
- POST /v1/tax_ids

### tax_rates
- GET /v1/tax_rates
- GET /v1/tax_rates/{tax_rate}
- POST /v1/tax_rates
- POST /v1/tax_rates/{tax_rate}

### test_helpers
- DELETE /v1/test_helpers/test_clocks/{test_clock}
- GET /v1/test_helpers/test_clocks
- GET /v1/test_helpers/test_clocks/{test_clock}
- POST /v1/test_helpers/confirmation_tokens
- POST /v1/test_helpers/customers/{customer}/fund_cash_balance
- POST /v1/test_helpers/refunds/{refund}/expire
- POST /v1/test_helpers/test_clocks
- POST /v1/test_helpers/test_clocks/{test_clock}/advance

### tokens
- GET /v1/tokens/{token}
- POST /v1/tokens

### topups
- GET /v1/topups
- GET /v1/topups/{topup}
- POST /v1/topups
- POST /v1/topups/{topup}
- POST /v1/topups/{topup}/cancel

### webhook_endpoints
- DELETE /v1/webhook_endpoints/{webhook_endpoint}
- GET /v1/webhook_endpoints
- GET /v1/webhook_endpoints/{webhook_endpoint}
- POST /v1/webhook_endpoints
- POST /v1/webhook_endpoints/{webhook_endpoint}