---
title: "Create A Checkout Session"
method: POST
path: "/billing/checkout"
---

# Create A Checkout Session

`POST /billing/checkout`

## Request

- Base URL: `https://api-sandbox.ezypay.com/v2`
- URL: `https://api-sandbox.ezypay.com/v2/billing/checkout`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://identity-sandbox.ezypay.com/token`

## Headers

- `Merchant` string, required

## Request body

- object
  - `amount` object, required: The amount (actual amount and currency) that you want to charge.
    - `currency` string, required: Three letter ISO 4217 currency code for the amount.
    - `value` number, double, required: The value of the amount. Must be positive value greater than zero.
    - `type` string: The type of the amount value. Supported values are: `percentage`, `fixed_amount`
  - `description` string, required: The description of the payment. This description will be the main line item in the generated invoice.
  - `accountingCode` string: The accounting code that you'll want this invoice to be associated with.
  - `successUrl` string: The URL that the Checkout Page will redirect to once a payment outcome is reached, regardless of status.
  - `cancelUrl` string: The URL that the Checkout Page will redirect to if the user cancels the payment.
  - `customerId` string: The unique UUID of the customer that you want to be the payee of this invoice.
  - `paymentMethodToken` string: The unique payment method token that you want used for this payment.

## Response `200`

200

- object
  - `checkoutUrl` string
  - `id` string

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `924be4030f56`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ezypay/apis/vault/changes/billing/checkout/post.md)

---

[API](https://skmtc.dev/ezypay/apis/vault.md) - [All operations](https://skmtc.dev/ezypay/apis/vault/llms.txt) - [OpenAPI document](https://skmtc.dev/ezypay/apis/vault/revisions/924be4030f56?raw)