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

# Create Payin

> Creates a payin (payment intent) for an order. Requires `order_id` and either `type` or `gateway_id`.

For card payments, the response includes a `direct_link` to the payment page.
For bank wire payments, the response includes bank transfer details in `provider`.




## OpenAPI

````yaml POST /payins
openapi: 3.1.0
info:
  title: Truust API
  version: '2.0'
  description: >
    The Truust API allows you to manage payment flows, orders, customers,
    wallets, and more.


    ## Authentication


    All authenticated endpoints require a Bearer token using your account's
    **Secret Key**.


    ```

    Authorization: Bearer {your_secret_key}

    ```


    Your API keys are available in the Dashboard under **Account Settings → API
    Developers**.
  contact:
    email: hello@truust.io
  license:
    name: Proprietary
servers:
  - url: https://{subdomain}.truust.io/2.0
    description: Production
    variables:
      subdomain:
        default: your-subdomain
        description: Your account subdomain
  - url: https://{subdomain}-sandbox.truust.io/2.0
    description: Sandbox
    variables:
      subdomain:
        default: your-subdomain
        description: Your account subdomain
security:
  - bearerAuth: []
tags:
  - name: Account
    description: Manage your Truust account
  - name: Customers
    description: Manage buyers and sellers (end users)
  - name: Orders
    description: Create and manage escrow payment orders
  - name: Payins
    description: Manage incoming payments for orders
  - name: Payouts
    description: Manage outgoing payments from orders
  - name: Wallets
    description: Manage customer and account wallets
  - name: Bank Accounts
    description: Manage bank accounts for payouts
  - name: Cards
    description: Manage tokenized payment cards
  - name: Subscriptions
    description: Manage recurring payment subscriptions
  - name: Verifications
    description: KYC verification for customers and accounts
  - name: Bundles
    description: Manage product bundles for orders
  - name: Refunds
    description: View refund records
paths:
  /payins:
    post:
      tags:
        - Payins
      summary: Create payin
      description: >
        Creates a payin (payment intent) for an order. Requires `order_id` and
        either `type` or `gateway_id`.


        For card payments, the response includes a `direct_link` to the payment
        page.

        For bank wire payments, the response includes bank transfer details in
        `provider`.
      operationId: createPayin
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - order_id
                - type
              example:
                order_id: 4950
                type: REDSYS_V2
                save_card: 1
              properties:
                order_id:
                  type: integer
                  description: ID of the order to pay.
                  example: 4950
                type:
                  type: string
                  description: >
                    Payment method type. Valid values include `BANKWIRE`,
                    `WALLET`, and any registered gateway type for the account

                    (e.g. `REDSYS_V2`, `ADDON`, `ADDON_V2`, `ADDON_ICE`,
                    `ADDON_HPP`, `ADDON_APPLE_PAY`, `AZUPAY`, `DCP`, `EPX`,

                    `REDSYS_APPLE_PAY`, `REDSYS_AUTH`, `STRIPE`, `DOCOMO`,
                    `SIBS_MBWAY`, `SIBS_MULTIBANCO`, `SEQURA`, `UNNAX`,

                    `PAYPAL`, `BIZUM`, `INESPAY`).
                  example: REDSYS_V2
                gateway_id:
                  type: integer
                  description: Gateway ID to use. Alternative to `type`.
                card_id:
                  type: integer
                  description: >-
                    Saved card ID to charge (for recurring or one-click
                    payments).
                wallet_id:
                  type: integer
                  description: Wallet ID to debit. Required when `type` is `WALLET`.
                save_card:
                  type: integer
                  enum:
                    - 0
                    - 1
                  description: Set to `1` to tokenize and save the card for future use.
      responses:
        '200':
          description: Payin created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payin'
        '404':
          $ref: '#/components/responses/ValidationError'
components:
  schemas:
    Payin:
      type: object
      properties:
        id:
          type: integer
        self:
          type: string
          example: /2.0/payins/456
        reference:
          type: string
          nullable: true
          description: Provider's payment reference ID.
        type:
          type: string
          description: Payment method type (e.g. `CARD`, `BANKWIRE`, `WALLET`).
        subtype:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - CREATED
            - AUTHORIZED
            - CONFIRMED
            - DENIED
            - REFUNDED
            - CANCELLED
        provider:
          type: object
          additionalProperties: true
          description: Raw provider response data.
        tag:
          type: string
          nullable: true
        direct_link:
          type: string
          format: uri
          nullable: true
          description: >-
            Payment page URL. Only present when status is `CREATED` or
            `AUTHORIZED`.
        created_at:
          type: string
          format: date-time
          nullable: true
        confirmed_at:
          type: string
          format: date-time
          nullable: true
        denied_at:
          type: string
          format: date-time
          nullable: true
        connections:
          $ref: '#/components/schemas/Connections'
    Connections:
      type: object
      description: Hypermedia links to related resources.
      additionalProperties:
        type: string
  responses:
    ValidationError:
      description: Validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: The given data was invalid.
              errors:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: string
                example:
                  name:
                    - The name field is required.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use your account's **Secret Key** as the Bearer token.

````