Sign in

v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
QrCode

Criar Qr Code Dinâmico

Realiza a criação de um novo qr code dinâmico<br /><b>Caracteristicas:</b><br /><ul><li>Pode ser pago apenas uma vez;</li><li>Expira;</li><li>Deve ser parâmetrizado com um identificador único "txId" do cliente para fins de conciliação;</li><li>Ao ser pago dispara um webhook sob o evento "Recebimento" com o txId parametrizado;</li></ul>

post/pix/indireto/qrcode/dinamico

Headers

chaveIdempotenciastring uuid
Authorizationstring required

Auth

Request body

Example request

{
  "recebedor": {
    "codigoCategoria": "0000",
    "moeda": "986",
    "codigoPostal": "31930420",
    "cidade": "BRASILIA",
    "pessoa": {
      "nome": "João da Silva",
      "documento": "08798086081"
    },
    "contaBancaria": {
      "agencia": "0001",
      "conta": "1234567890"
    }
  },
  "cobranca": {
    "transactionId": "E0020126830014000201268321548LOP",
    "solicitacaoPagador": "Texto exemplo",
    "valor": {
      "valorOriginal": 123.99
    },
    "chave": {
      "valor": "+5599991919191, 08798086081, 15425145000118, example@example.com"
    },
    "devedor": {
      "pessoa": {
        "nome": "João da Silva",
        "documento": "08798086081"
      }
    },
    "informacoesAdicionais": [
      {
        "nome": "Info adicional",
        "valor": "Valor da info adicional"
      }
    ]
  },
  "retirada": {
    "ispb": "71027866"
  }
}

Response

Created

idstring uuid
status'Ativo' | 'Expirado' | 'Pago' | 'RemovidoPsp' | 'Vencido'
revisaointeger
dataCriacaostring date-time
qrCodestring nullable
valornumber double nullable

Example response

{
  "cobranca": {
    "transactionId": "E0020126830014000201268321548LOP",
    "solicitacaoPagador": "Texto exemplo",
    "valor": {
      "valorOriginal": 123.99
    },
    "chave": {
      "valor": "+5599991919191, 08798086081, 15425145000118, example@example.com"
    },
    "devedor": {
      "pessoa": {
        "nome": "João da Silva",
        "documento": "08798086081"
      }
    },
    "informacoesAdicionais": [
      {
        "nome": "Info adicional",
        "valor": "Valor da info adicional"
      }
    ]
  },
  "retirada": {
    "ispb": "71027866"
  }
}