Create a checkout session

POST

/payments/create-checkout-session

Create a new Stripe checkout session for payment processing.
This endpoint creates a secure payment session that redirects users to Stripe's hosted checkout page.
The session can be configured to save payment methods for future use and includes comprehensive metadata.
Only available for organization Firebase JWT authentication.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.perfectworks.io/api/v0/payments/create-checkout-session' \
--header 'Content-Type: application/json' \
--data-raw '{
    "productId": "prod_1234567890abcdef",
    "quantity": 1,
    "successUrl": "https://myapp.com/success?session_id={CHECKOUT_SESSION_ID}",
    "cancelUrl": "https://myapp.com/cancel"
}'

Response Example

201 - Example 1

{
    "success": true,
    "message": "Operation completed successfully",
    "data": {
        "id": "123",
        "name": "Example"
    }
}

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Examples

Responses

🟢201Created

application/json

Checkout session created successfully

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

Modified at 2025-08-22 18:48:44

Track referral click and redirect

Get checkout session details