Primeiros Passos - PlugPix

Com a API PlugPix, nós ficamos responsáveis por realizar todo o processo de homologação dos bancos, padronização da geração e recebimento do PIX. Seus clientes poderão ofertar uma nova forma de cobrança e ter a possibilidade de receber o valor instantaneamente a qualquer momento.

Neste artigo você terá todas as informações para conseguir realizar os cadastros e gerar um PIX seguindo os seguintes passos.

• Cadastro no TecnoAccount
• Autenticação da Software House
• Cadastro de uma Empresa
• Autenticar uma Empresa
• Rotas
  • Cadastrar Conta de Emissão
  • Upload de Certificado
  • Cadastro de WebHood
  • Criar PIX Dinâmico
  • Criar PIX com Data de Vencimento
  • Consulta do PIX Dinâmico
  • Consulta do PIX com Vencimento
  • Imprimir QR Code

Cadastro no TecnoAccount

Antes de iniciar a integração com API, é importante que sua conta TecnoSpeed esteja criada. Para isso, clique no link abaixo e preencha com os dados contratuais entre sua Software House e a Tecnospeed. Não utilize dados pessoais!

Criar Conta TecnoSpeed

 

Clicando no Link recebido no e-mail irá te direcionar ao portal Tecnospeed para ativar sua Tecnoaccount.

Autenticação da Software House

Para iniciar o processo de autenticação, o desenvolvedor deve ter uma conta válida e ativa no Tecnoaccount. Com a conta ativa, ele deve enviar uma requisição POST para o endpoint oauth2/token da API, com o "Content-Type" definido como "application/x-www-form-urlencoded". Nos headers, é necessário incluir o campo "Authorization" no seguinte formato:

1. Prefixe o valor "Basic " no campo "Authorization".
2. Em seguida, construa uma string que combine o e-mail cadastrado no Tecnoaccount e a senha, separados por “:”.
3. Codifique essa string em Base64 e concatene o resultado no valor de "Authorization".

Exemplo: teste@gmail.com:1234567 => Authorization: Basic dGVzdGVAZ21haWwuY29tOjEyMzQ1Njc=

Além disso, a requisição deve incluir o grant_type e o role no corpo da requisição (form-data) com os seguintes valores:

• "grant_type": "client_credentials"
• "role": "software_house"

Se a autenticação for bem-sucedida, a resposta conterá três dados principais:

• access_token: o token usado para autenticar todas as requisições subsequentes.
• expires_in: o tempo de vida (TTL) do token, definido como 3600 segundos (1 hora).
• token_type: o tipo do token, que atualmente será sempre "Bearer".

Cadastro de uma Empresa

Nessa rotina será cadastrada a empresa que fará a emissão do PIX. Caso tenha sucesso será disparado um e-mail com informações usadas na integração.

POST

 Sandbox:

 Produção:

Headers

Body

Exemplo:

Retorno

Exemplo de retorno:

Como autenticar como Empresa

Upload do certificado

Nessa rotina será feito o upload do certificado digital.

Cadastro de WebHook

Serão feitas 10 tentativas de comunicação com sua API, caso a primeira requisição não retorne com um statusCode 200, aguardaremos 10 segundos e em seguida enviaremos novamente. Se a segunda consulta não obtiver resposta, aguardaremos mais 20 segundos e enviaremos a terceira tentativa.

Atenção: É importante ressaltar que o envio das notificações webhook estão disponíveis apenas para o ambiente de produção.

POST

 Homologação:

 Produção:

Headers

Body

Exemplo:

Retorno

Exemplo de retorno:

Criar PIX Dinâmico (cobrança imediata)

Rotina responsável por efetuar a emissão de um Pix cobrança imediata.

Disponível para os bancos:

• 001: Banco do Brasil 
• 033: Santander
• 237: Bradesco
• 341: Itaú
• 364: GerenciaNet 
• 748: Sicredi
• 756: Sicoob
• 999: TecnoPay 

POST

 Sandbox:

 Produção:

Headers

Body

Exemplo:

Retorno

Exemplo de retorno:

Como emitir um pix com data de vencimento

É importante ressaltarmos que conforme normas do BACEN, caso o PIX tenha seu vencimento no sábado, domingo ou em feriados nacionais, o pagador terá até o próxima dia útil para efetuar o pagamento do PIX. Ou seja, se um PIX foi emitido para vencer em um sábado, o pagador terá até a próxima segunda-feira para efetuar a liquidação do mesmo.

Disponível para os bancos:

• 341: Itaú
• 748: Sicredi
• 756: Sicoob
• 999: TecnoPay

POST

 Sandbox:

 Produção:

Headers

Geração do PIX

É possível realizar a inclusão dos seguintes campos:

Segue abaixo Json de exemplo sobre a emissão de PIX de cobrança com vencimento:

 

{

"accountId": "0e001b8f-64a5-481a-a564-14b823bf836c",

"description": "Cobrança relativa a compra do dia 01-01-2021",

"tags": [



 "compra",

 "pix",

 "2021"

],

"calendar": {

 "dueDate": "2021-01-01",

 "daysAfterDueDate": 10

},

"payer": {

 "cpfCnpj": "01001001000113",

 "name": "João da Silva",

 "email": "email@email.com",

 "street": "Av. Brasil, 100, Centro",

 "city": "Maringá",

 "state": "PR",

 "zipcode": "87045170"

},

"value": {

 "original": 132.9,

 "fine": {},

 "interest": {},

 "reduction": {},

 "discount": {}

},

"aditionalInformation": [

 {

 "name": "loja",

 "value": "Loja de teste"

}

]

}

Response 201:

E assim também temos o Json de retorno da API com a response 201:

{
"id": "string",
"surrogateKey": "string",
"transactionId": "string",
"description": "string",
"tags": [
"string"
],
"kind": "string",
"revision": 0,
"status": "string",
"errors": [
"string"
],
"reason": "string",
"calendar": {
"dueDate": "string",
"daysAfterDueDate": 0
},
"payer": {
"cpfCnpj": "string",
"name": "string",
"email": "string",
"street": "string",
"city": "string",
"state": "string",
"zipcode": "string"
},
"value": {
"original": 0,
"fine": {
"modality": 0,
"valuePerc": 0
},
"interest": {
"modality": 0,
"valuePerc": 0
},
"reduction": {
"modality": 0,
"valuePerc": 0
},
"discount": {
"modality": 0,
"fixedDateDiscount": [
{
"date": "string",
"valuePerc": 0
}
],
"valuePerc": 0
}
},
"aditionalInformation": [
{
"name": "string",
"value": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Response com erro ( 422 ):

Json com erro:

{
"code": 422,
"errors": [
{
"type": "business_logic",
"property": "dueDate",
"message": "email should not be empty"
}
]
}

Consulta do PIX cobrança imediata

GET

 Sandbox:

 Produção:

Headers

Responses

200

{

"id": "string",

"surrogateKey": "string",

"transactionId": "string",

"description": "string",

"tags": [

"string"

],

"kind": "string",

"revision": 0,

"status": "string",

"reason": "string",

"emv": "string",

"qrcodeLocation": "string",

"errors": [

"string"

],

"payments": [ ],

"calendar": {

"dueDate": "string",

"daysAfterDueDate": 0

},

"payer": {

"cpfCnpj": "string",

"name": "string",

"email": "string",

"street": "string",

"city": "string",

"state": "string",

"zipcode": "string"

},

"value": {

"original": 0,

"fine": {},

"interest": {},

"reduction": {},

"discount": {}

},

"aditionalInformation": [

{}

],

"createdAt": "2019-08-24T14:15:22Z",

"updatedAt": "2019-08-24T14:15:22Z"

}

404

RESPONSE SCHEMA:application/json

Json:

{

"code": 404,

"message": "Resource not found"

}

Consulta do PIX cobrança com vencimento

{
"code": 422,
"errors": [
{
"type": "business_logic",
"property": "dueDate",
"message": "email should not be empty"
}
]
}

Imprimir QR code

Rotina utilizada para imprimir o QR code do PIX.

GET

 Sandbox:

 Produção:

Headers

Body

Retorno

Exemplo de retorno com erro: