MerchantPayOutTransaction

Schema: MerchantPayOutTransaction

OpenAPI Specification

openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths: {}
components:
  schemas:
    PixKeyType:
      type: string
      enum:
        - CPF
        - CNPJ
        - PHONE
        - EMAIL
        - EVP
      description: Type of PIX key.
      x-apifox-folder: ''
    MerchantPayOutTransaction:
      allOf:
        - $ref: '#/components/schemas/BaseMerchantTransaction'
        - type: object
          required:
            - amount
            - netAmount
            - fee
            - currency
          properties:
            type:
              type: string
              enum:
                - pay-out
              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.
            pixKey:
              type: string
              description: Recipient's PIX key.
            pixKeyType:
              $ref: '#/components/schemas/PixKeyType'
            payeeDocument:
              type: string
              description: Recipient's CPF or CNPJ.
            payeeName:
              type: string
              description: Recipient's full name.
            payeeAccount:
              type: string
              description: Recipient's account number.
            payeeBranch:
              type: string
              description: Recipient's bank branch.
            payeeBankcode:
              type: string
              description: Recipient's bank code.
            payeeBankname:
              type: string
              description: Recipient's bank name.
          x-apifox-orders:
            - type
            - amount
            - netAmount
            - fee
            - currency
            - pixKey
            - pixKeyType
            - payeeDocument
            - payeeName
            - payeeAccount
            - payeeBranch
            - payeeBankcode
            - payeeBankname
      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: []