Create a checkout

curl --request POST \
  --url https://api.agentaos.ai/api/v1/gateway/sessions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": 49.99,
  "currency": "EUR",
  "description": "Order #123",
  "successUrl": "https://myshop.com/success",
  "cancelUrl": "https://myshop.com/cart",
  "webhookUrl": "https://myshop.com/webhooks",
  "buyerEmail": "john@example.com"
}
'

import requests

url = "https://api.agentaos.ai/api/v1/gateway/sessions"

payload = {
    "amount": 49.99,
    "currency": "EUR",
    "description": "Order #123",
    "successUrl": "https://myshop.com/success",
    "cancelUrl": "https://myshop.com/cart",
    "webhookUrl": "https://myshop.com/webhooks",
    "buyerEmail": "john@example.com"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 49.99,
    currency: 'EUR',
    description: 'Order #123',
    successUrl: 'https://myshop.com/success',
    cancelUrl: 'https://myshop.com/cart',
    webhookUrl: 'https://myshop.com/webhooks',
    buyerEmail: 'john@example.com'
  })
};

fetch('https://api.agentaos.ai/api/v1/gateway/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.agentaos.ai/api/v1/gateway/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 49.99,
    'currency' => 'EUR',
    'description' => 'Order #123',
    'successUrl' => 'https://myshop.com/success',
    'cancelUrl' => 'https://myshop.com/cart',
    'webhookUrl' => 'https://myshop.com/webhooks',
    'buyerEmail' => 'john@example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.agentaos.ai/api/v1/gateway/sessions"

	payload := strings.NewReader("{\n  \"amount\": 49.99,\n  \"currency\": \"EUR\",\n  \"description\": \"Order #123\",\n  \"successUrl\": \"https://myshop.com/success\",\n  \"cancelUrl\": \"https://myshop.com/cart\",\n  \"webhookUrl\": \"https://myshop.com/webhooks\",\n  \"buyerEmail\": \"john@example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.agentaos.ai/api/v1/gateway/sessions")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 49.99,\n  \"currency\": \"EUR\",\n  \"description\": \"Order #123\",\n  \"successUrl\": \"https://myshop.com/success\",\n  \"cancelUrl\": \"https://myshop.com/cart\",\n  \"webhookUrl\": \"https://myshop.com/webhooks\",\n  \"buyerEmail\": \"john@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentaos.ai/api/v1/gateway/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 49.99,\n  \"currency\": \"EUR\",\n  \"description\": \"Order #123\",\n  \"successUrl\": \"https://myshop.com/success\",\n  \"cancelUrl\": \"https://myshop.com/cart\",\n  \"webhookUrl\": \"https://myshop.com/webhooks\",\n  \"buyerEmail\": \"john@example.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
  "payment_link_id": null,
  "org_id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
  "session_id": "mZrESFyR7RC9RPsJfZCVkg",
  "idempotency_key": "order-48213",
  "amount_override": 49.99,
  "currency": "EUR",
  "metadata": {
    "payer": {
      "email": "john@example.com"
    }
  },
  "webhook_url": "https://myshop.com/webhooks",
  "success_url": "https://myshop.com/success",
  "cancel_url": "https://myshop.com/cart",
  "tax_rate_id": null,
  "supported_networks": [
    "eip155:8453"
  ],
  "expires_at": "2026-08-06T12:30:00.000Z",
  "status": "open",
  "created_at": "2026-08-06T12:00:00.000Z",
  "updated_at": "2026-08-06T12:00:00.000Z",
  "seller_mode": "mor",
  "environment": "live",
  "checkoutUrl": "https://app.agentaos.ai/checkout/mZrESFyR7RC9RPsJfZCVkg",
  "invoiceId": "b2c3d4e5-f6a7-8b9c-0d1e-2f3a4b5c6d7e",
  "invoiceNumber": "INV-2026-0142",
  "x402Url": "https://api.agentaos.ai/gateway/v1/x402/mZrESFyR7RC9RPsJfZCVkg"
}

{
  "statusCode": 400,
  "message": "amount is required when creating a session without a link",
  "timestamp": "2026-08-06T12:00:00.000Z"
}

{
  "statusCode": 401,
  "message": "Invalid API key",
  "timestamp": "2026-08-06T12:00:00.000Z"
}

{
  "statusCode": 403,
  "message": "Payment link belongs to another organization",
  "timestamp": "2026-08-06T12:00:00.000Z"
}

{
  "statusCode": 429,
  "message": "Too many tries in a row. Wait a minute, then try again.",
  "timestamp": "2026-10-31T12:00:00.000Z"
}

Checkouts

Create a checkout

Creates a checkout session, standalone or built from a payment link with linkId. The create and list responses do not include a plain amount, only amount_override (null unless you passed one). Call “Retrieve a checkout” for a computed, ready-to-display amount. Accepts an Idempotency-Key header (wins over a body idempotencyKey if both are sent); a repeat call with the same key returns the same checkout instead of creating a second one.

POST

gateway

sessions

Create a checkout

curl --request POST \
  --url https://api.agentaos.ai/api/v1/gateway/sessions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": 49.99,
  "currency": "EUR",
  "description": "Order #123",
  "successUrl": "https://myshop.com/success",
  "cancelUrl": "https://myshop.com/cart",
  "webhookUrl": "https://myshop.com/webhooks",
  "buyerEmail": "john@example.com"
}
'

import requests

url = "https://api.agentaos.ai/api/v1/gateway/sessions"

payload = {
    "amount": 49.99,
    "currency": "EUR",
    "description": "Order #123",
    "successUrl": "https://myshop.com/success",
    "cancelUrl": "https://myshop.com/cart",
    "webhookUrl": "https://myshop.com/webhooks",
    "buyerEmail": "john@example.com"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 49.99,
    currency: 'EUR',
    description: 'Order #123',
    successUrl: 'https://myshop.com/success',
    cancelUrl: 'https://myshop.com/cart',
    webhookUrl: 'https://myshop.com/webhooks',
    buyerEmail: 'john@example.com'
  })
};

fetch('https://api.agentaos.ai/api/v1/gateway/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.agentaos.ai/api/v1/gateway/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 49.99,
    'currency' => 'EUR',
    'description' => 'Order #123',
    'successUrl' => 'https://myshop.com/success',
    'cancelUrl' => 'https://myshop.com/cart',
    'webhookUrl' => 'https://myshop.com/webhooks',
    'buyerEmail' => 'john@example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.agentaos.ai/api/v1/gateway/sessions"

	payload := strings.NewReader("{\n  \"amount\": 49.99,\n  \"currency\": \"EUR\",\n  \"description\": \"Order #123\",\n  \"successUrl\": \"https://myshop.com/success\",\n  \"cancelUrl\": \"https://myshop.com/cart\",\n  \"webhookUrl\": \"https://myshop.com/webhooks\",\n  \"buyerEmail\": \"john@example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.agentaos.ai/api/v1/gateway/sessions")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 49.99,\n  \"currency\": \"EUR\",\n  \"description\": \"Order #123\",\n  \"successUrl\": \"https://myshop.com/success\",\n  \"cancelUrl\": \"https://myshop.com/cart\",\n  \"webhookUrl\": \"https://myshop.com/webhooks\",\n  \"buyerEmail\": \"john@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentaos.ai/api/v1/gateway/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 49.99,\n  \"currency\": \"EUR\",\n  \"description\": \"Order #123\",\n  \"successUrl\": \"https://myshop.com/success\",\n  \"cancelUrl\": \"https://myshop.com/cart\",\n  \"webhookUrl\": \"https://myshop.com/webhooks\",\n  \"buyerEmail\": \"john@example.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
  "payment_link_id": null,
  "org_id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
  "session_id": "mZrESFyR7RC9RPsJfZCVkg",
  "idempotency_key": "order-48213",
  "amount_override": 49.99,
  "currency": "EUR",
  "metadata": {
    "payer": {
      "email": "john@example.com"
    }
  },
  "webhook_url": "https://myshop.com/webhooks",
  "success_url": "https://myshop.com/success",
  "cancel_url": "https://myshop.com/cart",
  "tax_rate_id": null,
  "supported_networks": [
    "eip155:8453"
  ],
  "expires_at": "2026-08-06T12:30:00.000Z",
  "status": "open",
  "created_at": "2026-08-06T12:00:00.000Z",
  "updated_at": "2026-08-06T12:00:00.000Z",
  "seller_mode": "mor",
  "environment": "live",
  "checkoutUrl": "https://app.agentaos.ai/checkout/mZrESFyR7RC9RPsJfZCVkg",
  "invoiceId": "b2c3d4e5-f6a7-8b9c-0d1e-2f3a4b5c6d7e",
  "invoiceNumber": "INV-2026-0142",
  "x402Url": "https://api.agentaos.ai/gateway/v1/x402/mZrESFyR7RC9RPsJfZCVkg"
}

{
  "statusCode": 400,
  "message": "amount is required when creating a session without a link",
  "timestamp": "2026-08-06T12:00:00.000Z"
}

{
  "statusCode": 401,
  "message": "Invalid API key",
  "timestamp": "2026-08-06T12:00:00.000Z"
}

{
  "statusCode": 403,
  "message": "Payment link belongs to another organization",
  "timestamp": "2026-08-06T12:00:00.000Z"
}

{
  "statusCode": 429,
  "message": "Too many tries in a row. Wait a minute, then try again.",
  "timestamp": "2026-10-31T12:00:00.000Z"
}

Webhook: none. checkout.session.completed fires later, when AgentaOS confirms the buyer’s payment. See Which action fires which event.

Send paymentMethods: ["card"] to make the checkout card-only. Without it, an EUR checkout also offers bank transfer. An impossible list (empty, no card, or bank transfer outside EUR) answers 400 with code: "payment_methods_unavailable". Without buyerEmail, the checkout page asks the buyer for their email.

The REST path is /gateway/sessions (the underlying resource is called a “session”); the TypeScript SDK and the CLI both call it a checkout (agentaos.checkouts, agenta pay checkout).

The create and list responses do not include a plain amount, only amount_override (null unless you passed one). For a link-based checkout, the effective price is the link’s amount. To get a single, ready-to-display price, call Retrieve a checkout, which computes amount for you.

Authorizations

x-api-key

string

header

required

Your secret key, from app.agentaos.ai -> Settings -> Developers -> API Keys. The key's prefix is both its identity and its environment: sk_test_... (sandbox, free, no verification) or sk_live_... (real money, requires business verification). A missing or invalid key returns 401.

Headers

Idempotency-Key

string

Alternative to the body's idempotencyKey field. The header wins if both are sent.

Body

application/json

Either linkId or amount is required (amount is required when creating a standalone checkout with no link).

linkId

string<uuid>

Payment link UUID to create from. Inherits amount, currency, description, taxRateId, and the seller mode. Omit for a standalone checkout.

amount

number

Required if no linkId.

Required range: 0.01 <= x <= 1000000

amountOverride

number

With linkId, overrides the link's amount for this checkout only.

Required range: 0.01 <= x <= 1000000

currency

enum<string>

Ignored (inherited from the link) when linkId is set.

Available options:

EUR,

USD,

EURC,

EURe,

USDC

description

string

Maximum string length: 1000

taxRateId

string<uuid>

dueDate

string<date>

YYYY-MM-DD. Presentation only, stamped onto the invoice issued for this checkout.

buyerEmail

string<email>

Maximum string length: 320

buyerName

string

Maximum string length: 200

buyerCompany

string

Maximum string length: 200

buyerCountry

string

ISO 3166-1 alpha-2, e.g. DE. Drives destination-VAT calculation.

Maximum string length: 2

buyerAddress

string

Maximum string length: 500

buyerVat

string

Maximum string length: 20

webhookUrl

string<uri>

Maximum string length: 2048

successUrl

string<uri>

Maximum string length: 2048

cancelUrl

string<uri>

Maximum string length: 2048

expiresIn

integer

Seconds until the checkout expires. Without it: 24 hours for a card checkout, 48 hours for an EUR checkout that offers bank transfer, 30 minutes for a stablecoin checkout. At the deadline a card payment not yet completed is stopped; a bank transfer the buyer chose before it stays valid up to 30 days.

Required range: 300 <= x <= 86400

paymentMethods

enum<string>[]

What the checkout offers. ["card"] makes it card-only. Without it: card, plus bank transfer on EUR. Card must be included; bank transfer is EUR only. An impossible list answers 400 payment_methods_unavailable.

Available options:

card,

bank_transfer

metadata

object

Up to 8KB serialized.

supportedNetworks

string[]

CAIP-2 network IDs. Defaults to Base mainnet for crypto-settlement checkouts.

idempotencyKey

string

Also settable via the Idempotency-Key request header (the header wins if both are sent).

Response

Checkout created.

string<uuid>

required

Internal checkout UUID.

payment_link_id

string<uuid> | null

required

org_id

string<uuid>

required

session_id

string

required

Public ID, used in the checkout URL and as the path parameter for every other call on this resource.

idempotency_key

string | null

required

amount_override

number | null

required

Set only if you passed amount or amountOverride at create.

currency

string

required

metadata

object

required

webhook_url

string | null

required

success_url

string | null

required

cancel_url

string | null

required

tax_rate_id

string<uuid> | null

required

supported_networks

string[]

required

expires_at

string<date-time>

required

status

enum<string>

required

Available options:

open,

completed,

expired,

cancelled

created_at

string<date-time>

required

updated_at

string<date-time>

required

seller_mode

enum<string>

required

Available options:

mor,

crypto

environment

enum<string>

required

Available options:

test,

live

checkoutUrl

string

required

Send your buyer here. Computed, camelCase.

invoiceId

string<uuid> | null

The invoice issued with this checkout. Only in the response to POST /gateway/sessions, and absent when no invoice was issued.

invoiceNumber

string | null

That invoice's number. Only in the response to POST /gateway/sessions, and absent when no invoice was issued.

x402Url

string

Agent-to-agent payment URL via the x402 protocol. Computed, camelCase. Most integrations can ignore it.

description

string | null

The checkout's own line text, when it was created with one. Otherwise the product's description applies.

sepa_reference

string | null

The reference the buyer puts on a bank transfer to this checkout. Null until a bank transfer is chosen.

payment_links

object | null

List only (GET /gateway/sessions): the product's amount, currency and description. Null for a checkout with no product.

Show child attributes