1 189
edições
Mudanças
Iniciado documentação da utilização do serviço PIX
0000000000000-ret-PIXCobCreate.err (''se houve algum erro'')
----
===<font color=#1E90FF>Estrutura do XML de envio</font>===
Para ficar mais fácil o entendimento da estrutura, vamos separar por tópicos.
====<font color=#1E90FF>Informações iniciais</font>==== <pre><?xml version="1.0" encoding="utf-8"?><PIXCobrancaCreateRequest versao="1.00"> <SolicitacaoPagador>Prestação de serviços em software</SolicitacaoPagador> <TipoCobranca>0</TipoCobranca> <Valor>1.00</Valor> <Chave>+5544999999999</Chave> <TxId>12345678901234567890123456789012345</TxId> <GerarQRCode>true</GerarQRCode> ...... ......</pre> * <font color=#1E90FF>'''Legenda:'''</font>** A tag '''<SolicitacaoPagador>''' é um campo livre, que pode ser utilizado para descrever o serviço prestado (tamanho máximo de 140 caracteres);** A tag '''<TipoCobranca>''' aceita dois valores:*** 0 = Referente a cobrança sem vencimento, multas ou juros. Cobrança simples;*** 1 = Referente a cobrança com vencimento, multas e juros. Normalmente utilizada junto com o boleto.** A tag '''<Valor>''' significa o valor do PIX sendo o ponto final como separador decimal;** A tag '''<Chave>''' é a chave PIX do recebedor;** A tag '''<TxId>''' é o identificador do PIX, através dele que será feita a consulta na 2ª etapa do serviço de PIX:*** <span style="color: red">'''Observação:'''</span> deve ter entre 26 e 35 caracteres contendo apenas letras e números, sem espaço em branco ou caracter especial.** A tag '''<GerarQRCode>''' quando true, gera um arquivo de imagem contendo o QRCode do PIX. Quando false, não gera o arquivo de imagem. ---- ====<font color=#1E90FF>Grupo obrigatório</font>==== O grupo Beneficiário é '''obrigatório''' no XML, sendo definido após a tag '''<GerarQRCode>''': <pre><Beneficiario> <Inscricao>11222333000122</Inscricao> <Nome>Empresa Teste</Nome> <Conta> <Agencia>1111</Agencia> <Numero>1111111</Numero> <Banco>756</Banco> </Conta></Beneficiario></pre> * <font color=#1E90FF>'''Legenda:'''</font>** A tag '''<Inscricao>''' é a informação do titular da conta do recebedor do PIX sendo CPF ou CNPJ;** A tag '''<Nome>''' é o nome do titular da conta do recebedor do PIX;** O grupo '''<Conta>''' terá as informações da conta que vai receber o PIX:*** A tag '''<Agencia>''' é o número da agência da conta;*** A tag '''<Numero>''' é o número da conta;*** A tag '''<Banco>''' é o código do banco do recebedor: 756 (Sicoob), 748 (Sicredi), 33 (Santander) e assim por diante.**** <span style="color: red">'''Observação:'''</span> Temos o banco Sicoob e Bradesco implementados para PIX. Para solicitar um novo banco, entre em contato com a Unimake. ---- ====<font color=#1E90FF>Grupos opcionais</font>==== O grupo de tag <font color=#1E90FF>'''<Calendario>'''</font> é opcional no XML. Quando não informado, receberá valores padrões: <pre><Calendario> <Criacao>2023-05-23T10:42:05</Criacao> <Expiracao>600</Expiracao></Calendario> OU <Calendario> <Criacao>2023-05-23T10:42:05</Criacao> <DataDeVencimento>2023-05-23T10:42:05</DataDeVencimento> <ValidadeAposVencimento>3</ValidadeAposVencimento></Calendario></pre> * <font color=#1E90FF>'''Legenda:'''</font>** A tag '''<Criacao>''' é a data e hora da criação do PIX. O valor '''''padrão''''' é DATA e HORA atual;** A tag '''<Expiracao>''' é o tempo em segundos para expirar a cobrança PIX. O valor '''''padrão''''' é 86400 (24 horas);** A tag '''<DataDeVencimento>''' é a data de vencimento do PIX. Logo você pode escolher se informa o tempo de expiração ou a data de vencimento;** A tag '''<ValidadeAposVencimento>''' é o número de dias que a cobrança ainda poderá ser paga após o vencimento. Informar apenas se a <DataDeVencimento> existir no XML. O grupo de tag <font color=#1E90FF>'''<QRCodeConfig>'''</font> é opcional no XML. Quando não informado, receberá valores padrões: <pre><QRCodeConfig> <Width>512</Width> <Height>512</Height> <Quality>100</Quality> <ImageFormat>2</ImageFormat></QRCodeConfig></pre> * <font color=#1E90FF>'''Legenda:'''</font>** A tag '''<Width>''' é a largura da imagem do QRCode. O valor '''''padrão''''' é 512 mega pixels;** A tag '''<Height>''' é a altura da imagem do QRCode. O valor '''''padrão''''' é 512 mega pixels;** A tag '''<Quality>''' é a qualidade da imagem gerada do QRCode (1 a 100). O valor '''''padrão''''' é 100;** A tag '''<ImagemFormat>''' é o formato da imagem do QRCode. Aceita 4 valores:*** 0 = GIF;*** 1 = JPEG;*** 2 = PNG (valor padrão);*** 3 = WEBP. O grupo de tag <font color=#1E90FF>'''<Devedor>'''</font> é opcional no XML. Esse grupo não receberá valores padrões: <pre><Devedor> <Nome>Devedor de teste</Nome> <Inscricao>00000000000</Inscricao> <CEP>87700000</CEP> <Logradouro>Rua sao joao do joao, 111, Jardim teste</Logradouro> <Cidade>Paranavaí</Cidade> <UF>PR</UF></Devedor></pre> * <font color=#1E90FF>'''Legenda:'''</font>** A tag '''<Inscricao>''' é o CPF ou CNPJ do devedor;** As outras informações não precisam de legenda. ---- ====<font color=#1E90FF>Estrutura mínima para utilizar o serviço</font>==== <pre><?xml version="1.0" encoding="utf-8"?><PIXCobrancaCreateRequest versao="1.00"> <SolicitacaoPagador>Prestação de serviços em software</SolicitacaoPagador> <TipoCobranca>0</TipoCobranca> <Valor>1.00</Valor> <Chave>+5544999999999</Chave> <TxId>12345678901234567890123456789012345</TxId> <GerarQRCode>true</GerarQRCode> <Beneficiario> <Inscricao>11222333000122</Inscricao> <Nome>Empresa Teste</Nome> <Conta> <Agencia>1111</Agencia> <Numero>1111111</Numero> <Banco>756</Banco> </Conta> </Beneficiario></PIXCobrancaCreateRequest></pre> ---- ===<font color=#1E90FF>XML de retorno do envio: O que fazer?</font>=== Para verificar se o banco ativou a cobrança e ter a chave PIX para pagamento, você deve utilizar as informações no XML de retorno. Esse XML será gerado na [[Manuais:UniNFe/Configurando o UniNFe/Configuracoes Empresas/ConfigAbaPastas/Pasta de retorno|pasta de retorno]] com o nome a seguir: 0000000000000-ret-PIXCobCreate.xml E sua estrutura é a seguinte: <pre><?xml version="1.0" encoding="utf-8"?><PIXCobrancaCreateResponse> <Status>0</Status> <Motivo>PIX Ativo (Cobrança gerada)</Motivo> <PixCopiaECola>11111111111111111111br.gov.bcb.pix1111pix.xxxxxx.com.br/qr/xxxxxxx/v2/cobv/11111111-1111-1111-1111-1111111111111111111111111111111111111XXXXXXX XX XXXXXXXXXNao_informado22222222***2222222E</PixCopiaECola> <ImageQRCode>d:\testenfe\Retorno\20230523T103002-ret-PIXCobCreate.png</ImageQRCode></PIXCobrancaCreateResponse></pre> * <font color=#1E90FF>'''Legenda:'''</font>** A tag '''<Status>''' é o status do PIX tendo os valores:*** 0 = Ativo (PIX gerado);*** 1 = Concluído (Já foi pago);*** 2 = Removido pelo usuário recebedor;*** 3 = Removido pelo PSP;*** 999 = Exceção/Erro.** A tag '''<Motivo>''' é a descrição do status;** A tag '''<PixCopiaECola>''' é a string do PIX Copia e Cola para o devedor pagar por este formato;** A tag '''<ImageQRCode>''' é o caminho onde foi gravado a imagem do QRCode do PIX para o devedor pagar por este formato. ==<font color=#1E90FF>2ª etapa: Consultar a cobrança para verificar o recebimento</font>== Para verificar o recebimento, você deve fazer a consulta do conteúdo da tag <TxId> criada no tópico Informações inicias do XML de envio. Para fazer o envio dessa consulta, basta gerar o arquivo na [[Manuais:UniNFe/Configurando o UniNFe/Configuracoes Empresas/ConfigAbaPastas/Pasta de envio|pasta de envio]] com o nome e formato a seguir: 0000000000000-PIXGet.xml {| class="wikitable"|-||0000000000000||Conteúdo livre|-| style="width: 120px;"|-PIXGet.xml||Conteúdo fixo. Sempre será "-PIXGet.xml"|} O nome do arquivo de retorno é o mesmo do envio, mudando somente a extensão (final) do mesmo, conforme abaixo: 0000000000000-ret-PIXGet.xml (''se tudo ocorreu bem'') ou 0000000000000-ret-PIXGet.err (''se houve algum erro'') ---- ===<font color=#1E90FF>Estrutura do XML de envio</font>=== Para ficar mais fácil o entendimento da estrutura, vamos separar por tópicos. ====<font color=#1E90FF>Informações iniciais</font>==== <pre><PIXGetRequest versao="1.00"> <StartDate>2023-05-23T10:42:05</StartDate> <EndDate>2023-05-23T10:42:05</EndDate> <TxId>12345678901234567890123456anvfrg</TxId> ..... .....</pre> * <font color=#1E90FF>'''Legenda:'''</font>** A tag '''<StarDate>''' é a data inicial do período da consulta;** A tag '''<EndDate>''' é a data final do período da consulta;** A tag '''<TxId>''' é o conteúdo que foi criado no XML de envio. É o identificador do PIX para consultar a situação e ver se foi recebido ou não. ---- ====<font color=#1E90FF>Grupo obrigatório</font>==== O grupo Beneficiário é '''obrigatório''' no XML, sendo definido após a tag '''<TxId>''': <pre><Beneficiario> <Inscricao>11222333000122</Inscricao> <Nome>Empresa Teste</Nome> <Conta> <Agencia>1111</Agencia> <Numero>1111111</Numero> <Banco>756</Banco> </Conta></Beneficiario></pre> * <font color=#1E90FF>'''Legenda:'''</font>** A tag '''<Inscricao>''' é a informação do titular da conta do recebedor do PIX sendo CPF ou CNPJ;** A tag '''<Nome>''' é o nome do titular da conta do recebedor do PIX;** O grupo '''<Conta>''' terá as informações da conta que vai receber o PIX:*** A tag '''<Agencia>''' é o número da agência da conta;*** A tag '''<Numero>''' é o número da conta;*** A tag '''<Banco>''' é o código do banco do recebedor: 756 (Sicoob), 748 (Sicredi), 33 (Santander) e assim por diante.**** <span style="color: red">'''Observação:'''</span> Temos o banco Sicoob e Bradesco implementados para PIX. Para solicitar um novo banco, entre em contato com a Unimake. ---- ====<font color=#1E90FF>Estrutura mínima para utilizar o serviço</font>==== <pre><?xml version="1.0" encoding="utf-8"?><PIXGetRequest versao="1.00"> <StartDate>2023-05-23T10:42:05</StartDate> <EndDate>2023-05-23T10:42:05</EndDate> <TxId>12345678901234567890123456anvfrg</TxId> <Beneficiario> <Inscricao>37765786000148</Inscricao> <Nome>Dream Solutions</Nome> <Conta> <Agencia>1111</Agencia> <Numero>1111111</Numero> <Banco>756</Banco> </Conta> </Beneficiario></PIXGetRequest></pre> ---- ===<font color=#1E90FF>XML de retorno da consulta: O que fazer?</font>=== '''EM BREVE , MAIS INFORMAÇÕES.'''