13 - QR Code - Billing

Scopes:

api.pix api.qrcode.criarcobranca

Cria um QR Code de cobrança para pagamento através de Pix.

cURL

curl --request POST \
  --url https://api.ext.pix.dbs.moneyp.com.br/api/v2/QRCode/Cobranca \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '
{
  "contaDto": {
    "agencia": "<string>",
    "agenciaDigito": "<string>",
    "conta": "<string>",
    "contaDigito": "<string>",
    "contaPgto": "<string>",
    "tipoConta": 1,
    "modeloConta": 1
  },
  "qrCode": {
    "chave": "<string>",
    "tipoChave": 0,
    "taxId": "<string>",
    "valor": 123,
    "devedor": {
      "nome": "<string>",
      "documentoFederal": "<string>",
      "tipoPessoa": 1
    },
    "infosAdicionais": {
      "nome": "<string>",
      "valor": "<string>"
    },
    "juros": {
      "data": "2023-11-07T05:31:56Z",
      "tipo": 1,
      "valor": 123
    },
    "multa": {
      "data": "2023-11-07T05:31:56Z",
      "tipo": 1,
      "valor": 123
    },
    "desconto": {
      "data": "2023-11-07T05:31:56Z",
      "tipo": 0,
      "valor": 123
    },
    "dataVencimento": "2023-11-07T05:31:56Z",
    "dataExpiracao": "2023-11-07T05:31:56Z",
    "valorAbatimento": 123
  }
}
'

200

{
  "sucesso": true,
  "mensagem": "<string>",
  "qrCode": {
    "codigoQRCode": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "emv": "<string>",
    "imagem": "<string>"
  }
}

Through this endpoint, the partner can generate a unique QR code for a given call, which will then be discarded according to the registered expiration date. Interest and fines may or may not be charged according to the parameterization.

Authorizations

Authorization · string · header · required

Copie 'Bearer ' + token

Headers

IdempotencyKey · string · required

IgnoraHandshake · boolean · default: true · required

(somente em homologação)

Body

contaDto · object

Objeto detalhado da conta bancária associada ao QR Code.*

Show child attributes

contaDto. agencia · string | null

Número da agência bancária.*

Observações:

• O número da agência pode ter no máximo 4 caracteres.

contaDto. agenciaDigito · string | null

Dígito verificador da agência bancária.

Observações:

• O dígito verificador da agência bancária pode ter no máximo 1 caracter.

contaDto. conta · string | null

Número da conta bancária.

Observações:

• O número da conta bancária pode ter no máximo 12 caracteres.
• Para que seja possível localizar a conta, é necessário informar o 'número da conta com dígito' (contaPgto) ou o 'número da conta' (conta) e o 'dígito verificador' (contaDigito).
• Caso o 'número da conta com dígito' (contaPgto) seja informado, não é necessário preencher os campos 'número da conta' (conta) e 'dígito verificador' (contaDigito).
• Caso nenhum dos campos referentes ao número da conta seja informado, ocorrerá erro na requisição devido à falta de informação vital.

contaDto. contaDigito · string | null

Dígito verificador do número da conta bancária.

Observações:

• O dígito verificador do número da conta bancária pode ter no máximo 1 caracter.

contaDto. contaPgto · string | null

Número da conta bancária seguido do dígito verificador.

Observações:

• O número da conta seguido do dígito verificador pode ter no máximo 20 caracteres.

contaDto. tipoConta · enum<integer>

Tipo da conta.*

Valores: 1 - Corrente 2 - Poupanca 3 - Pagamento 4 - Salario

Available options: 1, 2, 3, 4

contaDto. modeloConta · enum<integer>

Modelo da conta.*

Valores: 1 - Movimento 2 - Escrow 3 - Vinculada

Available options: 1, 2, 3

qrCode · object

Objeto detalhado de informações relacionadas ao QR Code de cobrança.*

Show child attributes

qrCode. chave · string | null

Chave Pix associada ao QR Code.*

qrCode. tipoChave · enum<integer>

Tipo da chave.

Valores: 0 - CPF 1 - CNPJ 2 - TELEFONE 3 - EMAIL 4 - EVP

Available options: 0, 1, 2, 3, 4

qrCode. taxId · string | null

Identificação da transação (TXID).*

Observações:

• A 'identificação da transação (TXID)' (taxId) deve contar apenas letras e números.
• A 'identificação da transação (TXID)' (taxId) não pode iniciar com BLHBDDA.
• A 'identificação da transação (TXID)' (taxid) não pode ter sido utilizada em outro registro.

qrCode. valor · number<double>

Valor total do pagamento a ser realizado

Observação:

• O 'valor total do pagamento' (valor) pode ter no máximo duas casas decimais.

qrCode. devedor · object

Objeto detalhado do devedor.

Show child attributes

qrCode.devedor. nome · string | null

Nome completo do devedor.*

qrCode.devedor. documentoFederal · string | null

CPF ou CNPJ do devedor.*

qrCode.devedor. tipoPessoa · enum<integer>

Tipo de pessoa.

Valores: 1 - Fisica 2 - Juridica

Available options: 1, 2

qrCode. infosAdicionais · object

Objeto detalhado de informações adicionais do QR Code.

Observação:

• Caso existam 'informações adicionais' (infosAdicionais), os campos 'descrição' (nome) e 'valor' (valor) devem estar preenchidos.

Show child attributes

qrCode.infosAdicionais. nome · string | null

Descrição das informações adicionais.

qrCode.infosAdicionais. valor · string | null

Valor das informações adicionais.

qrCode. juros · object

Objeto detalhado de Juros aplicado ao QR Code.

Show child attributes

qrCode.juros. data · string<date-time> | null

Data de aplicação dos juros.

Observação:

• A 'data de aplicação dos juros' (data) deve ser posterior à 'data de vencimento' (dataVencimento).

qrCode.juros. tipo · enum<integer>

Tipo de juros.*

Valores: 1 - Valor (dias corridos) 2 - Percentual ao dia (dias corridos) 3 - Percentual ao mês (dias corridos) 5 - Isento 6 - Valor (dia útil) 8 - Percentual ao mês (dias úteis)

Available options: 1, 2, 3, 5, 6, 8

qrCode.juros. valor · number<double>

Valor ou percentual aplicado de multa, dependendo da natureza de multa informada.

qrCode. multa · object

Objeto detalhado de Multa aplicado ao QR Code.

Show child attributes

qrCode.multa. data · string<date-time> | null

Data de aplicação da multa.

Observação:

• A 'data de aplicação da multa' (data) deve ser posterior à 'data de vencimento' (dataVencimento).

qrCode.multa. tipo · enum<integer>

Tipo de juros.*

Valores: 1 - Valor fixo 2 - Percentual 3 - Isenta

Available options: 1, 2, 3

qrCode.multa. valor · number<double>

Valor ou percentual aplicado de multa, dependendo da natureza de multa informada.

qrCode. desconto · object

Objeto detalhado de Desconto aplicado ao QR Code.

Show child attributes

qrCode.desconto. data · string<date-time> | null

Data de aplicação do desconto.

Observações:

• A 'data de aplicação do desconto' (data) deve ser posterior à data atual.
• A 'data de aplicação do desconto' (data) deve ser anterior à 'data de vencimento' (dataVencimento).

qrCode.desconto. tipo · enum<integer>

Tipo de desconto.*

Valores: 0 - Isento 1 - Valor fixo até a data informada 2 - Percentual até a data informada 3 - Valor por antecipação (dias corridos) 4 - Valor por antecipação (dias úteis) 5 - Percentual por antecipação (dias corridos) 6 - Percentual por antecipação (dias úteis) 7 - Cancelamento Desconto

Available options: 0, 1, 2, 3, 4, 5, 6, 7

qrCode.desconto. valor · number<double>

Valor ou percentual aplicado de desconto, dependendo da natureza do desconto informada.

Observação:

• Caso a 'natureza do desconto' (tipo) seja por valor, este não pode ser maior ou igual ao 'valor total do pagamento a ser realizado' (valor).

qrCode. dataVencimento · string<date-time>

Data de Vencimento do QR Code.

qrCode. dataExpiracao · string<date-time>

Data de Expiração do QR Code.

qrCode. valorAbatimento · number<double>

Valor de abatimento ou desconto aplicado.

Response

200

application/json

Success

sucesso · boolean

mensagem · string | null

qrCode · object

Show child attributes

qrCode. codigoQRCode · string<uuid>

qrCode. emv · string | null

qrCode. imagem · string | null