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

# CashIn

> Cria uma nova transação de entrada (cash-in)



## OpenAPI

````yaml POST /transaction/cash-in
openapi: 3.0.1
info:
  title: 3X Pay Gateway
  description: >-
    Para autenticar as rotas dessa API são necessario ter em mãos a
    **api_secret** e **api_key** da sua conta. Este podem ser encontrados dentro
    do painel https://app.3xpay.co acessando a página de Configurações e
    clicando na opção de Credencias de API.
  version: 1.0.0
servers:
  - url: https://gateway.3xpay.co
security:
  - apiKeyAuth: []
    apiSecretAuth: []
tags:
  - name: Transações
    description: Operações relacionadas a transações financeiras
  - name: Webhooks
    description: Notificações de eventos da API
  - name: Balance
    description: Operações relacionadas ao saldo da conta
  - name: Sub-accounts
    description: Operações relacionadas a subcontas BaaS
  - name: MED Contest
    description: >-
      Endpoints server-to-server para responder a solicitações de MED (Mecanismo
      Especial de Devolução do Pix)
paths:
  /transaction/cash-in:
    post:
      tags:
        - Transações
      summary: CashIn
      description: Cria uma nova transação de entrada (cash-in)
      operationId: createCashIn
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CashInRequest'
      responses:
        '201':
          description: Transação criada com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CashInResponse'
components:
  schemas:
    CashInRequest:
      type: object
      properties:
        transaction:
          type: object
          required:
            - amount
            - callback_url
            - external_id
          properties:
            amount:
              type: number
              description: O valor a ser transacionado
            callback_url:
              type: string
              description: A URL para a qual o callback da transação será enviado
            external_id:
              type: string
              description: O identificador externo para a transação
            expiration:
              type: number
              description: A data de expiração em segundos do QRCode
              example: 3600
            custom_message:
              type: string
              description: Mensagem customizada para o pagador
              example: Pix para o pedido 123456
              maxLength: 130
            debtor:
              type: object
              required:
                - name
                - document
              properties:
                name:
                  type: string
                  description: Nome do pagador
                  example: João da Silva
                document:
                  type: string
                  description: Documento do pagador (CPF) apenas números
                  example: '12345678901'
    CashInResponse:
      type: object
      properties:
        status:
          type: string
          description: Status da transação
          example: PENDING
        payment:
          type: object
          properties:
            status:
              type: string
              description: Status do pagamento
              example: PENDING
            transaction_id:
              type: string
              description: ID da transação
              example: W5qrXoQ6Me5kfw1mEaTsn9lizo
            payment_code:
              type: string
              description: Código de pagamento PIX
            link:
              type: string
              description: Link para pagamento
            total:
              type: number
              description: Valor total da transação
        transaction_id:
          type: string
          description: ID único da transação
          example: 756afe09-0471-4124-9f35-6691fa130f5b
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: api_key
    apiSecretAuth:
      type: apiKey
      in: header
      name: api_secret

````