MerchantPayInTransaction

Schema: MerchantPayInTransaction

OpenAPI Specification

openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths: {}
components:
  schemas:
    MerchantPayInTransaction:
      allOf:
        - $ref: '#/components/schemas/BaseMerchantTransaction'
        - type: object
          required:
            - amount
            - netAmount
            - fee
            - currency
          properties:
            type:
              type: string
              enum:
                - pay-in
              description: Transaction type.
            amount:
              type: number
              description: Transaction amount.
            netAmount:
              type: number
              description: Net amount after fees.
            fee:
              type: object
              properties:
                percentage:
                  type: number
                  description: Fee percentage.
                fixed:
                  type: number
                  description: Fixed fee amount.
              x-apifox-orders:
                - percentage
                - fixed
            currency:
              type: string
              enum:
                - brl
                - usdt
              description: Currency used.
            qrCode:
              type: string
              description: QR Code in base64 format.
            pixCode:
              type: string
              description: PIX code.
            payerName:
              type: string
              description: Payer's full name.
            payerDocument:
              type: string
              description: Payer's CPF or CNPJ.
            payerAccount:
              type: string
              description: Payer's account number.
            payerBranch:
              type: string
              description: Payer's bank branch.
            payerBankcode:
              type: string
              description: Payer's bank code.
            payerBankname:
              type: string
              description: Payer's bank name.
          x-apifox-orders:
            - type
            - amount
            - netAmount
            - fee
            - currency
            - qrCode
            - pixCode
            - payerName
            - payerDocument
            - payerAccount
            - payerBranch
            - payerBankcode
            - payerBankname
      x-apifox-folder: ''
    BaseMerchantTransaction:
      type: object
      required:
        - transactionId
        - type
        - status
        - createdAt
        - updatedAt
      properties:
        transactionId:
          type: string
          description: Unique identifier of the transaction.
        merchantExternalId:
          type: string
          description: Merchant's external identifier.
        type:
          type: string
          description: Type of the transaction.
        status:
          type: string
          description: Current status of the transaction.
        createdAt:
          type: string
          format: date-time
          description: Creation date and time.
        updatedAt:
          type: string
          format: date-time
          description: Last update date and time.
      x-apifox-orders:
        - transactionId
        - merchantExternalId
        - type
        - status
        - createdAt
        - updatedAt
      x-apifox-folder: ''
  securitySchemes: {}
servers: []
security: []