Criação de transferência em lotes pelo PIX

bb_wrapper/wrapper/pagamento_lote.py

@@ -16,7 +16,7 @@ class PagamentoLoteBBWrapper(BaseBBWrapper):
     Wrapper da API Pagamentos em Lote
     """
 
-    SCOPE = "pagamentos-lote.lotes-requisicao pagamentos-lote.transferencias-info pagamentos-lote.transferencias-requisicao pagamentos-lote.cancelar-requisicao pagamentos-lote.devolvidos-info pagamentos-lote.lotes-info pagamentos-lote.pagamentos-guias-sem-codigo-barras-info pagamentos-lote.pagamentos-info pagamentos-lote.pagamentos-guias-sem-codigo-barras-requisicao pagamentos-lote.pagamentos-codigo-barras-info pagamentos-lote.boletos-requisicao pagamentos-lote.guias-codigo-barras-info pagamentos-lote.guias-codigo-barras-requisicao pagamentos-lote.transferencias-pix-info pagamentos-lote.transferencias-pix-requisicao pagamentos-lote.pix-info pagamentos-lote.boletos-info"  # noqa
+    SCOPE = "pagamentos-lote.lotes-requisicao pagamentos-lote.transferencias-info pagamentos-lote.transferencias-requisicao pagamentos-lote.cancelar-requisicao pagamentos-lote.devolvidos-info pagamentos-lote.lotes-info pagamentos-lote.pagamentos-guias-sem-codigo-barras-info pagamentos-lote.pagamentos-info pagamentos-lote.pagamentos-guias-sem-codigo-barras-requisicao pagamentos-lote.pagamentos-codigo-barras-info pagamentos-lote.boletos-requisicao pagamentos-lote.guias-codigo-barras-info pagamentos-lote.guias-codigo-barras-requisicao pagamentos-lote.transferencias-pix-requisicao"  # noqa
     BASE_PROD_ADDITION = "-ip"
     BASE_DOMAIN = ".bb.com.br/pagamentos-lote/v1"
 
@@ -481,3 +481,119 @@ def consultar_pagamento_tributo(self, _id):
         response = self._get(url)
 
         return response
+
+    ################
+    #     PIX      #
+    ################
+
+    def _criar_dados_transferencia_pix(
+        self,
+        n_requisicao,
+        agencia,
+        conta,
+        dv_conta,
+        data_transferencia,
+        valor_transferencia,
+        forma_id,
+        ddd,
+        telefone,
+        email,
+        cpf,
+        cnpj,
+        chave_aleatoria,
+        descricao,
+        tipo_pagamento,
+    ):
+        lote_data = {
+            "numeroRequisicao": n_requisicao,
+            "agenciaDebito": agencia,
+            "contaCorrenteDebito": conta,
+            "digitoVerificadorContaCorrente": dv_conta,
+            "tipoPagamento": tipo_pagamento,
+        }
+
+        transferencia_data = {
+            "data": data_transferencia,
+            "valor": valor_transferencia,
+            "formaIdentificacao": forma_id,
+            "descricaoPagamento": descricao,
+        }
+
+        if forma_id == 1:
+            transferencia_data["dddTelefone"] = ddd
+            transferencia_data["telefone"] = telefone
+        elif forma_id == 2:
+            transferencia_data["email"] = email
+        elif forma_id == 3:
+            transferencia_data["cpf"] = cpf
+            transferencia_data["cnpj"] = cnpj
+        elif forma_id == 4:
+            transferencia_data["identificacaoAleatoria"] = chave_aleatoria
+
+        return {**lote_data, "listaTransferencias": [{**transferencia_data}]}
+
+    def criar_transferencia_pix(
+        self,
+        n_requisicao,
+        agencia,
+        conta,
+        dv_conta,
+        data_transferencia,
+        valor_transferencia,
+        forma_id,
+        ddd=None,
+        telefone=None,
+        email=None,
+        cpf=None,
+        cnpj=None,
+        chave_aleatoria=None,
+        descricao="",
+        tipo_pagamento=128,
+    ):
+        """
+        Efetua pagamentos em lote via tranferência PIX
+
+        Args:
+            n_requisicao: Nº da requisição a ser utilizado. Deve ser único
+            agencia: Agência da conta de origem do pagamento
+            conta: Nº da conta de origem do pagamento
+            dv_conta: DV da conta de origem do pagamento
+            tipo_pagamento: Tipo de pagamento a ser feito (126, 127 ou 128)
+            data_transferencia: Data do pagamento. No formato "ddmmyyyy"
+            valor_transferencia: Valor do pagamento
+            forma_id: Tipo de chave utilizada
+                1. Telefone
+                2. E-mail
+                3. CPF/CNPJ
+                4. Chave Aleatória
+            ddd: DDD com dígitos. Obrigatório caso forma_id seja igual 1
+            telefone: Telefone do recebedor. Obrigatório caso forma_id seja igual 1
+            email: Email do recebedor. Obrigatório caso forma_id seja igual 2
+            cpf: CPF do recebedor.
+                Opcional caso forma_id seja igual a 1 ou 2 e caso o campo cnpj não seja informado
+                Obrigatório caso forma_id seja igual a 3 ou 5 e caso o campo cnpj não seja informado
+            cnpj: CNPJ do recebedor: Tem os mesmos casos de Obrigatório e opcional do cpf
+            chave_aleatoria: Chave aleatória gerada pelo recebedor. Obrigatório caso forma_id seja igual 4
+            descricao: Campo de uso livre pelo cliente
+        """
+        data = self._criar_dados_transferencia_pix(
+            n_requisicao,
+            agencia,
+            conta,
+            dv_conta,
+            data_transferencia,
+            valor_transferencia,
+            forma_id,
+            ddd,
+            telefone,
+            email,
+            cpf,
+            cnpj,
+            chave_aleatoria,
+            descricao,
+            tipo_pagamento,
+        )
+        url = self._construct_url("lotes-transferencias-pix")
+        response = self._post(url, data)
+
+        return response

examples/lotes_pagamento/data/transferencia_pix_chave_aleatoria.json

@@ -0,0 +1,35 @@
+{
+    "numeroRequisicao": 921347,
+    "estadoRequisicao": 1,
+    "quantidadeTransferencias": 1,
+    "valorTransferencias": 15.5,
+    "quantidadeTransferenciasValidas": 1,
+    "valorTransferenciasValidas": 15.5,
+    "listaTransferencias": [
+        {
+            "identificadorPagamento": 90921347731030000,
+            "data": 19042023,
+            "valor": 15.5,
+            "documentoDebito": 0,
+            "documentoCredito": 0,
+            "descricaoPagamento": "nova transferencia",
+            "descricaoPagamentoInstantaneo": "",
+            "formaIdentificacao": 4,
+            "dddTelefone": 0,
+            "telefone": 0,
+            "email": "",
+            "cpf": 0,
+            "cnpj": 0,
+            "identificacaoAleatoria": "d14d32de-b3b9-4c31-9f89-8df2cec92c50",
+            "numeroCOMPE": 0,
+            "numeroISPB": 0,
+            "tipoConta": 0,
+            "agencia": 0,
+            "conta": 0,
+            "digitoVerificadorConta": "",
+            "contaPagamento": "",
+            "indicadorMovimentoAceito": "S",
+            "erros": []
+        }
+    ]
+}

examples/lotes_pagamento/transferencia_pix_chave_aleatoria.py

@@ -0,0 +1,31 @@
+import os
+from datetime import date
+
+from examples.utils import dump_response
+
+from bb_wrapper.wrapper import PagamentoLoteBBWrapper
+
+c = PagamentoLoteBBWrapper(cert=("./certs/cert.pem", "./certs/key.pem"))
+
+
+today = date.today()
+bb_fmt = "%d%m%Y"
+
+
+lote_data = {
+    "n_requisicao": 921347,
+    "agencia": 1607,
+    "conta": 99738672,
+    "dv_conta": "X",
+}
+
+transferencia_data = {
+    "descricao": "nova transferencia",
+    "data_transferencia": today.strftime(bb_fmt),
+    "valor_transferencia": 15.50,
+    "forma_id": 4,
+    "chave_aleatoria": "d14d32de-b3b9-4c31-9f89-8df2cec92c50",
+}
+
+response = c.criar_transferencia_pix(**lote_data, **transferencia_data)
+dump_response(response, os.path.realpath(__file__))

tests/wrapper/test_pagamentos.py

@@ -446,3 +446,166 @@ def test_consultar_pagamento_tributo_1(self):
 
         self.assertEqual(2, self.total_requests())
         self.mock_responses.assert_call_count(request_url, 1)
+
+    def test_criar_transferencia_pix_chave_aleatoria(self):
+        """
+        Teste para verificar a URL da requisição e dados
+        """
+
+        request_url = PagamentoLoteBBWrapper()._construct_url(
+            "lotes-transferencias-pix"
+        )
+        expected_json = {
+            "numeroRequisicao": "123",
+            "agenciaDebito": "345",
+            "contaCorrenteDebito": "678",
+            "digitoVerificadorContaCorrente": "X",
+            "tipoPagamento": 128,
+            "listaTransferencias": [
+                {
+                    "data": "19042023",
+                    "valor": "11",
+                    "descricaoPagamento": "Pagamento",
+                    "formaIdentificacao": 4,
+                    "identificacaoAleatoria": "d14d32de-b3b9-4c31-9f89-8df2cec92c50",
+                }
+            ],
+        }
+        self.mock_responses.add(
+            responses.POST,
+            request_url,
+            headers=self._build_authorization_header(1),
+            json=expected_json,
+        )
+
+        response = PagamentoLoteBBWrapper().criar_transferencia_pix(
+            "123",
+            "345",
+            "678",
+            "X",
+            "19042023",
+            "11",
+            4,
+            None,
+            None,
+            None,
+            None,
+            None,
+            "d14d32de-b3b9-4c31-9f89-8df2cec92c50",
+            "Pagamento",
+        )
+
+        self.assertEqual(request_url, response.url)
+        self.assertEqual(self._get_headers(), response.headers)
+        self.assertEqual(expected_json, response.json())
+        self.assertEqual(2, self.total_requests())
+        self.mock_responses.assert_call_count(request_url, 1)
+
+    def test_criar_transferencia_pix_email(self):
+        """
+        Teste para verificar a URL da requisição e dados
+        """
+
+        request_url = PagamentoLoteBBWrapper()._construct_url(
+            "lotes-transferencias-pix"
+        )
+        expected_json = {
+            "numeroRequisicao": "123",
+            "agenciaDebito": "345",
+            "contaCorrenteDebito": "678",
+            "digitoVerificadorContaCorrente": "X",
+            "tipoPagamento": 128,
+            "listaTransferencias": [
+                {
+                    "data": "19042023",
+                    "valor": "12",
+                    "descricaoPagamento": "Teste transfer",
+                    "formaIdentificacao": 2,
+                    "email": "[email protected]",
+                }
+            ],
+        }
+        self.mock_responses.add(
+            responses.POST,
+            request_url,
+            headers=self._build_authorization_header(1),
+            json=expected_json,
+        )
+
+        response = PagamentoLoteBBWrapper().criar_transferencia_pix(
+            "123",
+            "345",
+            "678",
+            "X",
+            "19042023",
+            "11",
+            2,
+            None,
+            None,
+            "[email protected]",
+            None,
+            None,
+            None,
+            "Teste transfer",
+        )
+
+        self.assertEqual(request_url, response.url)
+        self.assertEqual(self._get_headers(), response.headers)
+        self.assertEqual(expected_json, response.json())
+        self.assertEqual(2, self.total_requests())
+        self.mock_responses.assert_call_count(request_url, 1)
+
+    def test_criar_transferencia_pix_telefone(self):
+        """
+        Teste para verificar a URL da requisição e dados
+        """
+
+        request_url = PagamentoLoteBBWrapper()._construct_url(
+            "lotes-transferencias-pix"
+        )
+        expected_json = {
+            "numeroRequisicao": "123",
+            "agenciaDebito": "345",
+            "contaCorrenteDebito": "678",
+            "digitoVerificadorContaCorrente": "X",
+            "tipoPagamento": 128,
+            "listaTransferencias": [
+                {
+                    "data": "19042023",
+                    "ddd": "11",
+                    "telefone": "985732102",
+                    "valor": "12",
+                    "descricaoPagamento": "Teste telefone",
+                    "formaIdentificacao": 1,
+                }
+            ],
+        }
+        self.mock_responses.add(
+            responses.POST,
+            request_url,
+            headers=self._build_authorization_header(1),
+            json=expected_json,
+        )
+
+        response = PagamentoLoteBBWrapper().criar_transferencia_pix(
+            "123",
+            "345",
+            "678",
+            "X",
+            "19042023",
+            "11",
+            1,
+            "11",
+            "985732102",
+            None,
+            None,
+            None,
+            None,
+            "Teste telefone",
+        )
+
+        self.assertEqual(request_url, response.url)
+        self.assertEqual(self._get_headers(), response.headers)
+        self.assertEqual(expected_json, response.json())
+        self.assertEqual(2, self.total_requests())
+        self.mock_responses.assert_call_count(request_url, 1)