PixWithdrawalRequest

Schema: PixWithdrawalRequest

OpenAPI Specification

openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths: {}
components:
  schemas:
    PixWithdrawalRequest:
      type: object
      required:
        - pixKey
        - pixKeyType
        - payeeDocument
      properties:
        pixKey:
          type: string
          description: Recipient's PIX key.
        pixKeyType:
          $ref: '#/components/schemas/PixKeyType'
        brlAmount:
          type: number
          minimum: 6
          maximum: 10000
          description: Amount to be transferred in BRL.
        usdtAmount:
          type: number
          minimum: 1
          maximum: 10000
          description: Amount to be transferred in BRL but referenced in usdt.
        payeeDocument:
          type: string
          description: Recipient's CPF or CNPJ (numbers only, 11 or 14 digits).
        message:
          type: string
          description: Optional message to the recipient.
        merchantExternalId:
          type: string
          description: Merchant's external identifier.
      x-apifox-orders:
        - pixKey
        - pixKeyType
        - brlAmount
        - usdtAmount
        - payeeDocument
        - message
        - merchantExternalId
      x-apifox-folder: ''
    PixKeyType:
      type: string
      enum:
        - CPF
        - CNPJ
        - PHONE
        - EMAIL
        - EVP
      description: Type of PIX key.
      x-apifox-folder: ''
  securitySchemes: {}
servers: []
security: []