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

# Get a Link for the User to Pay by Card

> Get a ready-made web page link that lets one of your users pay a fixed
amount with their card. You show this page inside your own website
(inside an iframe). The user enters their card on that page, taps
**Pay**, and we charge the card.

### What you need to send
- ``user_id`` — the user who will pay.
- ``amount`` — the amount to charge, in major units (e.g. ``12.50``).
- ``currency`` — optional ISO currency code; defaults to ``USD``.
- ``card_processing_id`` — optional; pin the charge to one specific
  approved card-processing account.

### What you get back
- ``payment_intent_id`` — the recorded payment. It is created straight
  away in a ``pending`` state and shows up in your payment listings, so
  you can track or reconcile it. It becomes ``succeeded`` or ``failed``
  once the user pays.
- ``pay_url`` — the link to load inside an iframe. It can be used once.
- ``expires_at`` — the time the link stops working (about 10 minutes).

### How you find out the result
The user sees the outcome on the page itself. Your server is also
notified by a ``payment_intent.succeeded`` or ``payment_intent.failed``
webhook carrying the ``payment_intent_id``.

The page also offers the user a "save card for future use" choice; when
they accept, the card is stored so they can reuse it later.

The link contains no details about which company processes the card
behind the scenes. Treat it as a plain string with no meaning of its own.



## OpenAPI

````yaml POST /v1/platform/card/payment-link
openapi: 3.1.0
info:
  title: Finogate Platform API v1
  version: 0.1.0
servers:
  - url: https://api-sandbox.finogates.com
    description: Sandbox
  - url: https://api.finogates.com
    description: Production
security: []
tags:
  - name: auth
  - name: users
  - name: payees
  - name: verification
  - name: bank accounts
  - name: card processing
  - name: digital-assets
  - name: international
  - name: onboarding
  - name: pending-applications
  - name: wallets
  - name: payments
  - name: catalog
  - name: webhooks
  - name: phone-numbers
  - name: sms
  - name: calls
  - name: listings
  - name: embed-tokens
paths:
  /v1/platform/card/payment-link:
    post:
      tags:
        - card processing
      summary: Get a Link for the User to Pay by Card
      description: >-
        Get a ready-made web page link that lets one of your users pay a fixed

        amount with their card. You show this page inside your own website

        (inside an iframe). The user enters their card on that page, taps

        **Pay**, and we charge the card.


        ### What you need to send

        - ``user_id`` — the user who will pay.

        - ``amount`` — the amount to charge, in major units (e.g. ``12.50``).

        - ``currency`` — optional ISO currency code; defaults to ``USD``.

        - ``card_processing_id`` — optional; pin the charge to one specific
          approved card-processing account.

        ### What you get back

        - ``payment_intent_id`` — the recorded payment. It is created straight
          away in a ``pending`` state and shows up in your payment listings, so
          you can track or reconcile it. It becomes ``succeeded`` or ``failed``
          once the user pays.
        - ``pay_url`` — the link to load inside an iframe. It can be used once.

        - ``expires_at`` — the time the link stops working (about 10 minutes).


        ### How you find out the result

        The user sees the outcome on the page itself. Your server is also

        notified by a ``payment_intent.succeeded`` or ``payment_intent.failed``

        webhook carrying the ``payment_intent_id``.


        The page also offers the user a "save card for future use" choice; when

        they accept, the card is stored so they can reuse it later.


        The link contains no details about which company processes the card

        behind the scenes. Treat it as a plain string with no meaning of its
        own.
      operationId: create_card_payment_link_v1_platform_card_payment_link_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardPaymentLinkCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - _AuthenticatedBearer: []
components:
  schemas:
    CardPaymentLinkCreate:
      properties:
        user_id:
          type: string
          format: uuid
          title: User Id
          description: >-
            The end-user who will pay. Must be an ``end_user`` belonging to the
            calling tenant.
        amount:
          anyOf:
            - type: number
              exclusiveMinimum: 0
            - type: string
              pattern: >-
                ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$)
          title: Amount
          description: Amount to charge, in major units (e.g. ``12.50``).
        currency:
          type: string
          maxLength: 3
          minLength: 3
          title: Currency
          description: ISO-4217 currency code. Defaults to ``USD``.
          default: USD
        card_processing_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Card Processing Id
          description: >-
            Optional. Pins the charge to a specific approved card-processing
            merchant account (the ``id`` returned by ``GET
            /v1/platform/card-processing/users/{user_id}``). Omit to use the
            user's deterministically selected default merchant.
      type: object
      required:
        - user_id
        - amount
      title: CardPaymentLinkCreate
      description: |-
        Request body for ``POST /v1/platform/card/payment-link``.

        Mints a one-time hosted card-payment page for the end user. The
        ``amount`` is recorded on the resulting payment record and is the
        authoritative figure charged — it is never re-read from the browser.
    CommonResponse:
      properties:
        status_code:
          type: integer
          title: Status Code
          description: HTTP status code for the response.
        data:
          title: Data
          description: Payload or error details.
        query_generated_time:
          type: integer
          title: Query Generated Time
          description: >-
            UTC timestamp (milliseconds since epoch) when response was
            generated.
      type: object
      required:
        - status_code
        - data
        - query_generated_time
      title: CommonResponse
      description: |-
        Standard response wrapper for single-object responses and errors.

        Generic over the payload type. A route that declares
        ``CommonResponse[SomeModel]`` gets the real ``data`` schema rendered in
        OpenAPI/Swagger; a bare ``CommonResponse`` leaves ``data`` untyped.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    _AuthenticatedBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /v1/platform/auth/token

````