Como emitir uma remessa de PIX na API de pagamentos da TecnoSpeed

[Guilherme Borges]

Fala Desenvolvedor, beleza?

Meu nome é Guilherme Borges, sou Consultor Técnico na operação PlugBank da TecnoSpeed, e considerando que recentemente implementamos em nossa API de pagamentos a possibilidade de gerar um PIX via arquivo de remessa, vim aqui neste POST demonstrar para vocês como é possível realizar a geração deste pagamento em nosso produto. Bora lá?

Antes de começarmos DEV, é importante salientar que para realizar os processos demonstrados nessa material, é preciso que seu pagador e sua respectiva conta e convênio já estejam devidamente cadastrados em nossa aplicação, conforme as documentações disponibilizadas abaixo. Combinado?

 

Cadastrar Pagador 💸:

https://docs.pagamentobancario.com.br/#tag/payer/operation/createPayer

Cadastrar Conta Bancária 🏦:

https://docs.pagamentobancario.com.br/#tag/account

 

Então já que o pagador e a conta Bancária já estão cadastrados, vamos partir para a geração deste pagamento tipo PIX. Primeiramente, para gerar este título, vamos utilizar a rota de "Diversos" em nossa aplicação, que pode ser consumida através das seguintes URLs:

 

Homologação: https://staging.pagamentobancario.com.br/api/v1/payment/various

Produção: https://api.pagamentobancario.com.br/api/v1/payment/various

 

Como se trata apenas de uma demonstração, estarei utilizando o ambiente de homologação nos exemplos demonstrados a seguir. Além disso, para realizar as devidas autenticações em nossa API, o processo é exatamente o mesmo da geração de outros pagamentos, basta enviar nos Headers o CNPJ de Software House, Token de Software House, e o CNPJ do pagador cadastrado. Exemplo no Insomnia: 

 

* Todos os dados demonstrados acima são fictícios, e foram utilizados apenas com o intuito de demonstração!

 

Agora que já possuímos nossa URL e Headers de autenticação montados, vamos para os campos necessários em nosso JSON de envio para criar um PIX de Transferência:

• accountHash 🔒: Este é o Hash da conta cadastrada para o pagador em questão, este valor deve ser repassado em formato de String e é devolvido pela nossa API no momento do cadastro da conta e também em uma consulta das contas cadastradas. Documentação de consulta de contas: https://docs.pagamentobancario.com.br/#tag/account/operation/fetchAccount

 

• paymentForm 🔼:  Este código, que também precisa ser repassado em formato de String, define a forma de pagamento que você vai utilizar para o título em questão que esta sendo gerado. Em nossa aplicação, para utilizar o tipo PIX, é necessário preencher o campo com 45 (Transferência) ou 47 (QRCode).

 

• paymentDate📅: Aqui você preenche com a data que o pagamento deve ser realizado.  Formato: AAAA-MM-DD

 

• dueDate📅: Data de vencimento. Formato: AAAA-MM-DD.

 

• amount 💰: Valor do pagamento, passar em formato de Number.

 

• pixType ⁉️: Define o tipo de chave PIX que você vai utilizar na transação, podendo ser repassado com os seguintes valores:

          
 

• pixKey 🗝️: Campo onde é repassado a chave PIX do Beneficiário. Atualmente, utilizado apenas para o Itaú.

 

• ispbCode 🏦: Atualmente este campo só é utilizado pelo Bradesco, e determina que deve ser passado nele o código do banco do beneficiário. Consulte o código aqui: https://globalfinanceiro.com.br/codigos-ispb-e-compe-dos-bancos/

 

• registrationComplement 🖋️: Atualmente este campo só é utilizado pelo Bradesco,  e determina o tipo da conta utilizada na transferência em questão:

          

 

• Dados de Beneficiário 🤵: Necessário criar um Array, igual ao apresentado no exemplo abaixo, contendo as informações bancárias do beneficiário:

               

 

Agora que todos os campos foram apresentados, vou demonstrar a seguir dois JSONs utilizados para a geração de um PIX de Transferência para o Itaú e para o Bradesco:

 

• Itaú:

 

{
	"accountHash": "SeuHashAqui",
	"paymentForm": "45",
	"description": "teste",
	"paymentDate": "2023-05-30",
	"amount": 1,
	"pixType": "01",
	"pixKey": "44998984040",
	"beneficiary": {
		"name": "Teste Fornecedor",
		"cpfCnpj": "12345678910",
		"bankCode": "237",
		"agency": "1324",
		"agencyDigit": "5",
		"accountNumber": "589632"
	}
}

 

• Bradesco:

 

{
	"accountHash": "youHash",
	"paymentForm": "45",
	"description": "teste",
	"dueDate": "2023-06-29",
	"paymentDate": "2023-05-30",
	"registrationComplement": "01",
	"amount": 1,
	"ispbCode": "60746948",
	"beneficiary": {
		"name": "Teste Fornecedor",
		"cpfCnpj": "12345678910",
		"bankCode": "237",
		"agency": "1324",
		"agencyDigit": "5",
		"accountNumber": "589632"
	}
}

 

Realizando o POST destas informações, em caso de sucesso, o response da API será algo parecido com isso:

	"uniqueId": "UNIQUEID",
	"status": "CREATED",
	"paymentType": "8",
	"accountHash": "yourHash",
	"description": "TECNOSPEED HOMOLOGAÇÃO",
	"paymentForm": "45",
	"paymentDate": "2023-05-30",
	"dueDate": "",
	"amount": 1,
	"rebateAmount": 0,
	"interestAmount": 0,
	"discountAmount": 0,
	"fineAmount": 0,
	"movimentCode": "",
	"complementaryCode": "",
	"compromiseType": 0,
	"transmissionParam": 0,
	"pixType": 1,
	"pixKey": "44998984040",
	"pixUrl": "",
	"pixTxid": "",
	"ispbCode": "",
	"registrationComplement": "",
	"tags": []
}

 

Em caso de erro, um response como este deve ser retornado:

{
	"code": 422,
	"message": "Unprocessable Entity",
	"errors": [
		{
			"message": "Conta não encontrada",
			"internalCode": 4007
		}
	]
}

 

Por fim, agora vou demonstrar como pode ser gerado um PIX por QRCode em nossa API. Resumidamente, os campos referentes ao AccountHash, Forma de pagamento, Data de pagamento, valor do pagamento e o Array dos dados do Beneficiário se mantém. Contudo, nesta modalidade são necessários apenas mais dois campos referentes ao PIX:

• pixUrl 🤔: Chave de endereçamento do PIX.

 

• pixTxid 🧐: Código de identificação do QRCode

 

Um JSON de exemplo que pode ser citado tanto para o Bradesco quanto para o Itaú, é este:

 

{
	"accountHash": "yourHash",
	"paymentForm": "47",
	"description": "teste",
    	"dueDate": "2023-06-29",
	"paymentDate": "2023-05-30",
	"amount": 1,
	"pixUrl": "1s1ds2a3sad1asdasda",
	"pixTxid": "1sadasdasdasdasdad",
	"beneficiary": {
		"name": "Teste Fornecedor",
		"cpfCnpj": "12345678910",
		"bankCode": "237",
		"agency": "1324",
		"agencyDigit": "5",
		"accountNumber": "589632"
	}
}

 

E por hoje seria isso Dev, vou estar deixando a seguir o link da nossa documentação, caso deseje ter acesso a mais informações e exemplos. Além disso, também estamos à disposição em nossos canais de atendimento. Até mais! 👊

Documentação: https://docs.pagamentobancario.com.br/#tag/payment/operation/variousPayment