Pular para o conteúdo principal
POST
/
v1
/
qrcodes
/
dynamic
Criar QR code dinamico
curl --request POST \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/qrcodes/dynamic \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "IMMEDIATE",
  "key": "12345678901",
  "amount": 50,
  "recipientName": "João da Silva",
  "payer": {
    "document": "98765432100",
    "validate": true,
    "name": "Maria Santos"
  },
  "dueDate": "2024-12-31",
  "expirationTime": 3600,
  "city": "São Paulo",
  "zipCode": "01234567",
  "recipientConciliationId": "CONC123456789",
  "partnerId": "550e8400-e29b-41d4-a716-446655440001",
  "description": [
    {
      "name": "Invoice",
      "value": "INV-001"
    }
  ]
}
'
{
  "qrCode": "00020101021226850014br.gov.bcb.pix2563qrcode-h.jdpix.com.br/v2/cobv/9d36b84fc70b478fb95c12729b90ca255204000053039865802BR5913Merchant Name6009Sao Paulo62070503***63042C43"
}

Autorizações

​
Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Corpo

application/json
​
type
enum<string>
obrigatório

Especifica o tipo do QR Code. Para IMMEDIATE, indica um QR Code de uso unico gerado para pagamentos PIX instantaneos com valor predefinido e tempo de expiracao.

Opções disponíveis:
IMMEDIATE
Exemplo:

"IMMEDIATE"

​
key
string
obrigatório

Chave PIX do destinatario.

Exemplo:

"12345678901"

​
amount
number<double>
obrigatório

Valor para o QR code dinamico.

Exemplo:

50

​
recipientName
string
obrigatório

Nome do destinatario (beneficiario).

Exemplo:

"João da Silva"

​
payer
object
obrigatório

Informacoes do pagador.

​
dueDate
string<date>
obrigatório

Data de vencimento do pagamento (AAAA-MM-DD).

Exemplo:

"2024-12-31"

​
expirationTime
integer
obrigatório

Tempo de expiracao em segundos apos o qual o QR code se torna invalido.

Exemplo:

3600

​
city
string
obrigatório

Cidade do destinatario.

Exemplo:

"São Paulo"

​
zipCode
string
obrigatório

CEP do destinatario (8 digitos).

Exemplo:

"01234567"

​
recipientConciliationId
string
obrigatório

Identificador para conciliacao pelo destinatario.

Exemplo:

"CONC123456789"

​
partnerId
string<uuid>
obrigatório

Identificador do sistema parceiro.

Exemplo:

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

​
description
object[]
obrigatório

Lista de descricoes para o pagamento.

Resposta

QR code dinamico criado com sucesso

​
qrCode
string
obrigatório

String do QR code PIX gerado.

Exemplo:

"00020101021226850014br.gov.bcb.pix2563qrcode-h.jdpix.com.br/v2/cobv/9d36b84fc70b478fb95c12729b90ca255204000053039865802BR5913Merchant Name6009Sao Paulo62070503***63042C43"