Emissão de QR Codes dinâmicos

post

https://api-mtls.sandbox.bankly.com.br/pix/qrcodes/dynamic/payment

Realize a emissão de um QR Code dinâmico. Para isso, é necessário possuir uma chave no DICT registrada previamente.

stable scope: pix.qrcode-dynamic-payment.create

[block:callout] { "type": "info", "title": "Nota", "body": "Para mais informações, confira a documentação [Emissão de QR Codes dinâmicos](/docs/pix-emissao-qrcode-dinamico)." } [/block]

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

addressingKey

object

required

Objeto que deverá conter os dados da chave Pix a ser cadastrada.

recipientName

string | null

Nome do recebedor da transação. O valor máximo é de 250 caracteres para esse campo.

conciliationId

string | null

O ID de conciliação é uma informação utilizada para conciliação dos pagamentos. Ela permite que você identifique a qual QR Code um determinado pagamento pertence. Importante: esse campo deve ter no mínimo 26 e no máximo 35 caracteres, e não são aceitos caracteres especiais.

additionalData

array of objects | null

Lista contendo um ou mais subcampos, criados pelo emissor, para descrever informações adicionais. Este valor é somente leitura.

additionalData

singlePayment

boolean

Para que um QR Code possa ser utilizado apenas uma vez, esse campo deve ser preenchido com true. Se este campo não for enviado ou estiver como false, será possível utilizá-lo em mais de um pagamento.

payer

object

required

Objeto que contém informações sobre o pagador.

changeAmountType

string

enum

Campo que indica se o valor a ser pago pode (“ALLOWED”) ou não ("NOT_ALLOWED") ser alterado no momento da transação. Caso o campo seja preenchido com “ALLOWED”, não é necessário preencher o campo amount, que assumirá automaticamente o valor "0", permitindo a alteração do montante no momento da transação. Se o valor "NOT_ALLOWED" for informado, o campo amount deverá ser preenchido obrigatoriamente com o valor a ser transacionado.

Allowed:

amount

double

Valor a ser pago.

expiresAt

date-time

Data e hora em que o QR Code deve expirar. Caso esse campo não seja informado, o QR Code irá expirar em 24h.

Headers

api-version

string

required

Defaults to 1

Versão da API. Atualmente estamos na 1.0.

x-bkly-pix-user-id

string

required

Número do documento do usuário que está fazendo a requisição. Informe somente números para CPF e caracteres alfanuméricos para CNPJ, sem formatação.

Authorization

string

required

Token de autorização do tipo Bearer.

Responses

200QR Code emitido com sucesso.

400Há algum problema com a sua requisição.

422A sintaxe da requisição está correta, mas não foi possível processá-la devido a uma regra de negócio.