Retrieve a checkout

curl --request GET \
  --url https://api.agentaos.ai/api/v1/gateway/sessions/{sessionId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.agentaos.ai/api/v1/gateway/sessions/{sessionId}', 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/{sessionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session_id": "<string>",
  "idempotency_key": "<string>",
  "amount_override": 123,
  "currency": "<string>",
  "metadata": {},
  "webhook_url": "<string>",
  "success_url": "<string>",
  "cancel_url": "<string>",
  "tax_rate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "supported_networks": [
    "<string>"
  ],
  "expires_at": "2023-11-07T05:31:56Z",
  "status": "open",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "seller_mode": "mor",
  "environment": "test",
  "checkoutUrl": "<string>",
  "amount": 123,
  "link_amount": 123,
  "link_currency": "<string>",
  "link_description": "<string>",
  "transactions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "direction": "inbound",
      "amount": 123,
      "payment_token": "<string>",
      "settlement_token": "<string>",
      "status": "confirmed",
      "payment_method": "card",
      "payer_type": "human",
      "payer_address": "<string>",
      "tx_hash": "<string>",
      "vendor_reference": "<string>",
      "network": "<string>",
      "seller_of_record": "aristokrates_ou",
      "payment_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "session_id": "<string>",
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "money": {
        "currency": "<string>",
        "grossMinor": 123,
        "feeMinor": 123,
        "vatMinor": 123,
        "netMinor": 123,
        "platformShareMinor": 123
      },
      "mor_status": "held",
      "disputed_at": "2023-11-07T05:31:56Z",
      "dispute_won_at": "2023-11-07T05:31:56Z",
      "charged_back_at": "2023-11-07T05:31:56Z",
      "refunded_at": "2023-11-07T05:31:56Z",
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "environment": "test",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "discount_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "card_currency": "<string>",
      "refunded_minor": 123,
      "payer_metadata": {
        "name": "<string>",
        "email": "<string>",
        "payerName": "<string>"
      },
      "recipient_label": "<string>",
      "to_address": "<string>",
      "token_address": "<string>"
    }
  ],
  "invoices": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_number": "<string>",
      "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "session_id": "<string>",
      "amount": 123,
      "currency": "<string>",
      "payment_token": "<string>",
      "status": "issued",
      "fiat_amount": 123,
      "fiat_currency": "EUR",
      "exchange_rate": 123,
      "exchange_rate_source": "<string>",
      "tax_rate": 123,
      "tax_amount": 123,
      "tax_name": "<string>",
      "tax_inclusive": true,
      "merchant_name": "<string>",
      "buyer_email": "<string>",
      "buyer_name": "<string>",
      "buyer_company": "<string>",
      "buyer_country": "<string>",
      "buyer_vat": "<string>",
      "tx_hash": "<string>",
      "issued_at": "2023-11-07T05:31:56Z",
      "voided_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "resolved_amount": 123,
      "resolved_currency": "<string>",
      "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "environment": "test",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "due_date": "<string>",
      "paid_at": "2023-11-07T05:31:56Z",
      "receipt_number": "<string>",
      "receipt_issued_at": "2023-11-07T05:31:56Z",
      "seller_of_record": "merchant",
      "payment_method": "<string>",
      "payment_method_brand": "<string>",
      "payment_method_last4": "<string>",
      "tax_exemption_reason": "<string>",
      "buyer_address": "<string>",
      "merchant_address": "<string>",
      "merchant_vat": "<string>",
      "merchant_wallet": "<string>",
      "payer_address": "<string>",
      "payer_metadata": {},
      "network": "<string>",
      "chain_id": 123,
      "token_address": "<string>",
      "exchange_rate_at": "2023-11-07T05:31:56Z",
      "dispute": {
        "disputed": true,
        "chargedBack": true,
        "disputedAt": "2023-11-07T05:31:56Z",
        "disputed_at": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "invoiceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "invoiceNumber": "<string>",
  "x402Url": "<string>",
  "description": "<string>",
  "sepa_reference": "<string>",
  "payment_links": {
    "amount": 123,
    "currency": "<string>",
    "description": "<string>"
  },
  "charged": {
    "amountMinor": 123,
    "taxMinor": 123,
    "baseMinor": 123,
    "ratePercent": 123,
    "currency": "<string>",
    "feeMinor": 123,
    "netMinor": 123,
    "platformShareMinor": 123,
    "keepsMinor": 123
  },
  "refundRequest": {
    "captureId": "<string>",
    "status": "requested",
    "requestedAt": "2023-11-07T05:31:56Z",
    "decidedAt": "2023-11-07T05:31:56Z",
    "note": "<string>"
  },
  "refundableCaptureId": "<string>"
}

{
  "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": 404,
  "message": "Payment link not found",
  "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"
}

GET

gateway

sessions

{sessionId}

Retrieve a checkout

curl --request GET \
  --url https://api.agentaos.ai/api/v1/gateway/sessions/{sessionId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.agentaos.ai/api/v1/gateway/sessions/{sessionId}', 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/{sessionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session_id": "<string>",
  "idempotency_key": "<string>",
  "amount_override": 123,
  "currency": "<string>",
  "metadata": {},
  "webhook_url": "<string>",
  "success_url": "<string>",
  "cancel_url": "<string>",
  "tax_rate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "supported_networks": [
    "<string>"
  ],
  "expires_at": "2023-11-07T05:31:56Z",
  "status": "open",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "seller_mode": "mor",
  "environment": "test",
  "checkoutUrl": "<string>",
  "amount": 123,
  "link_amount": 123,
  "link_currency": "<string>",
  "link_description": "<string>",
  "transactions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "direction": "inbound",
      "amount": 123,
      "payment_token": "<string>",
      "settlement_token": "<string>",
      "status": "confirmed",
      "payment_method": "card",
      "payer_type": "human",
      "payer_address": "<string>",
      "tx_hash": "<string>",
      "vendor_reference": "<string>",
      "network": "<string>",
      "seller_of_record": "aristokrates_ou",
      "payment_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "session_id": "<string>",
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "money": {
        "currency": "<string>",
        "grossMinor": 123,
        "feeMinor": 123,
        "vatMinor": 123,
        "netMinor": 123,
        "platformShareMinor": 123
      },
      "mor_status": "held",
      "disputed_at": "2023-11-07T05:31:56Z",
      "dispute_won_at": "2023-11-07T05:31:56Z",
      "charged_back_at": "2023-11-07T05:31:56Z",
      "refunded_at": "2023-11-07T05:31:56Z",
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "environment": "test",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "discount_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "card_currency": "<string>",
      "refunded_minor": 123,
      "payer_metadata": {
        "name": "<string>",
        "email": "<string>",
        "payerName": "<string>"
      },
      "recipient_label": "<string>",
      "to_address": "<string>",
      "token_address": "<string>"
    }
  ],
  "invoices": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_number": "<string>",
      "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "session_id": "<string>",
      "amount": 123,
      "currency": "<string>",
      "payment_token": "<string>",
      "status": "issued",
      "fiat_amount": 123,
      "fiat_currency": "EUR",
      "exchange_rate": 123,
      "exchange_rate_source": "<string>",
      "tax_rate": 123,
      "tax_amount": 123,
      "tax_name": "<string>",
      "tax_inclusive": true,
      "merchant_name": "<string>",
      "buyer_email": "<string>",
      "buyer_name": "<string>",
      "buyer_company": "<string>",
      "buyer_country": "<string>",
      "buyer_vat": "<string>",
      "tx_hash": "<string>",
      "issued_at": "2023-11-07T05:31:56Z",
      "voided_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "resolved_amount": 123,
      "resolved_currency": "<string>",
      "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "environment": "test",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "due_date": "<string>",
      "paid_at": "2023-11-07T05:31:56Z",
      "receipt_number": "<string>",
      "receipt_issued_at": "2023-11-07T05:31:56Z",
      "seller_of_record": "merchant",
      "payment_method": "<string>",
      "payment_method_brand": "<string>",
      "payment_method_last4": "<string>",
      "tax_exemption_reason": "<string>",
      "buyer_address": "<string>",
      "merchant_address": "<string>",
      "merchant_vat": "<string>",
      "merchant_wallet": "<string>",
      "payer_address": "<string>",
      "payer_metadata": {},
      "network": "<string>",
      "chain_id": 123,
      "token_address": "<string>",
      "exchange_rate_at": "2023-11-07T05:31:56Z",
      "dispute": {
        "disputed": true,
        "chargedBack": true,
        "disputedAt": "2023-11-07T05:31:56Z",
        "disputed_at": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "invoiceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "invoiceNumber": "<string>",
  "x402Url": "<string>",
  "description": "<string>",
  "sepa_reference": "<string>",
  "payment_links": {
    "amount": 123,
    "currency": "<string>",
    "description": "<string>"
  },
  "charged": {
    "amountMinor": 123,
    "taxMinor": 123,
    "baseMinor": 123,
    "ratePercent": 123,
    "currency": "<string>",
    "feeMinor": 123,
    "netMinor": 123,
    "platformShareMinor": 123,
    "keepsMinor": 123
  },
  "refundRequest": {
    "captureId": "<string>",
    "status": "requested",
    "requestedAt": "2023-11-07T05:31:56Z",
    "decidedAt": "2023-11-07T05:31:56Z",
    "note": "<string>"
  },
  "refundableCaptureId": "<string>"
}

{
  "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": 404,
  "message": "Payment link not found",
  "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"
}

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.

Path Parameters

sessionId

string

required

The public session_id (not the internal id UUID).

Response

The checkout, with computed amount and related rows.

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.

amount

number | null

required

Computed effective price: amount_override, else the linked payment link's amount.

link_amount

number | null

required

link_currency

string | null

required

link_description

string | null

required

transactions

object[]

required

Show child attributes

invoices

object[]

required

Show child attributes

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

charged

object | null

What this checkout ACTUALLY took, read off the transaction the payment booked. Not the same figure as amount above, which is the plan's list price: a subscription sold with an intro price charges the intro price today and the full price at renewal, and a discount code moves it again. Every value is an integer count of minor units in currency. Null when nothing was charged, which is what a trial with no intro price looks like — a card on file and no payment to describe.

Show child attributes

refundRequest

object | null

The refund request on this sale, if one was made. Refunds are two steps: you ask, AgentaOS refunds the buyer in full or declines with a note. Null when nobody asked.

Show child attributes

refundableCaptureId

string | null

The sale you may still ask to refund — pass it to POST /gateway/transactions/{id}/refund-request. Null once a request exists, and when the sale cannot be refunded (already refunded, disputed, or not a card sale AgentaOS was merchant of record for).

SDK

CLI

API Reference

Retrieve a checkout

Authorizations

Path Parameters

Response