GuidesCommunity
Guides

Emissão de QR Code com Boleto Vinculado

Cobrança via QR Code Dinâmico (PIX) com Boleto vinculado

Suggest Edits

Uma cobrança Pix é um meio de cobrança de recursos por meio de uma emissão de um QR Code, a ser pago pelo no sistema Pix.

Tecnicamente, você estará criando uma cobrança para uma terceira pessoa (física ou jurídica) pagar e, em seguida, o saldo desta cobrança será creditado na wallet vinculada a chave EVP especificada, no fluxo do Produto de PIX-Boleto, após a entrada desse PIX IN, o boleto vinculado na emissão do QR Code, automaticamente é liquidado através do Produto Pagamento de Contas.

Usado para:

  • Emitir uma cobrança para terceiros através de um QR Code, com um boleto vinculado, a ser pago por qualquer aplicativo que utilize sistema Pix;
  • Pagar o boleto vinculado;

Como emitir uma cobrança - QR Code com Boleto vinculado

ENDPOINT: https://kaizen.bt-staging.app/pix-boleto/wallets/{walletId}/qrcodes

Esse endpoint utiliza o método POST.

Modelo de requisição:

https://{{baseurl}}/pix-boleto/wallets/{{walletId}}/qrcodes?type=dynamic&output={{output}}

curl --location "https://kaizen.bt-staging.app/pix-boleto/wallets/930c6c45-b3ae-463b-8558-3b4e989e4146/qrcodes?type=dynamic&output=json" \
--header "x-client-external-id: PIBzt255j9fUkiXkxQldiK6dO2" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer TOKEN" \
--data-raw "{
    \"destination\": \"529a41f4-bfad-444e-9fb5-80346919b079\",
    \"amount\": \"1.46\",
    \"digitableLine\": \"23793381286008301352856000063307789840000150000\", 
    \"city\": \"Jijoca de Jericoacoara\", 
    \"customID\": \"custom_EMDUCXC1153\",
    \"expiresAt\": \"2023-10-30T21:00:00.000Z\", 
    \"mcc\": \"7399\", 
    \"payer\": {
        \"name\": \"Mr. Ruby Sporer @ staging Pagador do Pix Boleto\",
        \"taxId\": \"60110492999\"
    }
}

"

{
	"destination": "{{chaveEVP}}",
	"amount": "{{amount}}",
	"digitableLine": "{{digitableLineReal}}", 
	"city": "Sao Paulo",
	"customID": "customid",
	"expiresAt": "2023-10-30T21:00:00.000Z", 
	"mcc": "7399", 
	"payer": {
		"name": "Fulano Pagador",
		"taxId": "{{taxId}}"
 },
    "description": "Descricao de PIX",
    "externalCustomerName": "PIBcustomerName"
}

Header da requisição:

Os campos a serem preenchidos no Header da requisição são:

campodescrição
x-client-external-id- header opcional, caso não seja informado, a aplicação fará a geração automática do mesmo

📘

Sugestão

Para facilitar os próximos fluxos, como de Consultar uma Transação, obtenha o "x-client-external-id" presente no header do response da emissão.

Parâmetros da requisição:

Os parâmetros para essa requisição são:

parâmetrodescrição
type- dynamic
outputDefine o formato da saída desejado
- raw
- json
- png
- svg
- url
- base64

❗️

Observações

O campo type deve ser informado nos parâmetros sempre como "dynamic".
O output raw equivale ao link do formato "Pix copia e cola" conhecido nos meios de pagamentos.

❗️

Pagamento de um boleto em ambiente de teste

Para realizar o pagamento de um boleto no nosso ambiente de teste é necessário acionar o endpoint que realiza a liquidação de um boleto.

As orientações se encontram na seguinte página

Descrição dos campos:

CampoTipoDescrição
destinationstring(uuid)- chave EVP que receberá o valor da cobrança emitida, após o seu pagamento
amountstring(00.00)- valores da cobrança com casa decimal separada por ponto
- deverá ser o mesmo valor do boleto vinculado
digitableLinestring(47 || 48 chars )- linha digitável do boleto vinculado ao QR Code que será liquidado após o pagamento do PIX
- mais informações sobre as diferencas entre boleto de títulos e boleto de concessionárias acesse o link https://developers.bitcapital.com.br/docs/descri%C3%A7%C3%A3o-do-produto-1
citystring(15)- por questões de PLDFT é necessário declarar a cidade que esta sendo criada o QR Code
customIDstring(50)- campo disponibilizado para personalização com a inclusão de um identificador único, caso seja necessário adaptá-lo a um sistema personalizado desenvolvido para o cliente.
- este campo permite até 50 caracteres, oferecendo flexibilidade na personalização.
- é importante destacar que essa customização não é visível no pagamento do QR Code
expiresAtstring(ISO8601)- O campo designado para a data e hora de expiração do QR Code deve ser preenchido.
- Caso a data de expiração não seja informada, será automaticamente estabelecida uma expiração de 24 horas a partir do momento da emissão.
- O formato da data e hora deve seguir o padrão ISO8601, considerando o fuso horário UTC0.
mccstring(4)- é um código numérico de quatro dígitos usado no sistema de pagamento de cartão de crédito para categorizar o tipo de atividade comercial de um estabelecimento. Isso ajuda a classificar as transações de acordo com o tipo de compra, como em restaurantes, lojas de eletrônicos ou postos de gasolina.
payer.namestring(50)- nome do pagador
payer.taxIdstring(11)- CPF do pagador
descriptionstring- Descrição do pagamento
externalCustomerNamestring- Nome do Cliente

👍

Informação!

MCC é um código numérico de quatro dígitos usado no sistema de pagamento de cartão de crédito para categorizar o tipo de atividade comercial de um estabelecimento. Isso ajuda a classificar as transações de acordo com o tipo de compra, como em restaurantes, lojas de eletrônicos ou postos de gasolina.

MCCs 0001–1499: Agricultural Services
MCCs 1500–2999: Contracted Services
MCCs 4000–4799: Transportation Services
MCCs 4800–4999: Utility Services
MCCs 5000–5599: Retail Outlet Services
MCCs 5600–5699: Clothing Stores
MCCs 5700–7299: Miscellaneous Stores
MCCs 7300–7999: Business Services
MCCs 8000–8999: Professional Services and Membership Organizations
MCCs 9000–9999: Government Services

Modelo de resposta:

{
	"createdAt": "2023-10-06T15:44:24.011Z",
	"updatedAt": "2023-10-06T15:44:24.273Z",
	"expiresAt": "2023-10-30T16:00:00.000Z",
	"walletId": "930c6c45-b3ae-463b-8558-3b4e989e4146",
	"emv": {
		"payloadFormatIndicator": "01",
		"pointOfInitiationMethod": "12",
		"merchantCategoryCode": "0000",
		"transactionCurrency": "986",
		"transactionAmount": "1.06",
		"countryCode": "BR",
		"merchantName": "Pixoleto",
		"merchantCity": "Jijoca de Jeric",
		"additionalData": {
			"referenceLabel": "***"
		},
		"merchantAccountInformationPix": {
			"gui": "br.gov.bcb.pix",
			"url": "qrcode-h.pixparati.app/pix/v2/1c1bcf74-dc52-411c-9ed6-a15a4748ae95"
		}
	},
	"status": "pending_payment",
  "externalCustomerName": "PIBCUSTOMERNAME_P"
}

00020101021226850014br.gov.bcb.pix2563qrcode-h.pixame.app/pix/v2/1fad356d-2e9f-40e0-914f-cc95915e3fdb520400005303986540588.005802BR5924Kaizen pix-cobranca prod6009Sao Paulo62070503***6304C26A



MDAwMjAxMDEwMjEyMjY4NTAwMTRici5nb3YuYmNiLnBpeDI1NjNxcmNvZGUtaC5waXhhbWUuYXBwL3BpeC92Mi83N2U1YmIwYi1mZTVmLTQ5YmEtODdlYS00NmM1Njc0Y2VkNjM1MjA0MDAwMDUzMDM5ODY1NDA1ODguMDA1ODAyQlI1OTI0S2FpemVuIHBpeC1jb2JyYW5jYSBwcm9kNjAwOVNhbyBQYXVsbzYyMDcwNTAzKioqNjMwNDAwRUM=
exemplo de output svg e png

exemplo de output svg e png

Updated 10 months ago