Initialize Pix Checkout session

Inicializa uma sessão de Pix Checkout para um estabelecimento cadastrado no
tenant. Retorna um transactionalToken de curta duração que deve ser usado no
subsequente POST /v1/acquiring/pix/checkout para criar a cobrança Pix.

Importante: documentId é o CPF/CNPJ do estabelecimento (merchant), não do
pagador
. Antes de chamar, o merchant precisa existir em autra.merchants do
tenant que está gerando o token — se receber MERCHANT_NOT_FOUND, confirme com o
suporte que o merchant está provisionado.

Fluxo interno: este endpoint faz um proxy à API da Dock (Pix). Se a Dock
rejeitar (status ≠ ACCEPTED), o corpo e o status HTTP da Dock são
encaminhados diretamente.

Diferença do irmão /v1/acquiring/payments/initialize: aquele é para
cartão (crédito/débito); este é o fluxo Pix. Compartilham a mesma implementação
de merchant/tenant validation, mas cada um chama uma URL Dock diferente.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

CPF (11 dígitos) ou CNPJ (14 dígitos) do estabelecimento, somente números.

string

Override opcional do tenant vinculado ao token OAuth. Usado em
cenários multi-tenant onde uma credencial ampla resolve merchants
de tenants distintos. Só configure quando orientado pelo suporte
— em uso normal deixe vazio para o tenant ser inferido do JWT.

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