Learn how the API ensures secure access
Authorization
header.
Your keys are used to identify the account on our platform, and carries many privileges, so be sure to keep them secure!
Do not share your secret API keys in publicly accessible areas such as public source code repositories, client-side code, and so forth.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail.
API requests:
Test Mode | Live Mode | |
---|---|---|
Prefixes | sk_test_********************* , pk_test_********************* | sk_********************* , pk_********************* |
Purpose | Used for integration and testing | Used for live API requests in production |
Authorization
header with your API key as a bearer token:
Secret Key | Public Key | |
---|---|---|
Format | sk_********************* | pk_********************* |
Purpose | Intended for server-side interactions. | Intended for client-side interactions. |
Scope | Provides full access to the API, including the ability to create, read, update, and delete resources. | Limited access for operations that do not expose sensitive data or require elevated permissions (e.g., creating payment sessions). |
Security | Keep this key private, use it for server-to-server API calls, and do not expose it in client-side applications like web browsers or mobile apps. | Safe for use in client-side applications but should still be restricted to specific operations. |
Example | sk_vYZCAeHawUqDCmVpEKh2U | pk_WeHsNn87r4gtNc5BQT9Mj |