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

# Advance a pay-by-link lifecycle

> Apply one lifecycle event to the payment request. An illegal transition is rejected with VALIDATION_ERROR.



## OpenAPI

````yaml /openapi.yaml post /api/v1/commerce/payment-request/transition
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
paths:
  /api/v1/commerce/payment-request/transition:
    post:
      tags:
        - Commerce
      summary: Advance a pay-by-link lifecycle
      description: >-
        Apply one lifecycle event to the payment request. An illegal transition
        is rejected with VALIDATION_ERROR.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              required:
                - request
                - event
              properties:
                request:
                  type: object
                  additionalProperties: true
                  description: >-
                    Serializable channel-agnostic hosted pay-by-link snapshot.
                    The caller round-trips it in each request body.
                  properties:
                    id:
                      type: string
                    amount:
                      type: number
                    currency:
                      type: string
                    description:
                      type:
                        - string
                        - 'null'
                    reference:
                      type:
                        - string
                        - 'null'
                    checkoutUrl:
                      type: string
                    status:
                      type: string
                      enum:
                        - pending
                        - viewed
                        - paid
                        - expired
                        - cancelled
                    expiresAt:
                      type:
                        - number
                        - 'null'
                    createdAt:
                      type: number
                    updatedAt:
                      type: number
                event:
                  type: string
                  enum:
                    - MARK_VIEWED
                    - MARK_PAID
                    - EXPIRE
                    - CANCEL
      responses:
        '200':
          description: The payment request after the transition.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                required:
                  - data
                  - meta
                properties:
                  data:
                    type: object
                    additionalProperties: true
                    description: >-
                      Serializable channel-agnostic hosted pay-by-link snapshot.
                      The caller round-trips it in each request body.
                    properties:
                      id:
                        type: string
                      amount:
                        type: number
                      currency:
                        type: string
                      description:
                        type:
                          - string
                          - 'null'
                      reference:
                        type:
                          - string
                          - 'null'
                      checkoutUrl:
                        type: string
                      status:
                        type: string
                        enum:
                          - pending
                          - viewed
                          - paid
                          - expired
                          - cancelled
                      expiresAt:
                        type:
                          - number
                          - 'null'
                      createdAt:
                        type: number
                      updatedAt:
                        type: number
                  meta:
                    type: object
                    additionalProperties: true
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````