Send your complete merchant secret in the x-api-key header. Keep it in your backend’s secret store, never browser code, mobile apps, URLs or source control.
Your key determines the merchant account and permissions for each request. Use the API base URL shown with the key in the portal. If an administrator has turned on the IP allowlist in Settings, requests must come from a listed address or range, and any other address gets a 403 response. Revoked or expired keys are rejected.
These merchant endpoints use API keys, not portal sign-in credentials. The hosted checkout handles its own customer access; use the documented merchant API for server integrations.
Manage keys in the portal. Checkout keys can include orders_read, orders_write, refunds_read and refunds_write. Give each backend only the scopes it needs. Privileged credential administration endpoints are outside this public reference.
Keys created in the portal default to 90 days. You can choose 30, 90, 180 or 365 days, or select Never expires. Rotate keys by creating a replacement, updating your backend, then revoking the old key.