13 - QR Code - Cobrança

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>"
  },
  "qrCode": {
    "chave": "<string>",
    "taxId": "<string>",
    "valor": 123,
    "devedor": {
      "nome": "<string>",
      "documentoFederal": "<string>"
    },
    "infosAdicionais": {
      "nome": "<string>",
      "valor": "<string>"
    },
    "juros": {
      "data": "2023-11-07T05:31:56Z",
      "valor": 123
    },
    "multa": {
      "data": "2023-11-07T05:31:56Z",
      "valor": 123
    },
    "desconto": {
      "data": "2023-11-07T05:31:56Z",
      "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>"
  }
}

Por meio deste endpointo, o parceiro pode gerar um Qr code único para uma determinada chamada, que em seguida será descartado conforme a data de validade cadastrada, pode ou não, haver cobrança de juros e multa de acordo com a parametrização.

Mostrar Mensagens de requisições com erro

O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

Endpoint	Mensagem de erro
/api/v2/QRCode/Cobrança	Não foi possível criar o QRCode dinâmico. A conta está bloqueada
/api/v2/QRCode/Cobrança	Essa operação deve estar dentro de uma transação
/api/v2/QRCode/Cobrança	TxID ja utilizado para essa conta

Autorizações

Authorization · string · header · obrigatório

Copie 'Bearer ' + token

Cabeçalhos

IdempotencyKey · string · obrigatório

IgnoraHandshake · boolean · padrão: true · obrigatório

(somente em homologação)

Corpo

application/jsontext/jsonapplication/*+json

contaDto · object

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

Show child attributes

qrCode · object

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

Show child attributes

Resposta

200

application/json

Success

sucesso · boolean

mensagem · string | null

qrCode · object

Show child attributes