Skip to main content
POST
Gerar cobrança PIX (Cash-In)

Autorizações

Authorization
string
header
obrigatório

Enter JWT token

Corpo

application/json
transaction
object
obrigatório

Dados da transação

payer
object
obrigatório

Dados do pagador

additionalInfo
object

Informações adicionais (objeto chave-valor string:string, máximo 10 chaves)

Exemplo:

Resposta

Cobrança PIX gerada com sucesso

transactionId
string
obrigatório

Identificador único da transação gerada

Exemplo:

"123"

correlationId
string
obrigatório

ID de correlação da transação (UUID)

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

externalId
string
obrigatório

ID externo da transação (mesmo valor do input)

Exemplo:

"external-teste-01"

status
enum<string>
obrigatório

Status da transação

Opções disponíveis:
PENDING,
CONFIRMED,
ERROR
Exemplo:

"PENDING"

pixCode
string
obrigatório

Código Pix no formato padrão EMV

Exemplo:

"00020126580014br.gov.bcb.pix..."

generateTime
string
obrigatório

Data e hora de geração do Pix (formato ISO 8601)

Exemplo:

"2024-01-15T10:30:00.000Z"

expirationDate
string
obrigatório

Data e hora de expiração do Pix (formato ISO 8601)

Exemplo:

"2024-01-16T10:30:00.000Z"

qrCodeImage
string

QR Code em Base64 (apenas quando generateQrCode=true)

Exemplo:

"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."