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

# Create reusable payment link

> Reusable link configuration is a mode-specific resource. Saving does not create a payment, charge a provider, or stamp an invoice. Later payer use can create payments and run configured invoice automation. Current original credentials and payment-module authority are checked. Source/offline contract; no live provider validation is claimed. Persist operation_id before the request. expected_livemode asserts the selected mode; it does not override it. Update/delete require the latest GET revision. Lost acknowledgments are recovered by reading the same operation. Delete is allowed after use and retains generated payment/invoice history. Short URL may be null; use the full URL.



## OpenAPI

````yaml openapi.json POST /payments/links
openapi: 3.0.3
info:
  title: gigstack API v2
  description: >
    # gigstack API v2


    Build customer, invoice and payment integrations. Start with the
    [quickstart](https://docs.gigstack.io/quickstart), then select the [issuing
    country](https://docs.gigstack.io/concepts/shared-fields).


    ## Authentication and environments


    Use Authorization: Bearer YOUR_API_KEY. Standard live and test keys use
    https://api.gigstack.io/v2. Internal staging uses
    https://gigstack-staging-9z9nnaat.uc.gateway.dev/v2 and separate keys. Test
    mode is a data mode within an environment; a body field does not switch a
    key's mode.


    See [authentication](https://docs.gigstack.io/authentication) for key
    handling, OAuth team scope and gigstack Connect. Internal partner
    provisioning is outside this public contract; health probes have their own
    security declarations. Operations marked unavailable have no configured
    public gateway route.


    ## Read the operation contract


    Response envelopes, pagination and retry rules differ by endpoint. HTTP
    success alone does not prove external fiscal completion or movement of
    money. Reconcile ambiguous writes before retrying. Use [responses and
    recovery](https://docs.gigstack.io/responses) and the operation's error
    codes; document credits and daily limits are not generic retryable rate
    limits.


    The issuing team's configuration selects Mexico or Colombia; customer
    country and currency do not. Read
    [Mexico](https://docs.gigstack.io/countries/mexico) or
    [Colombia](https://docs.gigstack.io/countries/colombia) before choosing
    fiscal fields. Accepted public input differs from a provider's direct
    payload.


    Examples and schema checks do not imply every operation has been executed
    live. [Verification coverage](https://docs.gigstack.io/verification)
    distinguishes source review, offline checks and observed staging behavior.
    Documentation describes operations and does not authorize execution.
  version: 2.0.0
  contact:
    name: Gigstack API Support
    url: https://gigstack.io
    email: support@gigstack.io
  license:
    name: Proprietary
    url: https://gigstack.io/terms
  termsOfService: https://gigstack.io/terms
servers:
  - url: https://api.gigstack.io/v2
    description: >
      Public API for standard live and test-mode keys. Test data is isolated by
      the key mode

      (`livemode: false`). Internal staging is a separate deployment and key
      store; see

      https://docs.gigstack.io/authentication#environments for its base URL.
security:
  - bearerAuth: []
externalDocs:
  description: Complete API Documentation & Guides
  url: https://docs.gigstack.io
paths:
  /payments/links:
    post:
      tags:
        - Payments
      summary: Create reusable payment link
      description: >-
        Reusable link configuration is a mode-specific resource. Saving does not
        create a payment, charge a provider, or stamp an invoice. Later payer
        use can create payments and run configured invoice automation. Current
        original credentials and payment-module authority are checked.
        Source/offline contract; no live provider validation is claimed. Persist
        operation_id before the request. expected_livemode asserts the selected
        mode; it does not override it. Update/delete require the latest GET
        revision. Lost acknowledgments are recovered by reading the same
        operation. Delete is allowed after use and retains generated
        payment/invoice history. Short URL may be null; use the full URL.
      operationId: createPaymentLink
      parameters:
        - name: team
          in: query
          schema:
            type: string
          description: >-
            Selected authorized team; Firebase must match current authenticated
            team. Mode is current persisted preference or immutable credential
            mode.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentLinkCreateInput'
            example:
              operation_id: 11111111-1111-4111-8111-111111111111
              expected_livemode: false
              currency: MXN
              items:
                - total: 100
                  quantity: 1
              custom_method_types:
                - id: bank
      responses:
        '201':
          description: Atomic durable receipt and current link.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentLinkMutationResponse'
        '400':
          description: Invalid typed input, identifier or cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Original credential could not be verified.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Current role, credential scope or account denied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource or operation is not readable in selected team/mode.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            Mode, revision, deleted resource or operation conflict; review
            current state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: >-
            Outcome unconfirmed. Read the same operation UUID; no automatic
            write replay.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    PaymentLinkCreateInput:
      type: object
      additionalProperties: false
      required:
        - operation_id
        - expected_livemode
        - items
        - currency
      properties:
        operation_id:
          type: string
          pattern: >-
            ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
        expected_livemode:
          type: boolean
        items:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - total
            properties:
              total:
                type: number
                minimum: 0
                maximum: 1000000000000
              quantity:
                type: number
                nullable: true
                minimum: 0.000001
                maximum: 1000000000
              hours:
                type: number
                nullable: true
                minimum: 0
                maximum: 1000000000000
              discount:
                type: number
                nullable: true
                minimum: 0
                maximum: 1000000000000
              feeAdded:
                type: number
                nullable: true
                minimum: 0
                maximum: 1000000000000
              paymentType:
                type: object
                additionalProperties: false
                required:
                  - value
                properties:
                  value:
                    type: string
                    enum:
                      - fixed
                      - hour
                  label:
                    type: string
                    nullable: true
                    maxLength: 100
                nullable: true
              taxes:
                type: array
                items:
                  type: object
                  additionalProperties: false
                  required:
                    - rate
                    - type
                  properties:
                    rate:
                      oneOf:
                        - type: number
                        - type: string
                          description: Numeric string accepted by the request validator.
                      minimum: 0
                      maximum: 100
                    type:
                      type: string
                      maxLength: 100
                    factor:
                      type: string
                      nullable: true
                      maxLength: 30
                    withholding:
                      type: boolean
                      nullable: true
                    inclusive:
                      type: boolean
                      nullable: true
                    id:
                      type: string
                      nullable: true
                      maxLength: 160
                    ieps_mode:
                      type: string
                      nullable: true
                      maxLength: 30
                    base:
                      type: number
                      nullable: true
                      minimum: 0
                      maximum: 1000000000000
                nullable: true
                maxItems: 30
              localTaxes:
                type: array
                items:
                  type: object
                  additionalProperties: false
                  required:
                    - rate
                    - type
                  properties:
                    rate:
                      oneOf:
                        - type: number
                        - type: string
                          description: Numeric string accepted by the request validator.
                      minimum: 0
                      maximum: 100
                    type:
                      type: string
                      maxLength: 100
                    factor:
                      type: string
                      nullable: true
                      maxLength: 30
                    withholding:
                      type: boolean
                      nullable: true
                    inclusive:
                      type: boolean
                      nullable: true
                    id:
                      type: string
                      nullable: true
                      maxLength: 160
                    ieps_mode:
                      type: string
                      nullable: true
                      maxLength: 30
                    base:
                      type: number
                      nullable: true
                      minimum: 0
                      maximum: 1000000000000
                nullable: true
                maxItems: 30
              description:
                type: string
                nullable: true
                maxLength: 10000
              name:
                type: string
                nullable: true
                maxLength: 1000
              product_key:
                type: string
                nullable: true
                maxLength: 100
              unit_key:
                type: string
                nullable: true
                maxLength: 100
              unit_name:
                type: string
                nullable: true
                maxLength: 100
              id:
                type: string
                nullable: true
                maxLength: 160
              fid:
                type: string
                nullable: true
                maxLength: 160
              localId:
                type: string
                nullable: true
                maxLength: 160
              from:
                type: string
                nullable: true
                maxLength: 100
              owner:
                type: string
                nullable: true
                maxLength: 160
              team:
                type: string
                nullable: true
                maxLength: 160
              billingAccount:
                type: string
                nullable: true
                maxLength: 160
              timestamp:
                type: number
                nullable: true
                minimum: 0
                maximum: 1000000000000
              tax_included:
                type: boolean
                nullable: true
              localChanges:
                type: boolean
                nullable: true
              livemode:
                type: boolean
                nullable: true
              disabled:
                type: boolean
                nullable: true
              sku:
                type: string
                nullable: true
                maxLength: 1000
              property_tax_account:
                type: string
                nullable: true
                maxLength: 1000
              customs_keys:
                type: array
                items:
                  type: string
                  maxLength: 1000
                nullable: true
                maxItems: 100
              amounts:
                type: object
                additionalProperties: false
                properties:
                  taxes:
                    type: array
                    items:
                      type: object
                      additionalProperties: false
                      required:
                        - rate
                        - type
                      properties:
                        rate:
                          oneOf:
                            - type: number
                            - type: string
                              description: >-
                                Numeric string accepted by the request
                                validator.
                          minimum: 0
                          maximum: 100
                        type:
                          type: string
                          maxLength: 100
                        factor:
                          type: string
                          nullable: true
                          maxLength: 30
                        withholding:
                          type: boolean
                          nullable: true
                        inclusive:
                          type: boolean
                          nullable: true
                        id:
                          type: string
                          nullable: true
                          maxLength: 160
                        ieps_mode:
                          type: string
                          nullable: true
                          maxLength: 30
                        base:
                          type: number
                          nullable: true
                          minimum: 0
                          maximum: 1000000000000
                    nullable: true
                    maxItems: 30
                  subtotal:
                    type: number
                    nullable: true
                    minimum: 0
                    maximum: 1000000000000
                  total:
                    type: number
                    nullable: true
                    minimum: 0
                    maximum: 1000000000000
                  includedTaxes:
                    type: number
                    nullable: true
                    minimum: 0
                    maximum: 1000000000000
                  excludedTaxes:
                    type: number
                    nullable: true
                    minimum: 0
                    maximum: 1000000000000
                  withholdedTaxes:
                    type: number
                    nullable: true
                    minimum: 0
                    maximum: 1000000000000
                nullable: true
              third_party:
                type: object
                additionalProperties: false
                properties:
                  legal_name:
                    type: string
                    nullable: true
                    maxLength: 1000
                  tax_id:
                    type: string
                    nullable: true
                    maxLength: 100
                  tax_system:
                    type: string
                    nullable: true
                    maxLength: 100
                  zip:
                    type: string
                    nullable: true
                    maxLength: 30
                nullable: true
          minItems: 1
          maxItems: 200
        currency:
          type: string
          pattern: ^[A-Z]{3}$
        exchange:
          type: number
          nullable: true
          minimum: 1.e-8
          maximum: 1000000000
        description:
          type: string
          nullable: true
          maxLength: 10000
        metadata:
          type: object
          additionalProperties: true
          properties: {}
          nullable: true
        limitDaysToPay:
          type: integer
          nullable: true
          minimum: 1
          maximum: 3650
        automations:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - type
              - from
              - ref
              - action
            properties:
              type:
                type: string
                enum:
                  - invoice
              from:
                type: string
                enum:
                  - payments
              ref:
                type: string
                enum:
                  - payments
              action:
                type: string
                enum:
                  - create
          maxItems: 1
        custom_method_types:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - id
            properties:
              id:
                type: string
                enum:
                  - card
                  - oxxo
                  - bank
                  - customer_balance
                  - bank_account
                  - store
                  - hosted
          maxItems: 7
    PaymentLinkMutationResponse:
      type: object
      additionalProperties: false
      required:
        - success
        - data
        - operation
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          oneOf:
            - $ref: '#/components/schemas/PaymentLink'
            - type: object
              nullable: true
              enum:
                - null
          description: >-
            Current resource; null can coexist with a historical completed
            receipt.
        operation:
          $ref: '#/components/schemas/PaymentLinkOperation'
    ErrorResponse:
      allOf:
        - $ref: '#/components/schemas/StandardErrorResponse'
      description: Standardized error envelope.
      example:
        success: false
        error:
          code: invalid_request_body
          message: An error occurred
        timestamp: 1767225600000
    PaymentLink:
      type: object
      additionalProperties: false
      required:
        - id
        - team_id
        - livemode
        - status
        - amount
        - total
        - url
        - short_url
        - owner
        - created_at
        - updated_at
        - deleted_at
        - revision
        - effect_scope
        - views
        - historical_references
      properties:
        items:
          type: array
          items:
            type: object
            additionalProperties: true
          description: >-
            Stored selected-service snapshots. New writes use the complete typed
            item input contract.
        currency:
          type: string
          pattern: ^[A-Z]{3}$
        exchange:
          type: number
          nullable: true
          minimum: 1.e-8
          maximum: 1000000000
        description:
          type: string
          nullable: true
          maxLength: 10000
        metadata:
          type: object
          additionalProperties: true
          properties: {}
          nullable: true
        limitDaysToPay:
          type: integer
          nullable: true
          minimum: 1
          maximum: 3650
        automations:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - type
              - from
              - ref
              - action
            properties:
              type:
                type: string
                enum:
                  - invoice
              from:
                type: string
                enum:
                  - payments
              ref:
                type: string
                enum:
                  - payments
              action:
                type: string
                enum:
                  - create
          maxItems: 1
        custom_method_types:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - id
            properties:
              id:
                type: string
                enum:
                  - card
                  - oxxo
                  - bank
                  - customer_balance
                  - bank_account
                  - store
                  - hosted
          maxItems: 7
        id:
          type: string
          pattern: ^plink[A-Za-z0-9_-]{1,155}$
        team_id:
          type: string
        livemode:
          type: boolean
        status:
          type: string
          nullable: true
          description: >-
            active links may accept new payers; deleted links refuse new payer
            requests.
        amount:
          type: number
          nullable: true
        total:
          type: number
          nullable: true
        url:
          type: string
          nullable: true
        short_url:
          type: string
          nullable: true
          description: Null for newly created staging links; use url.
        owner:
          type: string
          nullable: true
        created_at:
          type: number
          nullable: true
        updated_at:
          type: number
          nullable: true
        deleted_at:
          type: number
          nullable: true
        revision:
          type: string
          pattern: ^[0-9a-f]{64}$
        effect_scope:
          type: string
          enum:
            - team_mode_payment_link
        views:
          type: integer
          minimum: 0
          nullable: true
          description: >-
            Saved historical view count; null means absent or unrecognized, not
            zero.
        historical_references:
          type: object
          required:
            - invoices
            - receipts
            - unresolved_count
            - authorization
          additionalProperties: false
          properties:
            invoices:
              type: array
              nullable: true
              items:
                pattern: ^[A-Za-z0-9_-]{1,160}$
                type: string
            receipts:
              type: array
              nullable: true
              items:
                pattern: ^[A-Za-z0-9_-]{1,160}$
                type: string
            unresolved_count:
              type: integer
              minimum: 0
            authorization:
              type: string
              enum:
                - resolve_each_resource
          description: >-
            Saved ID hints, not current document existence or access. Null
            arrays are absent/unrecognized; unresolved_count covers rejected
            entries. Read each target through its current scoped resource API
            before opening or acting. Does not enumerate all payments generated
            from the link.
    PaymentLinkOperation:
      type: object
      additionalProperties: false
      required:
        - operation_id
        - team_id
        - livemode
        - action
        - payment_link_id
        - status
        - completed_at
        - revision
        - effect_scope
      properties:
        operation_id:
          type: string
          format: uuid
        team_id:
          type: string
        livemode:
          type: boolean
        action:
          type: string
          enum:
            - create
            - update
            - delete
        payment_link_id:
          type: string
        status:
          type: string
          enum:
            - completed
        completed_at:
          type: number
        revision:
          type: string
        effect_scope:
          type: string
          enum:
            - team_mode_payment_link
    StandardErrorResponse:
      type: object
      description: >
        Standardized error envelope emitted by `sendErrorResponse` and its
        helpers

        (`sendValidationError`, `sendNotFoundError`, `sendUnauthorizedError`,

        `sendForbiddenError`, `sendConflictError`, `sendBadRequestError`,

        `sendInternalServerError`).
      required:
        - success
        - error
        - timestamp
      properties:
        success:
          type: boolean
          enum:
            - false
          example: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: >
                Stable machine-readable code. Values emitted by the shared
                helpers:

                `unauthorized`, `forbidden`, `invalid_token`,
                `validation_failed`,

                `invalid_request_body`, `missing_required_field`,
                `invalid_field_value`,

                `resource_not_found`, `resource_already_exists`,
                `resource_conflict`,

                `business_rule_violation`, `operation_not_allowed`,

                `insufficient_permissions`, `external_service_error`,

                `payment_processor_error`, `cfdi_service_error`,

                `internal_server_error`, `service_unavailable`,
                `rate_limit_exceeded`,

                `database_error`, `data_integrity_error`, `file_not_found`,

                `file_upload_error`, `invalid_file_format`. Individual handlers
                may

                emit additional endpoint-specific codes, documented per
                operation.
              example: validation_failed
            message:
              type: string
              example: Request validation failed
            details:
              oneOf:
                - type: string
                - type: array
                  items:
                    type: string
              description: >
                Present only when the handler supplies detail. Validation
                failures

                emit an array of `"<field path>: <message>"` strings.
              example:
                - 'currency: Field is required'
        timestamp:
          type: integer
          format: int64
          description: Server time in epoch milliseconds.
          example: 1767225600000
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        **Authentication Method:** HTTP Bearer token.


        The runtime requires the literal `Bearer ` prefix — a bare token in the

        `Authorization` header is rejected with `401 unauthorized`.


        **Header Format:** `Authorization: Bearer YOUR_API_KEY`


        Your API key is a JWT. Live keys operate on live data (`livemode:
        true`);

        test keys operate on isolated test data (`livemode: false`).


        **Get your key at:**
        [app.gigstack.pro/settings?tab=api](https://app.gigstack.pro/settings?tab=api)


        **Errors:** credential failures are answered by the authentication layer
        with a raw

        `{ "message": … }` body, not the standardized envelope — `401` for a
        missing, malformed or

        expired token, `403` for a revoked key or a plan without API access. See
        the `Unauthorized`

        and `AuthForbidden` responses.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.