CreatePixChargeRequest

Para o merchant: envie merchantId (existente) ou o objeto merchant (cria/atualiza pelo externalId) — nunca os dois juntos. A mesma regra vale para resellerId vs reseller. As regras de split vão em merchant.recipients.

  • amount
    Type: integer
    min:  
    1
    required

    Valor em centavos.

  • callbackUrl
    Type: stringFormat: uri
    required

    URL que receberá o webhook de confirmação.

  • expiresIn
    Type: integer

    Validade da cobrança em segundos (padrão 600).

  • generatedDocument
    Type: string

    CPF/CNPJ do pagador (opcional).

  • generatedEmail
    Type: stringFormat: email

    E-mail do pagador (opcional).

  • generatedName
    Type: string
    max length:  
    100

    Nome do pagador (opcional). Apenas letras e espaços.

  • merchant
    Type: object · PixMerchantInline

    Cria ou atualiza um merchant (identificado pelo externalId) no momento da cobrança. Inclua recipients para definir as regras de split aplicadas a este pagamento.

    • externalId
      Type: string
      min length:  
      1
      required

      ID do merchant no seu sistema — é a chave de upsert.

    • name
      Type: string
      min length:  
      1
      required
    • commissionBasisPoints
      Type: integer
      min:  
      0
      max:  
      10000

      Comissão do merchant em basis points (5000 = 50%).

    • recipients
      Type: array object[] · SplitRecipient[] 1…10

      Regras de split: entre quem o valor é dividido (até 10 recebedores).

  • merchantId
    Type: stringFormat: uuid

    ID de um merchant já existente. Use no lugar de merchant.

  • reseller
    Type: object · PixResellerInline
    • externalUserId
      Type: string
      min length:  
      1
      required

      ID do reseller no seu sistema.

    • username
      Type: string
      min length:  
      1
      required
    • commissionPercentage
      Type: number
      min:  
      0
      max:  
      100

      Comissão do reseller, em %.

  • resellerId
    Type: stringFormat: uuid

    ID de um reseller já existente. Use no lugar de reseller.

PayerPix