Cobrança com Qr code estático

Pré requisitos para implementação:

  • Possuir uma chave api da Celcoin, para mais informações acessar esse link

  • Ter familiaridade com apis Rest usando o protocolo OAuth 2.0.

  • Ter o produto/solução contratada, caso queira usar a funcionalidade em ambiente produtivo, por favor entre em contato com a nossa equipe comercial através do e-mail [email protected] Para dúvidas técnicas, basta entrar em contato com o suporte através do link.

  • Ter uma chave Pix cadastrada - caso sua empresa não tenha, basta entrar em contato com o nosso suporte,solicitando esse cadastro. Não realizamos o cadastro de chaves do tipo: CNPJ, e-mail, ou telefone devido a possibilidade de fraudes.

Essa funcionalidade deve ser usada sempre que for necessário criar apenas um Qrcode para realizar as cobranças de seus usuários, geralmente os clientes da Celcoin usam quando têm a necessidade de receber transferências pix para habilitar créditos, ou cashback em sua aplicação, ou quando seu usuário deseja criar um qrcode para receber valores, por exemplo um live do twitch e youtube.

Caso de uso:

Como Fintech quero disponibilizar para os meus usuários, a possibilidade de cobrar de forma instantânea com apenas um Qrcode, onde ao criar é possível que ele exponha em algum lugar, desta forma, pode ser realizado o escaneamento e uma transferência no valor desejado.

Criando um Qrcode estático

Para realizar a criação de um Qrcode estático é necessário realizar a chamada na API Criar um QRcode estático.

Modelo de request:

curl --location --request POST 'https://sandbox.openfinance.celcoin.dev/pix/v1/brcode/static' \
--header 'accept: application/json' \
--header 'Content-Type: application/json-patch+json' \
--header 'Authorization: Bearer {access_token}' \
--data-raw '{
  "key": "[email protected]",
  "amount": 10.55,
  "transactionIdentification": "testqrcodestaticcelcoin",
  "merchant": {
    "postalCode": "01201005",
    "city": "Barueri",
    "merchantCategoryCode": 0,
    "name": "Celcoin"
  },
  "tags": [
    "string"
  ],
  "additionalInformation": "Referente ao custo de...",
  "withdrawal": false
}'

Perceba que é necessário preencher o campo key com a sua chave pix da Celcoin que será habilitada uma vez que você for aprovado no processo de homologação.

Caso você esteja realizando testes em sandbox recomendamos o uso da chave([email protected]), pois nosso ambiente está preparado para realizar os testes com ela.

O campo transactionIdentification é opcional na geração do qrcode, o mesmo é utilizado para identificação do qrcode.

Dentro do objeto merchant deve ser populado os dados da sua empresa, sendo eles postalCode (CEP), city (cidade), name (nome da empresa). O restante das propriedades não são obrigatórias.

Modelo de retorno:

{
    "transactionId": 9179311,
    "emvqrcps": "[email protected]ente ao custo de...520400005303986540510.555802BR5907Celcoin6007Barueri61080120100562270523testqrcodestaticcelcoin6304C3A1",
    "transactionIdentification": "testqrcodestaticcelcoin"
}

Na propriedade emvqrcps, será retornado um código para ser criado o Qrcode estático.

Recomendamos que seja armazenado do seu lado o transactionId, pois ao receber as transferências desse QR code a Celcoin irá enviar um gatilho RECEIVEPIX, no seu webhook configurado pela nossa equipe de suporte.

O webhook é uma forma de receber informações de forma assíncrona, onde geralmente são disparados gatilhos no formato JSON quando um evento acontece. Para realizar a configuração de um webhook é necessário entrar em contato com a nossa equipe de suporte informando a URL de seu webhook, senha e usuário, no formato BASIC. Com o cadastro realizado em nossa plataforma, será possível o envio dos gatilhos.

Caso o pagamento ocorra com sucesso, a Celcoin dispara um gatilho (RECEIVEPIX) em seu webhook.

Modelo de webhook:

{
    "RequestBody": {
        "TransactionType": "RECEIVEPIX",
        "TransactionId": 56762766,
        "Amount": 150.55,
        "DebitParty": {
            "Account": "416781236",
            "Bank": "18236120",
            "Branch": "1",
            "PersonType": "NATURAL_PERSON",
            "TaxId": "01234567890",
            "AccountType": "CACC",
            "Name": "Fulano de Tal"
        },
        "CreditParty": {
            "Bank": "13935893",
            "Branch": "1",
            "Account": "123456789",
            "PersonType": "NATURAL_PERSON",
            "TaxId": "09876543210",
            "AccountType": "CACC",
            "Name": "Cicrano de Outro",
            "Key": "8ea152b1-ddee-ssaa-aass-ce98245349aa"
        },
        "EndToEndId": "E18236120202001199999s0149012FPC",
        "transactionIdentification": "meuClientRequestId0014534",
        "transactionIdBRCode": "meuClientRequestId0014534"
    }
}

🚧

Atenção!

Em ambiente de sandbox não é disparado o gatilho (RECEIVEPIX). Para receber, é necessário executar os testes em ambiente produtivo, com uma transação e pagamento de QR code, usando saldo de sua conta bolsão Celcoin.


Did this page help you?