> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agg.market/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> To integrate AGG, start with Quickstart: REST (https://docs.agg.market/quickstart/rest), then Order lifecycle & statuses (https://docs.agg.market/concepts/order-lifecycle).
> Track every trade until it reaches a terminal status. Before retrying a failed or timed-out call, read Errors, retries & idempotency (https://docs.agg.market/concepts/errors).
> The API reference is generated from https://docs.agg.market/openapi/openapi.json.

# Create a ramp widget session for checkout



## OpenAPI

````yaml /openapi/openapi.json post /ramp/session
openapi: 3.0.2
info:
  title: AGG API
  version: 1.0.0
  description: >-
    Prediction market aggregator REST API — authentication, users, venue events,
    venue markets, orderbooks, charts, and execution workflows.
servers:
  - url: https://api.agg.market
    description: Production
security: []
tags:
  - name: Authentication
    description: Sign users in and manage their session tokens.
  - name: Markets
    description: Find events, markets and outcomes to trade.
  - name: Market Data
    description: Live orderbooks, prices, charts and scores for those markets.
  - name: Trading
    description: Quote, place, sign, track and cancel orders.
  - name: Portfolio
    description: A user's orders, positions, balances and activity.
  - name: Funding
    description: Deposit addresses, withdrawals, balance refills and fiat on-ramp.
  - name: Users
    description: The signed-in user's profile, linked accounts, KYC and venue keys.
  - name: Hosted Venue Accounts
    description: Provision, fund and withdraw from venue accounts hosted for the user.
  - name: Webhooks
    description: Configure and operate webhook delivery to your server.
  - name: Partner Admin
    description: Server-side reads across your app's users, orders and analytics.
  - name: Paper Trading
    description: Simulated accounts and orders for testing without real funds.
  - name: News
    description: News feeds linked to markets.
  - name: Correlated Markets
    description: Markets related to a given market and the effect of its resolution.
paths:
  /ramp/session:
    post:
      tags:
        - Funding
      summary: Create a ramp widget session for checkout
      operationId: createRampSession
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - sourceAmount
                - sourceCurrencyCode
                - destinationCurrencyCode
                - serviceProvider
                - walletAddress
              properties:
                sourceAmount:
                  description: >-
                    Amount to pay, in `sourceCurrencyCode` units, as a decimal
                    string (e.g. "50").
                  type: string
                sourceCurrencyCode:
                  type: string
                destinationCurrencyCode:
                  type: string
                serviceProvider:
                  type: string
                walletAddress:
                  type: string
                redirectUrl:
                  type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                type: object
                required:
                  - id
                  - token
                  - widgetUrl
                  - serviceProviderWidgetUrl
                properties:
                  id:
                    description: Session id.
                    type: string
                  token:
                    description: Session token for the checkout widget.
                    type: string
                  widgetUrl:
                    description: URL of the checkout widget to open.
                    type: string
                  serviceProviderWidgetUrl:
                    description: The provider's own checkout URL.
                    type: string
        '401':
          description: '401'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '502':
          description: '502'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - appId: []
components:
  schemas:
    ErrorMessage:
      type: object
      required:
        - message
      properties:
        message:
          type: string
  securitySchemes:
    appId:
      type: apiKey
      in: header
      name: x-app-id
      description: Your application ID. Required for all app-tier and user-tier routes.

````