CreatePixChargeRequest

Schema: CreatePixChargeRequest

OpenAPI Specification

openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths: {}
components:
  schemas:
    CreatePixChargeRequest:
      type: object
      required:
        - payerName
        - payerDocument
      properties:
        quoteId:
          type: string
          description: Quote identifier. Required if 'amount' is not provided.
        amount:
          type: number
          minimum: 5
          description: Amount in BRL. Required if 'quoteId' is not provided.
        payerName:
          type: string
          description: Payer's full name.
        payerDocument:
          type: string
          description: Payer's CPF or CNPJ (numbers only, 11 or 14 digits).
        merchantExternalId:
          type: string
          description: Merchant's external identifier for the transaction.
      description: |
        Only one of the fields 'quoteId' or 'amount' should be provided.
      x-apifox-orders:
        - quoteId
        - amount
        - payerName
        - payerDocument
        - merchantExternalId
      x-apifox-folder: ''
  securitySchemes: {}
servers: []
security: []