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

# Create payment link



## OpenAPI

````yaml POST /payment_links/create
openapi: 3.1.1
info:
  title: Boltgroup API
  version: '1.0'
servers:
  - url: https://boltgroup.dev/api
security:
  - bearerAuth: []
paths:
  /payment_links/create:
    post:
      parameters:
        - name: mode
          in: query
          description: >-
            How Bolt should calculate the fees


            `inclusive` to includes the fees in the final price the user will
            pay

            `exclusive` to add the fees on top of the final price the user will
            pay
          schema:
            enum:
              - inclusive
              - exclusive
        - name: includesRobloxFees
          in: query
          description: Whether or not the payment should cover the Roblox platform fees
          schema:
            type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentLink'
        required: true
      responses:
        '200':
          description: Payment link created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedPaymentLink'
        '400':
          description: Body is missing fields or some are invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidBody'
        '401':
          description: Unauthorized error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
components:
  schemas:
    CreatePaymentLink:
      type: object
      properties:
        amt:
          $ref: '#/components/schemas/PaymentAmount'
        type:
          $ref: '#/components/schemas/PaymentType'
        customer:
          $ref: '#/components/schemas/PaymentCustomer'
        redirect:
          $ref: '#/components/schemas/PaymentRedirect'
        note:
          $ref: '#/components/schemas/PaymentNote'
        metadata:
          $ref: '#/components/schemas/PaymentMetadata'
    CreatedPaymentLink:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        link:
          $ref: '#/components/schemas/PaymentLink'
    InvalidBody:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
    UnauthorizedError:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
    PaymentAmount:
      type: number
      description: Amount of the payment
      minimum: 0.05
    PaymentType:
      enum:
        - usd
        - robux
      description: The final amount is always calculated in USD
    PaymentCustomer:
      required:
        - name
        - mail
      type: object
      properties:
        name:
          type: string
          description: The customer name
        mail:
          type: string
          description: The customer email address
    PaymentRedirect:
      type: string
      description: The URL to redirect to when the payment is successful
    PaymentNote:
      type: string
      description: A note that will be shown to the customer and in your dashboard
    PaymentMetadata:
      type: object
      description: An object that you can use to provide custom data
    Status:
      type: string
      description: The status of the request (describes the error if one occured)
    PaymentLink:
      type: string
      description: A payment link
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````