Create Pix checkout

Cria uma cobrança Pix avulsa para um estabelecimento e retorna o QR Code
copia-e-cola
que deve ser exibido ao pagador.

Pré-requisito: ter obtido um transactionalToken no
POST /v1/acquiring/pix/initialize do mesmo documentId. O token expira em
minutos — gere um novo se receber erro de token expirado.

Fluxo:

  1. POST /v1/acquiring/pix/initialize — recebe transactionalToken
  2. POST /v1/acquiring/pix/checkout (esse endpoint) — envia
    transactionalToken + documentId + amount; recebe qrCode e pixId
  3. Exibe o QR Code ao pagador
  4. Confirmação de pagamento chega via webhook (configurado por tenant)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Token retornado por POST /v1/acquiring/pix/initialize para o
mesmo documentId. Prefixo Bearer é aceito e removido pelo backend.

string
required

CPF (11 dígitos) ou CNPJ (14 dígitos) do estabelecimento, somente números — precisa bater com o do initialize.

double
required

Valor da cobrança em reais (maior que zero). Duas casas decimais.

string

Código ISO 4217 da moeda. Hoje apenas BRL é aceito.

string

Descrição livre da cobrança (aparece no comprovante Pix quando suportado).

string

ID do pedido no sistema do merchant (útil para reconciliação via webhook).

Responses

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