Criar cobrança PIX

/invoice-pix

Status possíveis:

Atualmente a cobrança por pix só pode ter três status possíveis

  • Criado (created) - Pagamento criado
  • Pendente (pending) - Aguardando o pagamento
  • Pago (paid) - Pagamento realizado
  • Cancelado (canceled) - Error no pagamento ou cobrança cancelada
  • Body Params
    string
    required

    ID do pagador referente

    string
    required

    Nome da cobrança

    int32
    required
    Defaults to 100

    Montante da cobrança

    date

    Validade de cobrança (YYYY-MM-DD)

    string

    Descrição da cobrança

    float
    Defaults to 0.1

    Penalidade após atraso. Valor em porcentagem (ex.: se for 10%, deve ser informado 0.1)

    string
    required
    Defaults to unique

    Sempre "unique"

    string
    required
    Defaults to pix

    Sempre "pix"

    int32
    Defaults to 8600

    Tempo de duração do QR Code em segundos

    string
    Defaults to 321323

    Identificador de referência do cliente

    boolean
    Defaults to false

    Define único documento para cash in a partir do Pagador registrado

    Headers
    string
    required

    Bearer Token gerado no processo de autenticação

    string
    required
    Defaults to application/json

    Tipo de conteúdo que será enviado no Body da requisição

    Response

    Language
    Credentials
    OAuth2
    LoadingLoading…
    Response
    Click Try It! to start a request and see the response here! Or choose an example:
    application/json