Create Checkout - Salla Platform Docs

This endpoint allows you to create a checkout for an amount your app computes (credits, usage, top-ups, quotes) and returns it.

Note

Salla adds VAT and collects the payment; the merchant pays it in your embedded app (embedded.checkout.create({ checkout_id: String(id) })) or through the returned checkout_url.

The full flow is in the guide Server-Created Checkouts (Checkout SDK):

Scopes

checkouts.read_write - Checkouts Read & Write

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/jsonRequired

Example

{
    "reference_id": "topup-8812",
    "taxable": true,
    "currency": "SAR",
    "items": [
        {
            "name": {
                "ar": "رصيد 500 رسالة",
                "en": "500 SMS credits"
            },
            "amount": 125,
            "quantity": 500,
            "description": "Top-up for October"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Success

application/json

Bodyapplication/json

Example

{
    "status": 201,
    "success": true,
    "data": {
        "id": 1638492741,
        "reference_id": "topup-8812",
        "status": "pending",
        "subtotal": {
            "amount": 125,
            "currency": "SAR"
        },
        "total_discount": {
            "amount": 0,
            "currency": "SAR"
        },
        "tax": {
            "amount": 18.75,
            "currency": "SAR"
        },
        "total": {
            "amount": 143.75,
            "currency": "SAR"
        },
        "checkout_url": "https://s.salla.sa/checkout/1638492741",
        "paid_at": null,
        "items": [
            {
                "name": "رصيد 500 رسالة",
                "description": "Top-up for October",
                "quantity": 500,
                "amounts": {
                    "price_without_tax": {
                        "amount": 0.25,
                        "currency": "SAR"
                    },
                    "total_discount": {
                        "amount": 0,
                        "currency": "SAR"
                    },
                    "tax": {
                        "percent": 15,
                        "amount": {
                            "amount": 18.75,
                            "currency": "SAR"
                        }
                    },
                    "total": {
                        "amount": 143.75,
                        "currency": "SAR"
                    }
                }
            }
        ]
    }
}

🟠401Unauthorized

🟠403Forbidden

🟠422Unprocessable Entity