Checkouts

Retrieve a checkout

Adds a computed amount (the effective price: amount_override, else the linked payment link's amount), plus the link's own link_amount/link_currency/link_description, and the checkout's transactions and invoices arrays.

get/gateway/sessions/{sessionId}

Request

  • Base URL: https://api.agentaos.ai/api/v1
  • URL: https://api.agentaos.ai/api/v1/gateway/sessions/{sessionId}
  • Auth: API key in header x-api-key

Path parameters

sessionIdstring required

The public session_id (not the internal id UUID).

Response

The checkout, with computed amount and related rows.

idstring uuid required

Internal checkout UUID.

payment_link_idstring uuid nullable required
org_idstring uuid required
session_idstring required

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

idempotency_keystring nullable required
amount_overridenumber nullable required

Set only if you passed amount or amountOverride at create.

currencystring required
metadataobject required
webhook_urlstring nullable required
success_urlstring nullable required
cancel_urlstring nullable required
tax_rate_idstring uuid nullable required
supported_networksstring[] required
expires_atstring date-time required
status'open' | 'completed' | 'expired' | 'cancelled' required
created_atstring date-time required
updated_atstring date-time required
seller_mode'mor' | 'crypto' required
environment'test' | 'live' required
checkoutUrlstring required

Send your buyer here. Computed, camelCase.

invoiceIdstring uuid nullable

Set once an invoice has been issued for this session; null until then.

invoiceNumberstring nullable
amountnumber nullable required

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

link_amountnumber nullable required
link_currencystring nullable required
link_descriptionstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.