Manual de API SISPAG V2

Fazer download em pdf ou txt
Fazer download em pdf ou txt
Você está na página 1de 87

Manual de API SISPAG - Cash

Management
Aqui você visualiza as Apis do Contas a Pagar (SISPAG), que possibilita a gestão dos
pagamentos da sua empresa de forma segura e ainda mais rápida.
Inclusão exclusiva para Pix e consultas para todas as formas de pagamento.

Sumário

• Sobre a solução
o Autenticação e Segurança
o Fluxo de autenticação – OAuth 2.0 (Private KeyJWT e Mutual-TLS Client
Authentication)
o Como conhecer e testar as APIs
▪ Um exemplo de como será essa jornada
▪ Intervalo para obtencao de acess_tokens
▪ Padrões de erro
▪ Endpoint Raiz
o Parâmetros comuns de cabeçalho
• APIS de Gestão de Pagamentos SISPAG
o Inclusão de Pagamento PIX
▪ Inclusão de Pagamentos – PIX Transferência
▪ Entrada - Request
▪ Exemplo de entrada - Por dados bancários
▪ Exemplo de entrada - Por chave
▪ Exemplo de saída
▪ Objetos
▪ Inclusão de pagamento PIX-QRCODE
▪ Entrada - Request
▪ Exemplo de entrada
▪ Exemplo de saída
▪ Objetos
o Consulta de pagamento
▪ Lista de pagamentos
▪ Entrada
▪ Exemplo de entrada
▪ Saída
▪ Exemplo de saída
▪ Objetos
▪ Detalhe do pagamento
▪ Entrada
▪ Exemplo de entrada
▪ Saída
▪ Exemplo de saída
▪ Objetos
▪ Domínios Consulta

Sobre a solução
O Pix permitirá a transferências e pagamentos via QR Code Estático e Dinâmico entre
diferentes instituições financeiras em até 10 segundos, 24 horas por dia e todos os dias do
ano, incluindo finais de semana e feriados. Para utilizar o Pix através dessa API é necessário
que o SISPAG esteja habilitado.

Corporativo | Interno
Autenticação e Segurança

Para começar a sua jornada de desenvolvimento é importante que o ambiente esteja


preparado e configurado para realizar os testes e suportar o desenvolvimento da aplicação
de maneira segura. Nosso modelo de comunicação atual requer a autenticação do parceiro
através do fluxo OAuth 2.0.

Fluxo de autenticação – OAuth 2.0 (Private KeyJWT e Mutual-TLS Client


Authentication)

Os fluxos de autenticação do oAuth 2.0 são baseados em obtenção de access_tokens que


permitem a autenticação e autorização das APIs. O método previsto para as APIS do PIX do
Itaú é o Private Key JWT Client Authentication (private_key_jwt) que consiste em
autenticação no fluxo client_credentials baseada em chaves (privada e pública).
Ambas as chaves são criadas pelo desenvolvedor que irá integrar com as APIs do Itaú. A
chave privada, deve ser criada e armazenada de maneira segura dentro do ambiente da
aplicação que consumirá as APIs e é utilizada para assinar todas as obtenções de
access_tokens. A chave pública deve ser exposta em um terminal de configuração
descoberta (well-known endpoint) em uma sessão específica conhecida como jwks_uri
(JSON Web Key Sets – URI). A jwks_uri deve ser informada para o agente comercial Itaú
no momento da contratação. Saiba mais em https://auth0.com/docs/tokens/json-web-
tokens/json-web-key-sets
Para estabelecer conexão segura com os API Gateways do Itaú é necessário enviar um client
certificate. Este certificado é usado para estabelecer o mTLS (OAuth 2.0 Mutual Transport
Layer Security - https://tools.ietf.org/html/rfc8705):

• A partir de um client_id e token temporário para ativação_, ambos fornecidos pelo


agente comercial após a contratação, o desenvolvedor gera um arquivo CSR
(Certificate Signing Request) baseado em um template e documentação será
fornecida no nosso Portal do Desenvolvedor;
• O desenvolvedor solicita um certificado assinado pelo Itaú (CRT – Certificate File),
através de uma API informando o CSR e token temporário de ativação;
• O desenvolvedor configura sua aplicação com o arquivo CRT, que será utilizado
junto com o private_key_jwt para a obtenção de access_tokens e junto com o
access_token para todas as chamadas de APIs.
• A renovação automática e revogação estão também documentadas no Portal do
Desenvolvedor

Como conhecer e testar as APIs

Após a contratação, seu agente comercial realizará o cadastro em nossos sistemas internos e
enviará três informações importantes: uma credencial (client_id) que será cadastrada com
suas informações previamente fornecidas (inclusive o jwks_uri, citado anteriormente),
token temporário de ativação e um código de registro para Portal do Desenvolvedor Itaú, no
qual dará acesso à toda a documentação detalhada e referências técnicas, além de um
ambiente sandbox para testes simulados. Com esse código, você se cadastra e pode
cadastrar outros desenvolvedores de sua organização.

Um exemplo de como será essa jornada

• O primeiro passo é criar um ‘projeto’ dentro do nosso portal, definindo o nome do


projeto e quais APIs farão parte dele e, por fim, clicando no botão “Criar Projeto”
para finalizar a criação;
• Acesse a página da API e leia toda a documentação, com fluxos e exemplos. Isso,
com certeza, vai ajudar você a diminuir o tempo e a dificuldade na construção;

Corporativo | Interno
• Dentro da documentação, além das informações referentes ao processo, você
encontrará as especificações técnicas de cada API, métodos, parâmetros de entrada
(requests) e de retorno (responses);
• Em seguida, você terá a possibilidade de selecionar a aplicação criada para seu
projeto (passo 1), simular uma autorização (obtendo um access_token) e simulando
uma chamada da API, após o preenchimento dos campos obrigatórias e opcionais;
• Se houver dúvidas ou problemas de acesso você poderá contar com o time comercial
para melhor direcionar os pontos que necessitam de atuação ou melhoria em nossa
documentação. Contamos sua colaboração nessa jornada!

Para testar as APIs do sandbox diretamente de sua aplicação, basta obter um


cliente_id de uma aplicação criada no Portal do Desenvolvedor e private_key_jwt global
(que estará disponível nas informações adicionais da aplicação) e realizar as chamadas
diretamente para as URIs de obtenção de access_tokens e de APIs do sandbox.
As URIs estarão disponíveis no Portal.

Intervalo para obtenção de access_tokens

O access_token é muito eficiente quando utilizado diversas vezes antes de expirar (tempo
padrão de 5 minutos), portanto é importante que sua implementação de código preveja
obter novo access_token somente quando estiver perto de expiração
do access_token corrente. Isso evita fluxo desnecessário de autorização e garante mais
performance para seu sistema ou aplicativo.

Padrão de Erros

Há um padrão de retorno para todos os erros na API. Esse padrão segue uma estrutura
específica, podendo apenas variar os valores existentes nos campos.
No exemplo a seguir, o campo id_transferencia não foi enviado no Body da requisição.

{
"codigo": "400",
"mensagem": "Erro na validação",
"campos": [
{
"campo": "data_pagamento",
"mensagem": " Inclusão de pagamento não efetuada. O campo “data_
pagamento” deve conter uma data válida, no formato dd/MM/yyyy",
"valor": " "
}
]
}
Endpoint Raiz

Ambiente Endpoint Autorização

Sandbox https://api.itau.com.br/sandbox/sispag/v1 https://api.itau.com.br/sandbox/api/oauth/token

Produção https://api.itau.com.br/sispag/v1 https://sts.itau.com.br/api/oauth/token

Corporativo | Interno
Parâmetros comuns de cabeçalho

Para consumo das APIs do Itaú, alguns parâmetros de cabeçalho são necessários:

x-itau-apikey

O x-itau-apikey é um parâmetro que será requerido em todas as chamadas das APIs que
contemplam essa solução de pagamentos do Itaú. A informação que deve ser usada nesse
campo é o código gerado através da autenticação OAuth 2.0 para o client_id. Para saber
como gerar o client_id ou como recuperar as informações de códigos já gerados basta
acessar a etapa de ‘autenticação’ desse tutorial.

x-itau-flowID

A implementação de um flowID permite identificar qual é a funcionalidade de negócio


sendo executada na aplicação. Por exemplo, dentro de uma mesma aplicação, várias telas
ou linhas de negócio diferentes podem acessar a mesma API. Quando é identificado que
algumas chamadas a uma determinada API estão dando erro, através do flowID, podemos
descobrir que as chamadas são de uma tela específica e com isso solucionar o problema
mais rápido do que se não tivéssemos essa informação no log. Ter o flowID nos logs
também permite extrair algum tipo de métrica através do log. Recomenda-se mandar um
uuid version 4 nesse campo como: b47ec51b-b2a7-4a78-933c-f0b67667e7dc.

x-itau-correlationID

A implementação de um correlationID permite relacionar uma mesma chamada passando


em diversas aplicações/sistemas diferentes, conseguindo fornecer um mapeamento de
ponta-a-ponta. Por exemplo, uma aplicação client gera uma chamada à API, neste
momento fornecendo o correlationID gerado pelo consumidor, o qual é repassado em todas
as camadas/microserviços que a api precisa para realizar determinada funcionalidade. É
importante lembrar que o header x-itaucorrelationID deve sempre ser diferente a cada
requisição. Recomenda-se mandar um uuid version 4 nesse campo como: a1e64241-7fdb-
4d05-a7f6-c44febcdd8d9.

Authorization

Seguindo o padrão oAuth 2.0, esse cabeçalho contém o token de acesso que identifica o
chamada (access_token). Com essa informação será realizada a identificação e autorização
aos recursos das APIs.

Exemplo de POST:

• Authorization: Bearer [access_token obtido na chamada ao autorizador]


• x-itau-flowID: [GUID gerado pela aplicação para identificar o processo de negócio]
• x-itau-correlationID: [GUID gerado pela aplicação para identificar unicamente a
execução da API]
• x-itau-apikey: [ID que identifica a aplicação no gateway]

Corporativo | Interno
APIS de Gestão de Pagamentos SISPAG
Os itens a seguir detalham as funcionalidades disponibilizadas nas APIs do Itaú para o Pix.
Sua empresa pode desfrutar de todas as visões e opções criadas.

Inclusão de Pagamentos – PIX Transferências


POST /transferencias

API responsável por inserir um pagamento Pix na plataforma SISPAG do Banco Itaú. Para
essa forma de pagamento, é obrigatório o envio de no mínimo: uma identificação do
cliente (chave, ou ispb, tipo_identificacao_conta, agencia_recebedor, conta_recebedor,
tipo_de_identificacao_do_recebedor, identificacao_recebedor), valor_pagamento,
data_pagamento e objeto Pagador. Caso seja enviado a chave Pix, todas as outras
informações do recebedor são opcionais, e caso sejam enviadas, serão validadas com o
cadastrado para chave na DICT.

Entrada

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

valor_pagamento body string sim Valor a ser pago.

data_pagamento body string sim Data do pagamento, formato


yyyy-MM-dd

chave body string não Chave do recebedor. (CNPJ,


Telefone, E-Mail ou Chave
Aleatória) Exemplos:

CNPJ: 12345678000112

Telefone: +5561912345678

E-
mail: funcionario_itau@itau-
unibanco.com.br

Chave Aleatória: 123e4567-


e12b-12d1-a456-
426655440000

ispb body string não Ispb do recebedor.

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

tipo_identificacao_c body string não Tipo de conta do recebedor.


onta “CC”: Conta Corrente “CP”:
Conta Pagamento “PP”:
Conta Poupança

agencia_recebedor body string não Agência do recebedor.

conta_recebedor body string não Conta do recebedor.

tipo_de_identificaca body string não Tipo de pessoa do recebedor


o_do_recebedor (“F” - Fisica ou “J” - Jurídica)

identificacao_recebe body string não Documento do recebedor


dor (CPF com 11 Posições ou
CNPJ com 14 Posições

informacoes_entre_ body string não Informações entre usuários a


usuarios ser trafegada no pagamento
(140 posições).

referencia_empresa body string não Texto livre de referência da


empresa sobre o pagamento.

identificacao_compr body string não Texto livre de para


ovante identificação do
comprovante da empresa
sobre o pagamento.

txid body string não Identificador do PIX.

pagador body object sim Objeto: Detalhe Pagador.

Corporativo | Interno
Exemplo de entrada - Por dados bancários
{
"valor_pagamento": "123.40",
"data_pagamento": "2020-07-13",
"ispb": "60701190",
"tipo_identificacao_conta": "CC",
"agencia_recebedor": "1500",
"conta_recebedor": "00052012",
"tipo_de_identificacao_do_recebedor": "F",
"identificacao_recebedor": "61389299260",
"informacoes_entre_usuarios": "transferencia para o João - ref
erente a manutencao",
"referencia_empresa": "154785966666666",
"identificacao_comprovante": "transferencia para o João - refe
rente a manutencao",
"txid": "bqJJjaVAThmtnUeVLNnSXQ",
"pagador": {
"tipo_conta": "CC",
"agencia": "1500",
"conta": "00800550",
"tipo_pessoa": "J",
"documento": "06830622000123",
"modulo_sispag": "Fornecedores"
}
}
Exemplo de entrada - Por chave
{
"valor_pagamento": "123.40",
"data_pagamento": "2020-07-13",
"chave": "funcionario@itau-unibanco.com.br",
"informacoes_entre_usuarios": "transferencia para o João - refer
ente a manutencao",
"referencia_empresa": "154785966666666",
"identificacao_comprovante": "transferencia para o João - refere
nte a manutencao",
"pagador": {
"tipo_conta": "CC",
"agencia": "1500",
"conta": "00800550",
"tipo_pessoa": "J",
"documento": "06830622000123",
"modulo_sispag": "Fornecedores"
}
}

Corporativo | Interno
Saída

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

status_pagamento body string sim Status do


pagamento.

cod_pagamento body string sim Identificação


do pagamento.

numero_lote body string sim Número de lote


SISPAG.

numero_lancamento body string Sim Número do


lançamento
SISPAG.

tipo_pagamento body string sim Tipo da


transferência.

data_pagamento body string sim Data em que


será realizado o
pagamento.
Formato
“YYYY-MM-
DDTHH:MM:S
S”.

valor_pagamento body string sim Valor do


pagamento.

referencia_empresa body string não Texto livre de


referência da
empresa sobre
o pagamento.

identificacao_comprovant body string não Texto livre de


e para
identificação
do
comprovante
da empresa

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

sobre o
pagamento.

informacoes_entre_usuar body string não Mensagem


ios enviada do
pagador ao
recebedor (140
posições).

txid body string não Identificador


do PIX.

pagador body object sim Objeto:


Detalhe
Pagador.

recebedor body object sim Objeto:


Detalhe
Recebedor.

Exemplo de saída

• HTTPStatus - 200

{
"status_pagamento": "Sucesso",
"cod_pagamento": "916BD0D6-CDC9-41E8-B2A5-19FF6BC0F823",
"numero_lote": "199000019",
"numero_lancamento": "13",
"tipo_pagamento": "Transferência Pix Itaú",
"data_pagamento": "2016-10-11T12:00:00",
"valor_pagamento": "1260.00",
"referencia_empresa": "154785966666666",
"identificacao_comprovante": "transferencia para o João - refe
rente a manutencao",
"informacoes_entre_usuarios": "transferencia para o João - ref
erente a manutencao",
"txid": "bqJJjaVAThmtnUeVLNnSXQ",
"pagador": {
"tipo_conta": "CC",
"agencia": "1500",
"conta": "00800550",
"tipo_pessoa": "J",
"documento": "06830622000123",
"modulo_sispag": "Fornecedores"
},
"recebedor": {
"banco": "Itaú Unibanco",

Corporativo | Interno
"ispb": "60701190",
"tipo_conta": "CC",
"agencia": "1500",
"conta": "00052012",
"tipo_pessoa": "F",
"documento": "61389299260",
"nome": "Maria PIX",
"identificacao_chave": "maria_pix@gmail.com"
}
}
}
Objetos

Objeto Detalhe Pagador

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

tipo_conta body string Sim Tipo de conta do recebedor.


“CC”: Conta Corrente “CP”:
Conta Pagamento “PP”:
Conta Poupança

agencia body string sim Agência do pagador (4


posições)

conta body string sim Conta do pagador + Dígito


Verificador (total 8
Posições)

tipo_pessoa body string sim Tipo de pessoa do pagador


(“F” - Fisica ou “J” -
Jurídica)

documento body string sim Documento do pagador


(CPF com 11 Posições ou
CNPJ com 14 Posições)

modulo_sispag body string sim Módulo SISPAG utilizado


para o pagamento.
Dominio: Fornecedores ou
Diversos

Corporativo | Interno
Objeto Detalhe Recebedor

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

banco body string não Nome do banco do


recebedor

ispb Body String Sim ISPB do banco do


recebedor

tipo_conta body string Sim Tipo de conta do


recebedor

agencia body string sim Agência do recebedor

conta body string sim Conta do recebedor

tipo_pessoa body string sim Tipo de pessoa do


recebedor (“F” - Fisica
ou “J” - Jurídica)

documento body string sim Documento do


recebedor (CPF ou
CNPJ)

nome body string sim Nome do favorecido

identificacao_chave body string não Identificação da chave


utilizada pelo
favorecido

Corporativo | Interno
Inclusão de pagamento PIX-QRCODE
POST /transferencias

API responsável por inserir um pagamento pix na plataforma SISPAG do Banco Itaú.
Abaixo estão expostos os parâmetros exigidos por essa API e a descrição deles. Para obter
mais informações de onde conseguir o x-itau-apikey, e o x-itau-correlationID, acesse o
tópico ‘Informações necessárias’.
Para essa forma de pagamento, é obrigatório o envio de no mínimo: uma identificação do
QR-CODE (pix_link, imagem, emv ou url), valor, data_pagamento e o objeto Pagador.
Todas as outras informações são opcionais, e caso sejam enviadas, será validada com o QR-
CODE decodificado.

Entrada

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

pix_link body string sim Link do QR-Code.


Essa informação
pode ser
encontrada na
decodificação do
QR-CODE. (está
contido no Payload
da URL)

imagem body byte sim Imagem do QR-


Code.

emv body string sim EMV do QR-CODE.


Padrão EMV
utilizado na geração
da imagem do QR
Code.

url body string sim URL do QR-Code.


Essa informação
pode ser
encontrada na
leitura do QR-
CODE ou no Pix
link.

txid body string não Identificador do


PIX.

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

valor_pagamento body string sim Valor a ser pago.

data_pagamento body string sim Data do pagamento,


formato yyyy-MM-
dd

chave body string não Chave do


recebedor. (CNPJ,
Telefone, E-Mail ou
Chave Aleatória)
Exemplos:

CNPJ:
12345678000112

Telefone:
+5561912345678

E-
mail: funcionario_it
au@itau-
unibanco.com.br

Chave Aleatória:
123e4567-e12b-
12d1-a456-
426655440000

ispb body string não ISPB do recebedor.

agencia_recebedor body string não Agência do


recebedor.

conta_recebedor body string não Conta do recebedor.

tipo_de_identificacao_d body string não Identificação do


o_recebedor recebedor (PF ou
PJ).

identificacao_recebedor body string não CPF (11 Posições)


ou CNPJ (14

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

Posições) do
recebedor

informacoes_entre_usu body string não Mensagem enviada


arios do pagador ao
recebedor (140
posições).

referencia_empresa body string não Texto livre de


referência da
empresa sobre o
pagamento.

identificacao_comprova body string não Texto livre de para


nte identificação do
comprovante da
empresa sobre o
pagamento.

devedor body object não Objeto: Detalhe


Devedor.

pagador body object sim Objeto: Detalhe


Pagador.

Exemplo de entrada
{
"emv":"00020101021126950014BR.GOV.BCB.PIX2573spi.dev.cloud.itau.co
m.br/documentos/eb189f7a-1536-4f16-8951-1056a7736850520400005303986540
79999.005802BR5925ITAU PORTABILIDADE REIVIN6009SAO PAULO626005221Y4XMr
EBhry4ao3no56nrC50300017BR.GOV.BCB.BRCODE01051.0.063046A8D",
"valor_pagamento": "100.00",
"data_pagamento": "2020-09-18",
"pagador": {
"tipo_conta": "CC",
"agencia": "1500",
"conta": "00052012",
"tipo_pessoa": "J",
"documento": "00000000000191",
"modulo_sispag": "Fornecedores"
}
}

Corporativo | Interno
Saída

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

status_pagamento body string sim Status do


pagamento

cod_pagamento body string sim Identificação do


pagamento.

numero_lote body string sim Número de lote


SISPAG.

numero_lancamento body string sim Número do


lançamento
SISPAG.

tipo_pagamento body string sim Tipo da


transferência.

data_pagamento body string sim Data em que será


realizado o
pagamento.
Formato “YYYY-
MM-
DDTHH:MM:SS”
.

valor_pagamento body string sim Valor do


pagamento.

referencia_empresa body string sim Texto livre de


referência da
empresa sobre o
pagamento.

identificacao_comprova body string sim Texto livre de


nte para identificação
do comprovante
da empresa sobre
o pagamento.

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

informacoes_entre_usu body string sim Mensagem a ser


arios enviado ao
pagador via
PACS008 (140).

txid body string não Identificador do


PIX.

documento body object não Objeto: Detalhe


Documento.

pagador body object sim Objeto: Detalhe


Pagador.

recebedor body object sim Objeto: Detalhe


Recebedor.

devedor body object não Objeto: Detalhe


Devedor.

Exemplo de saída

• HTTPStatus - 200

"status_pagamento": "Sucesso",
"cod_pagamento": "93577df4-6f43-4e49-bdff-eb8b053fb931",
"numero_lote": "291000001",
"numero_lancamento": "000019",
"tipo_pagamento": "Transferência Pix Itaú",
"data_pagamento": "2020-08-28T12:00:00",
"valor_pagamento": "100.00",
"referencia_empresa": "Prestação de serviços - Empresa A",
"identificacao_comprovante": "Pagamentos - Empresa A",
"informacoes_entre_usuarios": "Serviço prestado pela Empresa A
",
"txid": "bqJJjaVAThmtnUeVLNnSXQ",
"documento": {
"valor_original": "100.00",
"valor_multa": "0.00",
"valor_juros": "0.00",
"valor_desconto": "0.00",
"valor_final": "100.00",
"calendario_vencimento": "2020-08-20",
"solicitacao_pagador": "",

Corporativo | Interno
"info_adicionais": [{
"nome": "Detalhes do Pagamento",
"valor": "Informação Adicional do PSP do Recebedor"
}]
},
"devedor": {
"tipo_pessoa": "J",
"documento": "62143255000100",
"nome": "Fulano"
},
"pagador": {
"tipo_conta": "CC",
"agencia": "1500",
"conta": "00052012",
"tipo_pessoa": "J",
"documento": "00000000000191",
"modulo_sispag": "Fornecedores"
},
"recebedor": {
"banco": "Itaú Unibanco",
"ispb": "60701190",
"tipo_conta": "CC",
"agencia": "1500",
"conta": "00052061",
"tipo_pessoa": "F",
"documento": "00000000019",
"nome": "Maria PIX",
"tipo_chave": "email",
"identificacao_chave": "maria_pix@gmail.com"
}
}
}
Objetos

Objeto Detalhe Pagador

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

tipo_conta body string Sim Tipo de conta do recebedor.


“CC”: Conta Corrente “CP”:
Conta Pagamento “PP”:
Conta Poupança

agencia body string sim Agência do pagador (4


Posições)

conta body string sim Conta do pagador + Dígito


Verificador (Total 8
Posições)

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

tipo_pessoa body string sim Tipo de pessoa do pagador


(“F” - Fisica ou “J” -
Jurídica)

documento body string sim Documento do pagador


(CPF com 11 Posições ou
CNPJ com 14 Posições)

modulo_sispag body string sim Módulo SISPAG utilizado


para o pagamento.
Dominio: Fornecedores ou
Diversos

Objeto Detalhe Recebedor

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

banco body string não Nome do banco do


recebedor

ispb Body String Sim ISPB do banco do


recebedor

tipo_conta body string Sim Tipo de conta do


recebedor

agencia body string sim Agência do recebedor

conta body string sim Conta do recebedor

tipo_pessoa body string sim Tipo de pessoa do


recebedor (“F” - Fisica
ou “J” - Jurídica)

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

documento body string sim Documento do


recebedor (CPF ou
CNPJ)

nome body string sim Nome do favorecido

identificacao_chave body string não Identificação da chave


utilizada pelo
favorecido

Objeto Detalhe Documento

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

valor_original body string sim Valor original do


documento

valor_multa body string sim Valor multa do


documento

valor_juros body string sim Valor dos juros do


documento

valor_desconto body string sim Valor do desconto do


documento

valor_final body string sim Valor final do


documento

calendario_expirac body string não Data de expiração do


ao documento

calendario_vencim body string não Data de vencimento do


ento documento

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

informacoes_adicio body list- não Objeto Detalhe


nais object Informacoes_Adicionai
s

solicitacao_pagador body string não Mensagem a ser


enviada ao pagador.

Objeto Detalhe Devedor

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

tipo_pessoa body string sim Tipo de pessoa do devedor


(“F” - Fisica ou “J” -
Jurídica)

documento body string sim Documento do devedor (CPF


ou CNPJ)

nome body string sim Nome do devedor

Objeto Detalhe Informacoes_Adicionais

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

nome body string sim Título da informação


adicional

valor body string sim Conteúdo da informação


adicional

Corporativo | Interno
Consulta de pagamentos
Lista de pagamentos

GET /pagamentos_sispag

API responsável por resgatar pagamentos SISPAG. Trará uma lista de pagamentos que
atende aos filtros passados para API.

Entrada

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

agencia_operacao query string sim Agência do


parameter pagador (4
posições)

conta_operacao query string sim Conta do


parameter pagador + Digito
Verificador
(Total de 8
posições)

cnpj_empresa query string sim Documento do


parameter pagador (CPF
com 11 Posições
ou CNPJ com 14
Posições)

numero_lote query string não Número do lote


parameter de pagamento

nome_beneficiario query string não Nome do


parameter recebedor

status query string não Filtro do código


parameter do tipo do status.
Dominios: “AE” -
A Efetuar; “EF” -
Efetuado; “NE” -
Não Efetuado;
“TD” - Todos
(default)

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

data_inicial query Date- não Data do


parameter only pagamento
inicial para
consulta

data_final query Date- não Data do


parameter only pagamento final
para consulta

tipo_lista query string sim Consolidação da


parameter lista de
pagamentos
retornado.
Domínio:
‘Detalhada’ ou
‘Lote’

modalidade_fornecedores query Boolean não Filtro do tipo de


parameter modalidade de
pagamento para
fornecedores

modalidade_imposto query Boolean não Filtro do tipo de


parameter modalidade de
pagamento para
impostos e
tributos

modalidade_salario query Boolean não Filtro do tipo de


parameter modalidade de
pagamento para
salário

tipo_pagamento query string não Filtro do tipo da


parameter transação
bancária. Inserir
o código do
pagamento a ser
filtrado.
(Consultar
códigos na tabela
“Domínio - Tipo
Pagamento”)

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

referencia_empresa query string não Filtro pela


parameter referência da
empresa

valor_minimo query string não Valor mínimo do


parameter pagamento da
consulta

valor_maximo query string não Valor máximo do


parameter pagamento da
consulta

page query string não Número da


parameter pagina a ser
retornada

page_size query string não Quantidade de


parameter pagamentos
retornado por
página

Exemplo de entrada

/pagamentos_sispag?agencia_operacao=1500&conta_operacao=00062573&cn
pj_empresa=60701190000104&modalidade_fornecedores=true&modalidade_i
mpostos=true&tipo_lista=Detalhada&modalidade_salario=false&data_ini
cial=2020-01-01&data_final=2020-12-31&page=0&page_size=3

/pagamentos_sispag?
agencia_operacao=1500&
conta_operacao=00062573&
cnpj_empresa=60701190000104&
modalidade_fornecedores=true&
modalidade_impostos=true&
tipo_lista=Detalhada&
modalidade_salario=false&
data_inicial=2020-01-01&
data_final=2020-12-31&
page=0&
page_size=3

Corporativo | Interno
Saída

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

itens body list- sim Objeto: Pagamento


object

total body string sim Valor total em reais da


somatória de todos os
pagamentos listados

pagination body string sim Objeto: Paginação

Exemplo de saída

{
"data": {
"itens": [
{
"id_pagamento": "2d56a89a-b205-4112-a346-e57b24fbfa23"
,
"status": "Efetuado",
"motivo": "Teste",
"nome_favorecido": "Samwise Gamgee",
"cpf_cnpj": "60701190000104",
"cod_banco": "0",
"numero_agencia": "1500",
"numero_conta": "00052061",
"tipo_pagamento": "Transferência Pix outras instituiçõ
es",
"data_pagamento": "2020-07-10",
"valor_pagamento": "11260.00"
},
{
"id_pagamento": "46e8bcdf-3921-41f3-887c-4bd1988e3eea"
,
"status": "Não Efetuado",
"motivo": "Teste",
"nome_favorecido": "Samwise Gamgee",
"cpf_cnpj": "60701190000104",
"cod_banco": "0",
"numero_agencia": "1500",
"numero_conta": "00052061",
"tipo_pagamento": "Transferência Pix outras instituiçõ
es",
"data_pagamento": "2020-07-10",
"valor_pagamento": "11260.00"
},
{

Corporativo | Interno
"id_pagamento": "58af4526-b842-4531-91df-3fdc4c6c9477"
,
"status": "Não Efetuado",
"motivo": "Teste",
"nome_favorecido": "Samwise Gamgee",
"cpf_cnpj": "60701190000104",
"cod_banco": "0",
"numero_agencia": "1500",
"numero_conta": "00052061",
"tipo_pagamento": "Transferência Pix outras instituiçõ
es",
"data_pagamento": "2020-07-10",
"valor_pagamento": "11260.00"
}
],
"total": "54750523.19"
},
"pagination": {
"page": 0,
"totalPages": 3785,
"totalElements": 11353,
"pageSize": 3
}
}

Objetos

Objeto - Pagamento

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

id_pagamento body string sim Número identificador


do pagamento.

numero_lote body string não Número identificador


do lote de
pagamentos.

numero_lancamento body string não Número do


lançamento do lote
de pagamentos.

nome_favorecido body string não Nome do favorecido.

nome_proprietario body string não Nome do


proprietario.

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

nome_beneficiario body string não Nome do


beneficiario.

cpf_cnpj body string não Número do cpf ou


cnpj.

codigo_banco body string não Identificador Banco.

numero_agencia body string não Número da agência


em operação.

numero_conta body string não Número da conta em


operação.

referencia_empresa body string não referencia_empresa.

data_pagamento body date- sim Data do pagamento.


only Formato yyyy-MM-
dd

data_vencimento body date- não Data do vencimento.


only Formato yyyy-MM-
dd

data_apuracao body date- não Data da apuracao.


only Formato yyyy-MM-
dd

data_infracao body date- não Data da infracao.


only Formato yyyy-MM-
dd

valor_pagamento body string sim Valor do pagamento.

valor_principal body string não Valor principal do


documento.

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

numero_parcela body string não Numero da parcela.

valor_parcela body string não Valor da parcela.

valor_parcela body string não Valor da parcela.

status body string sim Status do pagamento.


<br> “Pendente de
autorização” <br>
“Pendente de
efetivacao” <br>
“Autorizado” <br>
“Efetuado” <br>
“Não Efetuado” <br>
“Pendente de
alteração/exclusão”
<br> “Rejeitado em
arquivo”

comprovante body string não Identificacão do


comprovante

motivo body string não Motivo de recusa

tipo_pagamento body string não Tipo do pagamento.


Será apresentado a
descrição do tipo do
pagamento.
(Consultar descrições
na tabela “Domínio -
Tipo Pagamento”)

linha_digitavel body string não Código de barras

atualizacao_monetaria body string não Valor de taxas, multa,


juros

valor_boleto body string não Valor do boleto

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

boleto_seu_numero body string não Código seu numero


do boleto

boleto_nosso_numero body string não Código nosso numero


do boleto

numero_cheque body string não Número do cheque

numero_op body string não Número do cheque

periodo_competencia body string não Período de


competencia.
Formato MM/yyyy

ano_exercicio body string não Ano de exercicio.


Formato yyyy

nome_prefeitura body string não Nome da prefeitura.

cod_receita body string não Código da receita.

documento_importacao body string não Identificador do


documento de
importacao.

cod_renavam body string não Código de renavam.

cod_placa body string não Placa do veículo.

tipo_guia body string não Código do tipo da


guia.

descricao body string não Anotacoes.

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

uf body string não Código UF.

cod_pagamento body string não Código identificador


do pagamento GPS.

valor_inss body string não Valor do INSS.

valor_dpvat body string não Valor do DPVAT.

descontos body string não Valor dos descontos.

Objeto - Paginação

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

page body string sim Número da página atual.

total_pages body string sim Número total de páginas.

total_elements body string sim Número total de


elementos da consulta.

page_size body string sim Número total de páginas


da consulta.

Corporativo | Interno
Detalhe do pagamento

GET /pagamentos_sispag/{id_pagamento}

API responsável por resgatar o detalhe do pagamento SISPAG. Retorno varia de acordo
com a forma do pagamento detalhado.

Entrada

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

id_pagamento Path string sim Código único do


pagamento.

Exemplo de entrada

/pagamentos_sispag/c6d2cad8-d6ab-4870-8e0d-b4b9090e1535

Saída

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

dados_debito body object sim Objeto: Dados


Debito

dados_pagamento body object sim Objeto: Dados


Pagamento

historico_pagamento body object sim Objeto: Histórico


Pagamento

Exemplo de saída

{
"data": {
"dados_debito": {
"numero_agencia_debito": "1500",
"numero_conta_debito": "00062573",
"nome_empresa_debito": "Nome Pagador - 146",
"cnpj_debito": "60701190000104"
},
"dados_pagamento": {
"id_pagamento": "c6d2cad8-d6ab-4870-8e0d-b4b9090e1535",
"cod_tipo_pessoa": "F",
"cpf_cnpj_favorecido": "58858474872",
"cod_banco_favorecido": "341",

Corporativo | Interno
"nome_banco_favorecido": "ITAÚ UNIBANCO S.A.",
"numero_agencia_favorecido": "1500",
"numero_conta_favorecido": "00601743",
"nome_favorecido": "Nome Favorecido - 146",
"valor_pagamento": "255.85",
"numero_lote": "146",
"numero_lancamento": "146",
"referencia_empresa": "Ref. Empresa - 146",
"data_pagamento": "2020-08-07",
"status": "Efetuado",
"descricao_pagamento": "Desc. da Finalidade - 146",
"identificacao_comprovante": "Desc. da Comprovante - 146",
"codigo_isbp": "60701190",
"descricao_finalidade": "Desc. da Finalidade - 146",
"tipo_pagamento": "46",
"tipo_pagamento_descricao": "Transferência Pix outras inst
ituições",
"motivo_rejeicao": [],
"dados_pix_transferencia": {
"chave_enderecamento": "alias146@itau.com.br"
}
},
"historico_pagamento": [
{
"status": "Inclusão Online",
"data": "2020-08-07-16.01.13.427000",
"cod_operador": "889911348"
},
{
"status": "Efetivação",
"data": "2020-08-07-18.01.13.427000",
"cod_operador": "889911348"
},
{
"status": "Autorização",
"data": "2020-08-07-17.01.13.427000",
"cod_operador": "889911348"
}
]
}
}
Objetos

Objeto - Dados Debito

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

numero_agencia_debito body string sim Agência do


débito

numero_conta_debito body string sim Conta do


débito

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

nome_empresa_debito body string sim Nome da


empresa

cnpj_debito body string sim CNPJ da


empresa

Objeto - Histórico Pagamento

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

status body string sim Etapa do pagamento:


“Inclusão Online”,
“Autorização”, “Efetivação”,
“Inclusão - Arquivo”,
“Autorização operacional”,
“1ª Autorização”, “Visto”

data body string sim Data que aconteceu a etapa


do pagamento

nome_operador body string sim Nome do operador que


efetuou a operação

cod_operador body string sim Código do operador que


efetuou a operação

cpf_operador body string sim CPF do operador que


efetuou a operação

Objeto - Dados Pagamentos

Tipo Tipo
Parâmetr Dad Obrigatóri
Parâmetro o o o Descrição

nome_favorecido body strin sim Nome do


g Favorecido

Corporativo | Interno
Tipo Tipo
Parâmetr Dad Obrigatóri
Parâmetro o o o Descrição

id_pagamento body strin sim Número


g identificador do
pagamento

cod_tipo_pessoa body strin sim Tipo pessoa


g

cpf_cnpj_favorecido body strin sim Número do cpf


g cnpj do favorecido

cod_banco_favorecido body strin sim Identificador


g Banco do
favorecido

nome_banco_favorecido body strin sim Nome / Descrição


g do banco

numero_agencia_favorecido body strin sim Número da


g agência do
favorecido

numero_conta_favorecido body strin sim Número da


g contado
favorecido

nome_favorecido body strin sim Nome do


g favorecido

valor_pagamento body strin sim Valor do


g pagamento

numero_lote body strin sim Número do lote


g

numero_lancamento body strin sim Número do


g lancamento

Corporativo | Interno
Tipo Tipo
Parâmetr Dad Obrigatóri
Parâmetro o o o Descrição

referencia_empresa body strin não Número de


g referência da
empresa

data_pagamento body strin sim Data do


g pagamento

status body strin sim Status do


g pagamento

descricao_pagamento body strin sim Texto contendo a


g descrição do
pagamento

identificacao_comprovante body strin não Código de


g identificação do
comprovante

codigo_isbp body strin sim Código Isbp


g

modalidade_pagamento body strin sim Código da


g modalidade de
pagamento

tipo_pagamento body strin sim Código da


g modalidade de
pagamento

tipo_pagamento_descricao body strin sim Descricao da


g modalidade de
pagamento

motivo_rejeicao body list- sim Descrição do


strin motivo de recusa.
g

Corporativo | Interno
Tipo Tipo
Parâmetr Dad Obrigatóri
Parâmetro o o o Descrição

dados_ted body objec não Objeto: TED


t

dados_dpvat body objec não Objeto: DPVAT


t

dados_fgts body objec não Objeto: FGTS


t

dados_gare_icms_sp body objec não Objeto: GARE


t ICMS SP

dados_gare_icms_sp_importa body objec não Objeto: GARE


cao t ICMS SP
IMPORTACAO

dados_gnre_icms_sp_import body objec não Objeto: GNRE


acao t ICMS SP
IMPORTACAO

dados_gps body objec não Objeto: GPS


t

dados_iptu_inss body objec não Objeto: IPTU


t INSS

dados_ipva body objec não Objeto: IPVA


t

dados_multa body objec não Objeto: MULTA


t

dados_op body objec não Objeto: OP


t

Corporativo | Interno
Tipo Tipo
Parâmetr Dad Obrigatóri
Parâmetro o o o Descrição

dados_doc body objec não Objeto: DOC


t

dados_darf body objec não Objeto: DARF


t

dados_cheque body objec não Objeto: CHEQUE


t

dados_tributos_cod_barras body objec não Objeto:


t TRIBUTOS
CODIGO DE
BARRAS

dados_boleto body objec não Objeto: BOLETO


t

dados_concessionaria body objec não Objeto:


t CONCESSIONAR
IA

dados_das_cod_barras body objec não Objeto: DAS


t CODIGO DE
BARRAS

dados_pix_transferencia body objec não Objeto: PIX


t TRANSAFERENC
IA

dados_pix_qr_code body objec não Objeto: PIX


t QRCODE

dados_licenciamento body objec não Objeto:


t LICENCIAMENT
O

Objeto - TED

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

numero_ted body string não Número da


TED

complemento_finalidade_ted body string não Complemento


da finalidade
da TED

Objeto - DPVAT

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

nome_contribuinte body string sim Nome do


contribuinte

numero_renavam body string sim Número do


Renavam

cod_placa body string sim Placa do veículo

valor_dpvat body string sim Valor do DPVAT

descontos body string não Valor dos


descontos

Objeto - FGTS

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

linha_digitavel body string sim Código de barras

tipo_guia body string sim Tipo da guia

cnpj_cei body string sim Identificador


CNPJ/CEI

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

data_vencimento body string sim Data do vencimento do


documento

Objeto - GARE ICMS SP

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

valor_multa_mora body string sim Valor de


multa/mora

acrescimo_financeiro body string sim Valor de acrescimo

horarios_advocativos body string sim Valor de horário


advocativo

cod_receita body string sim Código da receita

periodo_referencia body string sim Período de


referência

data_vencimento body string sim Data de vencimento


para o pagamento

valor_receita body string sim Valor da receita

valor_juros_mora body string sim Valor de juros/mora

Objeto - GARE ICMS SP IMPORTACAO

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

nome_contribuinte body string sim Nome do


contribuinte

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

documento_importacao body string sim Número do


documento de
importacao

cod_receita body string sim Código da receita

Objeto - GNRE ICMS SP IMPORTACAO

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

linha_digitavel body string sim Código de barras

nome_contribuinte body string sim Nome do


contribuinte

Objeto - GPS

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

nome_contribuinte body string sim Nome do


contribuinte

cpf_cnpj body string sim Número de cpf/cnpj


do contribuinte

cod_pagamento body string não Código identificador


do pagamento

periodo_competencia body string sim Período de


competência

data_vencimento body string date-only Data de vencimento


para o pagamento.
Formato yyyy-MM-
dd

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

valor_inss body string não Valor do INSS

valor_outras_entidades body string não Valor de outras


entidades

atualizacao_monetaria body string não Atualização


monetária de
Juros/Multa/Mora

Objeto - IPTU INSS

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

linha_digitavel body string sim Código de barras

nome_prefeitura body string sim Nome da


prefeitura

Objeto - IPVA

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

nome_contribuinte body string sim Código de barras

numero_renavam body string sim Número do renavam

cod_placa body string sim Placa do Veículo

data_vencimento body date- sim Data de vencimento


only para o pagamento.
Formato yyyy-MM-dd

numero_parcela body string sim Número da parcela

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

valor_parcela body string sim Valor da parcela

valor_descontos body string sim Valor d

Objeto - MULTA

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

nome_contribuinte body string sim Código de barras

numero_renavam body string sim Número do renavam

cod_placa body string sim Placa do Veículo

cod_infracao body string sim Placa do Veículo

numero_guia body string sim Número


identificador da guia

nome_orgao_autuador body string sim Nome do órgão


autuador

data_vencimento body date- sim Data de vencimento


only para o pagamento.
Formato yyyy-MM-
dd

Objeto - OP

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

numero_op body string sim Código identificador


OP

Objeto - DOC

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

numero_doc body string sim Código identificador


DOC

Objeto - DARF

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

nome_contribuinte body string sim Nome do contribuinte

cnpj_contribuinte body string sim Número do CNPJ

cod_receita body string sim Número da receita

data_apuracao body date- sim Data da apuração.


only Formato yyyy-MM-dd

data_vencimento body date- sim Data do vencimento.


only Formato yyyy-MM-dd

valor_principal body string sim Valor principal do


pagamento

valor_multa body string sim Valor de multa

valor_juros body string sim Valor de Juros

descricao body string não Descrição DARF

Objeto - CHEQUE

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

numero_cheque body string sim Número do


cheque

Objeto - TRIBUTOS CODIGO DE BARRAS

Parâmetro Tipo Parâmetro Tipo Dado Obrigatório Descrição

linha_digitavel body string sim Código de barras

Objeto - BOLETO

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

nome_beneficiario body string sim Nome do


beneficiário

linha_digitavel body string sim Código de barras

razao_social body string não Código da razão


social

documento_beneficiario body string não Documento do


beneficiário

nome_sacador_avalista body string sim Nome do sacador


avalista

nome_pagador body string sim Nome do pagador


do boleto

data_vencimento body string date-only Data de


vencimento do
boleto. Formato
yyyy-MM-dd

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

valor_boleto body string sim Valor do boleto

valor_descontos body string não Valor de descontos


do boleto

valor_multa body string não Valor de multa do


boleto

Objeto - CONCESSIONARIA

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

nome_concessionaria body string sim Nome da


concessionaria

linha_digitavel body string sim Código de barras

Objeto - DAS CODIGO DE BARRAS

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

nome_contribuinte body string sim Nome do


contribuinte

linha_digitavel body string sim Código de barras

Objeto - PIX TRANSAFERENCIA

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

chave_enderecamento body string sim Chave de


endereçamento do
PIX

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

mensagem_ao_recebedor body string sim Campo de


mensagem para o
recebedor do
pagamento

Objeto - PIX QRCODE

Tipo
Parâmetr Tipo Obrigatóri
Parâmetro o Dado o Descrição

nome_pagador_qr_code body string sim Nome do


pagador do
qr code

documento_pagador_qr_cod body string sim Campo de


e mensagem
para o
recebedor
do
pagamento

chave_enderecamento body string sim Campo de


mensagem
para o
recebedor
do
pagamento

data_expiracao body datetime sim Data de


-only expiração do
qr code.
Formato
2019-10-
18T12:00:0
0

data_vencimento body datetime sim Data de


-only vencimento
para o
pagamento.
Formato
2019-10-

Corporativo | Interno
Tipo
Parâmetr Tipo Obrigatóri
Parâmetro o Dado o Descrição

18T12:00:0
0

valor_documento body string sim Valor do


documento

multa body string sim Valor de


multa

juros body string sim Valor de


juros

desconto body string sim Valor de


desconto

identificador_qr_code body string sim Identificado


r do qr code

mensagem_ao_recebedor body string sim Campo de


mensagem
enviado ao
recebedor

mensagem_do_recebedor body string sim Campo de


mensagem
gerada do
recebedor

Objeto - LICENCIAMENTO

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

dados_ipva body list- sim Objeto: LICENCIAMENTO


object VEICULO

Corporativo | Interno
Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

dados_dpvat body list- sim Objeto: LICENCIAMENTO


object VEICULO

dados_multa body list- sim Objeto: LICENCIAMENTO


object MULTA

Objeto - LICENCIAMENTO VEICULO

Parâmetro Tipo Parâmetro Tipo Dado Obrigatório Descrição

exercicio body string sim Ano do exercício

valor body string sim Valor do imposto

Objeto - LICENCIAMENTO MULTA

Tipo Tipo
Parâmetro Parâmetro Dado Obrigatório Descrição

numero_guia body string sim Número da guia da


multa

data_infracao body datetime- sim Data da infração da


only multa. Formato 2019-
10-18T12:00:00

data_vencimento body datetime- sim Data de vencimento


only para o pagamento do
exercício. Formato
2019-10-18T12:00:00

valor body string sim Valor do imposto

Domínios Consulta

Domínio - Tipo Pagamento

Corporativo | Interno
Código Descrição

“01” “Conta Corrente”

“02” “Cheque pagamento”

“03” “DOC”

“04” “OP (duas vias)”

“05” “Conta Poupança”

“06” “Conta Corrente Mesma Titularidade”

“07” “DOC D mesma titularidade”

“10” “OP (uma via)”

“11” “OP (acerto)”

“13” “Concessionária”

“16” “DARF normal”

“17” “GPS”

“18” “DARF simples”

“19” “IPTU/ISS e outros tributos”

“22” “GARE ICMS-SP”

“23” “GARE ICMS-SP Importação”

Corporativo | Interno
Código Descrição

“25” “Banco Múltiplo”

“27” “DPVAT”

“30” “Boleto Itaú”

“31” “Boleto outros bancos”

“32” “Nota fiscal eletrônica”

“35” “FGTS”

“38” “Boleto outros bancos online”

“41” “TED outro titular”

“43” “TED mesmo titular”

“51” “Licenciamento”

“53” “Multa”

“63” “Concessionária com moeda variável”

“90” “DAE E-SOCIAL”

“91” “Tributos com código de barras”

“92” “Darf código de barras”

“93” “DAS código barras”

Corporativo | Interno
Código Descrição

“94” “GNRE ICMS-SP Importação”

“95” “IPVA”

“45” “Transferência Pix Itaú”

“46” “Transferência Pix outras instituições”

“47” “QR Code Pix Itaú”

“60” “Cartão Salário”

“48” “QR Code Pix outras instituições”

Domínio - Motivos de recusa

COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

004 LOTE SEM HEADER

005 LOTE SEM TRAILER

006 LOTE SO COM HEADER

007 LOTE SO COM TRAILER

009 LOTE DUPLICADO

014 DATA DE GERACAO DO ARQUIVO


INVALIDA

015 TIPO DE OPERACAO INVALIDA

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

016 TIPO DE INSCRICAO INVALIDA

017 FORMA DE PAGAMENTO INVALIDA

018 TIPO DE PAGAMENTO INVALIDO

019 TIPO X FORMA DE PAGAMENTO NAO


COMPATIVEIS

020 CODIGO SISPAG NAO CADASTRADO

021 NUMERO DE LOTE FORA DE SEQUENCIA

022 NUMERO DE LOTE INVALIDO

023 C.G.C INVALIDO

024 QTDE TOTAL O.P.

025 NOME DO PAGADOR INVALIDO

026 SEGMENTO PGI INVALIDO (DIFERENTE DE


A/B/C/K/L/M)

027 SEQUENCIA DOS SEGMENTOS INVALIDA

028 ERRO DE SEQUENCIA DOS REGISTROS

029 CAMPO SEQUENCIA NAO NUMERICO

030 REGISTRO DESPREZADO (PARA K/L/M)

031 BANCO DIFERENTE DE 341

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

032 CODIGO DO BANCO NAO NUMERICO

033 QUANTIDADE DE REGISTROS NAO


NUMERICA

034 QTDE DE REGS. CALCULADA DIFER. DA


QTDE INFORMADA

035 QUANTIDADE DE REGISTROS MAIOR QUE


999999

036 VALOR TOTAL NAO NUMERICO

037 VALOR CALCULADO DIFERENTE DO


INFORMADO

038 CODIGO DO USUARIO SIGMA INVALIDO

039 EXISTE MAIS DE UMA


CONTA/CONTRAPARTIDA

040 NUMERO DE ORDEM INVALIDO

041 DATA DE CREDITO MAIOR QUE 1 ANO

042 DATA DE CREDITO EXPIRADA

043 DATA DE CREDITO INVALIDA

044 CONTA/CONTABIL LANCAMENTO


INVALIDA

045 DAC CONTA/CONTABIL LANCAMENTO


INVALIDA

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

046 CONTA/CONTABIL LANCAMENTO NAO


ACEITA LTR

047 CONTA/CONTABIL LANCAMENTO NAO


CADASTRADO PCI

048 CONTA/BANCO MULTIPLO LANCAMENTO


INVALIDA

049 DAC CONTA/BANCO MULTIPLO


LANCAMENTO INVALIDO

050 CONTA/BANCO MULTIPLO LANCAMENTO


NAO ACEITA LTR

051 CONTA/BCO MULTIPLO LANCAMENTO


NAO CADASTRADO PCM

052 AGENCIA OU ORGAO LANCAMENTO


INVALIDOS

053 FORMA DE PAGAMENTO ALTERADA

054 TIPO DE MOVIMENTO INVALIDO

055 CODIGO DE INSTRUCAO INVALIDO

056 INFORMACAO DE ALTERACAO INVALIDA

057 DAC INFORMACAO DE ALTERACAO


INVALIDO

058 BANCO DEPOSIT. INVALIDO

059 AGENCIA CEDENTE CONTEM ZEROS

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

060 AGENCIA CEDENTE INVALIDA

061 CONTA CEDENTE CONTEM ZEROS

062 CONTA CEDENTE CONTEM BRANCOS

063 CONTA CEDENTE INVALIDA

064 NOME DO CEDENTE INVALIDO

065 NOSSO NUMERO INVALIDO

066 REMETENTE MOTIVO INVALIDO

067 REMETENTE MOTIVO OBRIGATORIO

068 VALOR DO TITULO INVALIDO

069 VALOR DO ABATIMENTO INVALIDO

070 VALOR DO DESCONTO INVALIDO

071 VALOR DE MORA INVALIDO

072 VALOR DA MULTA INVALIDO

073 DATA DE VENCIMENTO INVALIDA

074 DAC AGE/CTA/CART/NOSNUM INVALIDO

075 DAC CART/NOSNUM INVALIDO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

076 USO BANCO INVALIDO P/ UNIBANCO

077 VALOR DE DEDUCAO INVALIDO

078 VALOR DE ACRESCIMO INVALIDO

079 CARTEIRA INVALIDA P/ ARQ. CSC

080 ALTERACAO DE LOTE INVALIDA

081 CODIGO DO BANCO INVALIDO

082 ORGAO DEST. INVALIDO - CMV.ORGAOS

083 AGENCIA DEST. ENCERRADA

084 AGENCIA DEST. FICTICIA

085 AGENCIA DEST. INVALIDA B0V.AGENCIA

086 DAC CONTA/CORRENTE FAVORECIDO


INVALIDO

087 AGE/CTA FAVORECIDO INVALIDA

088 CONTA/CORRENTE FAVORECIDO NAO


CADASTRADO CCV.CDR

089 CONTA/CORRENTE MAIOR 99900

090 AGE/ORGAO DEST. NAO NUMERICA

091 DOC PARA BANCO ITAU

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

092 BANCO/AGENCIA NAO CADASTRADOS NO


CKV.OBA

093 CAM. COMPENSACAO INVALIDA

094 AGENCIA CENTRALIZADORA INVALIDA

095 IDENTIF. TIPO CHEQUE INVALIDA

096 LOGRADOURO INVALIDO

097 NUMERO LEC INVALIDO

098 CIDADE LEC INVALIDA

099 ESTADO LEC INVALIDO

100 CEP LEC INVALIDO

101 REGISTRO DESPREZADO

102 ARQUIVO SO COM HEADER

103 ARQUIVO SEM HEADER VALIDO

104 ARQUIVO SEM TRAILER-PGI

105 VALOR DO PAGAMENTO INVALIDO

107 QTDE DE MOVTOS PROCESSADOS DIFERE


DO MOVTO FINAL

108 ARQUIVO DESPREZADO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

109 REGISTRO DIFERENTE DE: 0, 1, 3, 5 E 9

110 MAIS DE UMA MOEDA NO LOTE

111 VALOR ACIMA LIMITE

112 VALOR ABAIXO LIMITE

113 DATA DE CONVERSAO INVALIDA

114 TIPO DE MOEDA INVALIDO

115 CAMPO DEBITO/CREDITO INVALIDO

116 EMPRESA NAO CADASTRADA (AG/CONTA)

117 EMPRESA NAO CADASTRADA (TIPO/CNPJ)

118 CODIGO DE PAGAMENTO INVALIDO

119 COMPETENCIA INVALIDA

120 CAMPO IDENTIFICADOR INVALIDO

121 VALOR INSS INVALIDO

122 VALOR DE OUTRAS ENTIDADES INVALIDO

123 VALOR DE ATUALIZACAO MONETARIA


INVALIDO

124 VALOR TOTAL INVALIDO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

125 DATA DE ARRECADACAO INVALIDA

126 AGENCIA RECEBEDORA INVALIDA

127 INSCRICAO ESTADUAL INVALIDA

128 CODIGO DA RECEITA INVALIDO

129 NUMERO DO DOCUMENTO ORIGEM


INVALIDO

130 PER.REF/PARCELA INVALIDA

131 IND. PESSOA FIS/JUR. INVALIDO

132 PERIODO DE APURACAO INVALIDO

133 RECEITA BRUTA INVALIDA

134 REFERENCIA INVALIDA

138 BOLETO NAO REGISTRADO NA CIP

139 BOLETO INAPTO PARA PAGAMENTO NA CIP

140 BANCO DIVERTENTE DO CADASTRO CIP

141 DADOS DO BOLETO PREENCHIDOS


INCORRETAMENTE

142 CNPJ PAGADOR DIVERTENTE DO


CADASTRO CIP

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

143 CNPJ SACADOR AVALISTA DIVERTENTE DO


CADASTRO CIP

144 DATA LIMITE DO BOLETO INVALIDA

145 QUANTIDADE DE BAIXAS OPERACIONAIS


MAIOR QUE PERMIT

146 PAGAMENTO DE BOLETO EM


DUPLICIDADE

201 TIPO X FORMA DE PAGAMENTO NAO


COMPATIVEIS

202 CODIGO DO USUARIO SIGMA INVALIDO

203 CTA-CONTABIL/BCO-MULTIPLO
LANCAMENTO INVALIDO

204 DAC CTA-CONTABIL/BCO-MULTIP


LANCAMENTO INVALIDO

205 CTA-CONTABIL/BCO-MULT LANCAMENTO


NAO ACEITA LTR

206 CTA-CONTABIL/BCO-MULT LANC NAO


CADASTRADO CJ.CCD

211 AGENCIA OU ORGAO LANCAMENTO


INVALIDOS

212 FORMA DE PAGAMENTO ALTERADA

213 ORGAO DEST. INVALIDO - CMV.ORGAOS

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

214 AGENCIA DEST. ENCERRADA

215 AGENCIA DEST. FICTICIA

216 AGENCIA DEST. INVALIDA B0V.AGENCIA

217 DÍGITO INCORRETO PARA A CONTA


INFORMADA

218 AGE/CTA FAVORECIDO INVALIDA

219 CONTA/CORRENTE FAVORECIDO NAO


CADASTRADO CCV.CDR

220 CONTA/CORRENTE MAIOR 99900

221 AGE/ORGAO DEST. NAO NUMERICA

222 DOC/TED PARA BANCO ITAU

223 BANCO/AGENCIA NAO CADASTRADOS NO


CKV.OBA

224 CAM. COMPENSACAO INVALIDA

225 AGENCIA CENTRALIZADORA INVALIDA

226 IDENTIF. TIPO CHEQUE INVALIDA

227 LOGRADOURO INVALIDO

228 NUMERO LEC INVALIDO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

229 CIDADE LEC INVALIDA

230 ESTADO LEC INVALIDO

231 CEP LEC INVALIDO

232 REGISTRO DESPREZADO

233 VALOR ACIMA LIMITE

234 VALOR ABAIXO LIMITE

235 DATA DE CONVERSAO INVALIDA

236 DÍGITO INCORRETO PARA A CONTA


INFORMADA

238 OPERACAO NAO REALIZADA/ BOLETO


BLOQUEADO/ BOLETO J

300 CONCESSIONARIA NAO CADASTRADA

301 COD.BAR. NAO NUMERICO OU = ZEROS

302 DAC COD.BAR. INVALIDO

303 VALOR COD.BAR. E VALOR INFORMADO


DIFERENTES

304 VALOR COD.BAR. NAO NUMERICO

305 SEGMENTO COD.BAR. INVALIDO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

306 CODIGO DE BARRAS DEVE INICIAR COM 8

307 BANCO NAO PARTICIPANTE DO SPB

308 BANCO NAO PARTICIPANTE DO SPB - TED

309 BANCO NAO PARTICIPA


TEMPORARIAMENTE DO SPB

310 VALOR DE TED MENOR QUE R$ 5.000,00

311 PAGTO NAO PERMITIDO POR EXCEDER


HORARIO LIMITE

312 FAVORECIDO NAO CADASTRADO PARA TED

313 VALOR DO DOC ACIMA DO LIMITE P/


FAVORECIDO

320 CONCESSIONARIA NAO LIBERADA PARA


PGTO NO AUTO-ATEN

321 MOEDA DO CODIGO DE BARRAS


DIFERENTE DE 6,7,8 E 9

322 EMPRESA DO CODIGO DE BARRAS


INVALIDA PARA GPS

323 PAGTO FROTAS REJEITADO

324 LICENCIAMENTO 2VIA TRANS. NÃO


PERMITIDA

325 LICENCIAMENTO EFETUADO E NÃO


EMITIDO NO DETRAN

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

326 VEICULO DE 2 LETRAS, SOMENTE


TRANSFERENCIA E LIC.

327 TAXA DE CORREIO OBRIGATORIO NO LICC.


ANTECIPADO.

328 PAGTO FROTAS REJEITADO

329 LICENCIAMENTO C/MULTA RENAINF -


EFETUAR PAGTO

330 VEICULO OFICIAL - NÃO PERMITIDO


EFETUAR PAGTO

331 VEICULO OFICIAL - NÃO PERMITIDO


EFETUAR PAGTO

332 PAGTO BLOQUEADO

333 PAGTOS COM MAIS DE 15 MULTAS

334 PAGTOS COM MAIS DE 15 MULTAS

335 FALTA DE TRANSFERENCIA OU ENDEREÇO


IRREGULAR

336 DUPLICIDADE DE PLACA

337 PAGTO FROTAS REJEITADO

338 DETRAN FORA DE OPERACAO

339 PAGTO FROTAS REJEITADO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

340 PAGTO REJEITADO - NR IDENTIFICADOR


DUPLICADO

341 PAGTO REJEITADO - NR SOLITACAO


INVÁLIDO

450 LOTE SEM HEADER

451 LOTE SEM TRAILER

452 LOTE SO COM HEADER

453 LOTE SO COM TRAILER

454 LOTE SEM TRANSACAO

455 LOTE DUPLICADO

456 DATA DE GERACAO DO ARQUIVO


INVALIDA

457 TIPO DE OPERACAO INVALIDA

458 TIPO DE INSCRICAO INVALIDA

459 FORMA DE PAGAMENTO INVALIDA

460 TIPO DE PAGAMENTO INVALIDO

461 CODIGO SISPAG NAO CADASTRADO

462 NUMERO DE LOTE FORA DE SEQUENCIA

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

463 NUMERO DE LOTE INVALIDO

464 C.G.C INVALIDO

465 QTDE TOTAL O.P.

466 NOME DO PAGADOR INVALIDO

467 SEGMENTO PGI INVALIDO

468 FORMATO INCORRETO DO ARQUIVO CNAB


240

469 ERRO DE SEQUENCIA DOS REGISTROS

470 CAMPO SEQUENCIA NAO NUMERICO

471 REGISTRO DESPREZADO

472 BANCO DIFERENTE DE 341

473 CODIGO DO BANCO NAO NUMERICO

474 QUANTIDADE DE REGISTROS NAO


NUMERICA

475 QTDE DE REGS. CALCULADA DIFER. DA


QTDE INFORMADA

476 QUANTIDADE DE REGISTROS MAIOR QUE


999999

477 VALOR TOTAL NAO NUMERICO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

478 VALOR CALCULADO DIFERENTE DO


INFORMADO

479 EXISTE MAIS DE UMA


CONTA/CONTRAPARTIDA

480 NUMERO DE ORDEM INVALIDO

481 DATA DE CREDITO MAIOR QUE 1 ANO

482 DATA PARA PAGAMENTO INDICADA NO


ARQUIVO INVÁLIDA

483 DATA DO AGENDAMENTO INVÁLIDA

484 TIPO DE MOVIMENTO INVALIDO

485 CODIGO DE INSTRUCAO INVALIDO

486 INFORMACAO DE ALTERACAO INVALIDA

487 DAC INFORMACAO DE ALTERACAO


INVALIDO

488 BANCO DEPOSIT. INVALIDO

489 AGENCIA CEDENTE CONTEM ZEROS

490 AGENCIA CEDENTE INVALIDA

491 CONTA CEDENTE CONTEM ZEROS

492 CONTA CEDENTE CONTEM BRANCOS

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

493 CONTA CEDENTE INVALIDA

494 NOME DO FAVORECIDO INVALIDO

495 NOSSO NUMERO INVALIDO

496 REMETENTE MOTIVO INVALIDO

497 REMETENTE MOTIVO OBRIGATORIO

498 PAGAMENTO REJEITADO, CONTATE A


CENTRAL DE ATENDIME

499 VALOR DO ABATIMENTO INVALIDO

500 VALOR DO DESCONTO INVALIDO

501 VALOR DE MORA INVALIDO

502 VALOR DA MULTA INVALIDO

503 DATA DE VENCIMENTO INVALIDA

504 DAC AGE/CTA/CART/NOSNUM INVALIDO

505 DAC CART/NOSNUM INVALIDO

506 USO BANCO INVALIDO P/ UNIBANCO

507 VALOR DE DEDUCAO INVALIDO

508 VALOR DE ACRESCIMO INVALIDO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

509 CARTEIRA INVALIDA P/ ARQ. CSC

510 ALTERACAO DE LOTE INVALIDA

511 NÚMERO DO BANCO INCORRETO

512 ARQUIVO SO COM HEADER

513 ARQUIVO SEM HEADER VALIDO

514 ARQUIVO SEM TRAILER-PGI

515 VALOR DO PAGAMENTO INVALIDO

516 QTDE DE MOVTOS PROCESSADOS DIFERE


DO MOVTO FINAL

517 ARQUIVO DESPREZADO

518 REGISTRO DIFERENTE DE: 0, 1, 3, 5 E 9

519 MAIS DE UMA MOEDA NO LOTE

520 TIPO DE MOEDA INVALIDO

521 CAMPO DEBITO/CREDITO INVALIDO

522 EMPRESA NAO CADASTRADA (AG/CONTA)

523 EMPRESA NAO CADASTRADA (TIPO/CNPJ)

524 FORMA X SEGMENTO INCOMPATIVEIS

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

525 SEU NUMERO INVALIDO

526 DAC DO CODIGO DE BARRAS INVALIDO

527 CARTEIRA DE DESCONTO INVALIDA

528 VALOR LIQ. DIF. VALOR NOMINAL - DESC.


+ ACRESC.

529 DAC CART/NOSNUM DO COD. DE BARRAS


INVALIDO.

530 DAC AG/CTA/CART/NOSNUM DO


COD.BARRAS INVALIDO.

531 IDENTIFICACAO DO CODIGO DE BARRAS


INVALIDO.

532 DAC CART/NOSNUM/NDOC/IDENTIF DO


COD.BARRAS INV.

533 DOC/TED DO BFB PARA O BFB

534 DAC AG/CONTA DO CEDENTE INVALIDO

535 DAC AG/CONTA DO CEDENTE DO


COD.BARRAS INVALIDO

536 DAC DO NOSSO NUMERO DO CODIGO


BARRAS INVALIDO

537 AGENCIA CEDENTE DO CODIGO BARRAS


INVALIDO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

538 SEGMENTO J NAO PERMITIDO PARA


LAYOUT 010

539 TITULARIDADE INVALIDA PARA ISENCAO


DO CPMF.

540 DOC/TED DO BANERJ PARA O BANERJ

541 COMPLEMENTO 1 INVALIDO

542 COMPLEMENTO 2 INVALIDO

543 CODIGO DE SERVICO INVALIDO

544 CODIGO DE AGENDAMENTO INVALIDO

545 DATA DE OPERACAO INVALIDA

546 HORA DE OPERACAO INVALIDA

547 DATA DE AGENDAMENTO INVALIDA

548 AGENCIA DE ORIGEM INVALIDA

549 TERMINAL INVALIDO

550 CANAL INVALIDO

551 NUMERO DO CARTAO DE CREDITO


INVALIDO

552 CODIGO DE BARRAS DE CONCESSIONARIA


INVALIDO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

553 TIPO INSTITUICAO ORIGEM INVALIDO

554 TIPO INSTITUICAO CLIENTE INVALIDO

555 COD. INSTITUICAO ORIGEM INVALIDO

556 COD. INSTITUICAO CLIENTE INVALIDO

557 COD. TERMINAL INVALIDO

558 TIPO CARTAO INVALIDO

559 COD. AUTORIZACAO INVALIDO

560 COD. PRODUCAO INVALIDO

561 TIPO PRODUCAO INVALIDO

562 SUBCONTA INVALIDA

563 OPCAO DE RESGATE INVALIDA

564 CODIGO DE CANAL INVALIDO

565 DAC DA AG/CTA DE AGENDAMENTO


INVALIDO

566 ENTIDADE ZERADA OU NAO NUMERICA

567 GRUPO ZERADO OU NAO NUMERICO

568 MATRICULA CONTEM BRANCOS

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

569 SUPLEMENTO NAO NUMERICO

570 COMPETENCIA NAO NUMERICA

571 CNPJ/CPF DO FAVORECIDO INVALIDO

572 CPF/CNPJ INCORRETO PARA AGÊNCIA E


CONTA INFORMADA

573 CONTA DO FAVORECIDO INEXISTENTE OU


INDISPONÍVEL PA

574 FOLHA-BKL NAO PODE SER PROCESSADA


VIA ARQUIVO

575 PAGAMENTO DE SALARIO PARA PESSOA


JURIDICA

579 CNPJ/CPF INVALIDO - TODO O LOTE SERA


REJEITADO

580 DATA PAGAMENTO - REPASSE INVALIDA

581 VALOR REPASSE / TOTAL PARCELA


INVALIDO

582 NUMERO CONTRATO INVALIDO

583 NUMERO PARCELA INVALIDO

584 INDICADOR DE NAO REPASSE INVALIDO

585 DATA VENCIMENTO PARCELA INVALIDA

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

586 CODIGO UNIDADE ADMINISTRATIVA


INVALIDO

587 STATUS DO MUTUARIO INVALIDO

588 VALOR DA MARGEM INVALIDO

589 IDENTIFICADOR DO SINDICATO INVALIDO

590 QUANTIDADE PARCELAS CONTRATO


INVALIDO

591 DATA INICIO CONTRATO INVALIDA

592 DATA FIM CONTRATO INVALIDA

593 VALOR TOTAL LIBERADO INVALIDO

594 VALOR TOTAL OPERACAO INVALIDO

595 VALOR TOTAL SALDO DEVEDOR INVALIDO

596 QUANTIDADE CONTRATOS NO BANCO


INVALIDA

597 VALOR DA CONTRAPRESTACAO INVALIDO

598 VALOR RESIDUAL GARANTIDO INVALIDO

599 CODIGO NAO REPASSE / INDICADOR


MOTIVO INVALIDO

600 AGENCIA/CONTA INEXISTENTE/INVALIDA


PARA CONTRATO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

601 QUANTIDADE TOTAL DE PARCELAS


INVALIDA

602 VALOR TOTAL DAS PARCELAS INVALIDA

603 QUANTIDADE DE PARCELAS


CONSIGNADAS INVALIDA

604 VALOR DAS PARCELAS CONSIGNADAS


INVALIDA

605 QUANTIDADE DE PARCELAS NAO


CONSIGNADAS INVALIDA

606 VALOR DAS PARCELAS NAO CONSIGNADAS


INVALIDA

607 CODIGO DE PAGAMENTO NAO NUMERICO

609 COMPETENCIA INVALIDA PARA A RECEITA


INFORMADA

610 ANO ANTERIOR A 1996

611 CNPJ INVALIDO

612 CEI INVALIDO

613 DEBCAD INVALIDO

614 NIT INVALIDO

615 NUMERO DO TITULO INVALIDO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

616 NB INVALIDO

617 VALOR DO INSS DEVE ESTAR ZERADO

618 VALOR ENT. DEVE ESTAR ZERADO

619 VALOR ATUALIZ. OBRIGATORIO

620 VALOR ATUALIZ. OBRIGATORIO CRITERIO


A/B/C

621 VALOR ATUALIZ. DEVE ESTAR ZERADO

622 VALOR TOTAL DIFERENTE DA SOMATORIA


DOS VALORES

623 VALOR TOTAL INFERIOR AO LIMITE


PERMITIDO

624 GPS CODIGO DE BARRAS INVALIDO

626 PAGAMENTO NÃO PROCESSADO. ENVIE


NOVAMENTE.

640 ARQUIVO DUPLICADO

641 NUMERO UNICO EMPRESA EM BRANCO

750 ERRO NA CHAMADA AO SUB-PROGRAMA


R1

751 CODIGO DE BARRAS DE IPTU INVALIDO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

752 POSICAO 1 DO CODIGO DE BARRA


DIFERENTE DE 8

753 SEGMENTO DO CODIGO DE BARRA


INVALIDO

754 MOEDA DO CODIGO DE BARRA INVALIDO

755 VALOR EM UFIR DO CODIGO DE BARRA


INVALIDO

756 EMPRESA/ORGAO NAO AUTORIZ. A


RECEBER NO AUTO-ATEND

757 DATA DE VENCIMENTO DO CODIGO DE


BARRA INVALIDA

758 DOCUMENTO VENCIDO

759 DOCUMENTO VENCIDO - PAGUE


PARCELADO

760 BANCO NAO AUTORIZADO A RECEBER


APOS VENCIMENTO

761 TRIBUTO NAO AUTORIZADO A RECEBER

762 PMSP-IDENTIFICACAO DE VIAS INVALIDA

763 PMSP-CONTRIBUINTE INVALIDO

764 PMSP-UNIDADE DO EXERCICIO INVALIDO

765 PMSP-ALGORITMO INVALIDO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

766 PMSP-NR INVALIDO

767 PMSP-NUMERO DE PRESTACOES INVALIDO

768 PMSP-QUANTIDADE DE PRESTACOES


INVALIDO

769 PMSP-DECADA DO EXERCICIO INVALIDA

770 PMSP-MOEDA INCOMPATIVEL


C/ EXERC.DO COD DE BARRA

771 PMSP-DAC DO CAMPO 02 INVALIDO

772 PMSP-DATA DE VENCIMENTO CALCULADA


INVALIDA

773 PMSP-EXERCICIO DO IPTU ANTERIOR A


1995

774 RECEBIMENTO NAO DISPONIVEL

775 VALOR DE PAGAMENTO INFORMADO


INVALIDO

776 DATA DE VENCIMENTO INFORMADA


INVALIDA

777 BANCO DO DEMONSTRATIVO INVALIDO

778 NUMERO DO LOTE DO DEMONSTRATIVO


INVALIDO

779 TIPO DE REGISTRO INVALIDO PARA


DEMONSTRATIVO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

780 Nº SEQUENCIAL DO REGISTRO NO LOTE


INVALIDO

781 VALOR DO DOCUMENTO INVALIDO

782 VALOR DO PIS INVALIDO

783 VALOR DO IR INVALIDO

784 VALOR DO ISS INVALIDO

785 VALOR DO COFINS INVALIDO

786 VALOR DO DESCONTO INVALIDO

787 VALOR DO ABATIMENTO INVALIDO

788 VALOR DE OUTRAS DEDUCOES INVALIDO

789 VALOR DA MORA INVALIDO

790 VALOR DA MULTA INVALIDO

791 VALOR DE OUTROS ACRESCIMOS


INVALIDO

792 PRODUTO DEMPAG NAO CONTRATADO

793 SOMA DAS FATURAS DIFERE DO


PAGAMENTO

794 DATA DE VENCIMENTO DA FATURA


INVALIDA

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

795 E-MAIL DO FAVORECIDO INVALIDO

796 FINALIDADE DO HOLERITE INVALIDA

797 MES DA COMPETENCIA DO HOLERITE


INVALIDA

798 DIA DA COMPETENCIA DO HOLERITE


INVALIDA

799 CENTRO DE CUSTO INVALIDO

800 NUMERO DA FUNCIONAL INVALIDO

801 DATA INICIO DE FERIAS NAO NUMERICA

802 DATA INICIO DE FERIAS INCONSISTENTE

803 DATA FIM DE FERIAS NAO NUMERICA

804 DATA FIM DE FERIAS INCONSISTENTE

805 NUMERO DE DEPENDENTES IR INVALIDO

806 NUM. DE DEP. SALARIO FAMILIA


INVALIDO

807 NUMERO DE HORAS SEMANAIS INVALIDO

808 SALARIO DE CONTRIBUICAO INSS


INVALIDO

809 SALARIO DE CONTRIBUICAO FGTS


INVALIDO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

810 VALOR TOTAL DOS PROVENTOS INVALIDO

811 VALOR TOTAL DOS DESCONTOS INVALIDO

812 VALOR LIQUIDO NAO NUMERICO

813 VALOR LIQ.INFORMADO DIFERENTE DO


CALCULADO

814 TIPO DE MOVIMENTO HOLERITE


INVALIDO

815 VALOR 01 DO HOLERITE INVALIDO

816 VALOR 02 DO HOLERITE INVALIDO

817 VALOR 03 DO HOLERITE INVALIDO

818 VALOR 04 DO HOLERITE INVALIDO

819 VALOR DO SALARIO-BASE INVALIDO

820 VALOR DA CSLL INVALIDA

821 BASE DE CALCULO IRRF INVALIDA

822 BASE DE CALCULO FGTS INVALIDA

823 FORMA DE PAGAMENTO INCOMPATIVEL


C/ HOLERITE

824 DIVIDA ATIVA OU NUMERO DE ETIQUETA


INVALIDA

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

825 VALOR DO TRIBUTO INVALIDO

826 VALOR DE HONORARIOS INVALIDO

827 IDENTIFICACAO DO TRIBUTO INVALIDO

828 EXERCICIO (ANO BASE)

829 CODIGO RENAVAM NAO


ENCONTRADO/INVALIDO

830 UF INVALIDO

831 CODIGO DO MUNICIPIO INVALIDO

832 PLACA INVALIDA

833 OPCAO/PARCELA DE PAGAMENTO


INVALIDA

834 TRIBUTO JA FOI PAGO OU ESTA VENCIDO

835 CODIGO DO PRODUTO INVALIDO

836 VALOR DO CODIGO BARRA INVALIDO

837 DATA DE VALIDADE INVALIDA

838 TIPO ARRECADADOR INVALIDO - CODIGO


DE BARRAS

839 CNPJ/CPF INVALIDO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

840 CAMPO IDENTIFICADOR IGUAL AO CNPJ

841 PRIMEIRO DAC DO CAMPO


IDENTIFICADOR INVALIDO

842 SEGUNDO DAC DO CAMPO IDENTIFICADOR


INVALIDO

843 COMPETENCIA DO LACRE INVALIDA

844 IDENTIFICADOR DO LACRE INVALIDO

845 VALOR DO LACRE INVALIDO

846 PRIMEIRO DAC DO CAMPO LACRE


INVALIDO

847 SEGUNDO DAC DO CAMPO LACRE


INVALIDO

850 PAGAMENTO EM DUPLICIDADE

851 FORMA INCOMPATIVEL COM A


TITULARIDADE DO PAGAMENTO

852 AGENCIA DO FAVORECIDO INVALIDA

853 VALOR INFORMADO DIFERENTE DO


VALOR DO TRIBUTO

854 FORMA INCOMPATIVEL COM O LAYOUT


010

855 NUMERO DA NOTA FISCAL INVALIDO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

856 IDENTIFICADOR DE NF/CNPJ INVALIDO

857 FORMA 32 INVALIDA

858 REG VARREDURA NAO LOCALIZADO

859 CONTA REJEITADA PELO DE X PARA DE


CTASAL

860 TRANSACAO REJEITADA, CONTATE A


CENTRAL DE ATENDIME

861 CONTA SALARIO DIVERGENTE DO


PAGADOR

862 CARTAO SALARIO NO CADASTRO DE


EXCECAO

874 CONTA DO FAVORECIDO INDISPONÍVEL


PARA USO

881 CN - CONTA NAO CADASTRADA

882 AN - C/C DO FAVORECIDO INVALIDA

883 RJ - REGISTRO REJEITADO

884 CONTA DO FAVORECIDO ENCERRADA

885 AGENCIA OU CONTA DO FAVORECIDO


INCORRETA

886 CPF/CNPJ DO FAVORECIDO INCORRETO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

887 VALOR ABAIXO DO PERMITIDO P/


FINALIDADE

888 IDENTIFICACAO DO DEP. JUDICIAL


INCORRETO

889 CPF/CNPJ OU AG/CONTA DO FAVORECIDO


INCORRETO

890 SALDO INSUFICIENTE PARA ESSA


TRANSAÇÃO

891 ESSA TRANSAÇÃO ULTRAPASSOU O LIMITE


DE PAGAMENTOS

892 CPF/CNPJ DO FAV. INAPTO JUNTO A


RECEITA

894 PAGAMENTO NÃO AUTORIZADO PELO


REPRESENTANTE DA EMP

895 PAGAMENTO EXCLUÍDO PELO


REPRESENTANTE DA EMPRESA

900 OPERADOR SEM ALCADA

901 Tipo de conta indevida

902 Agencia do pagador invalida

903 Conta do pagador invalida

904 Id Banco invalido

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

905 CNPJ PAGADOR NÃO CADASTRADO NO


SISPAG

906 Identificação do QR CODE inválido

907 Erro ao validar QR CODE

908 Valores divergentes do QR CODE

909 Documento pagador invalido

910 Documento favorecido invalido

911 Limite diario de pagamento excedido

912 Erro ao validar limite diario de pagamento

913 QR Code Expirado

915 Pagamento em duplicidade

921 Erro no processamento de alcada

988 INF-RESERVADO (SSTI 144794 -


VALIDADOR DE ARQUIVOS

989 INFORMACAO-VALOR

990 INFORMACAO-DATA

991 INFORMACAO-NOME-FAVORECIDO

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

992 USUARIO RECEPCIONADO SEM


UTILIZACAO DE TOKEN

993 USUARIO RECEPCIONADO DIFERENTE DO


CADASTRADO

994 SEGURANCA DE INTERCAMBIO - MSG1

996 NOME DA EMPRESA

997 AGENCIA , CONTA E DAC

998 TIPO E CNPJ

999 VALOR TOTAL DO LOTE

A01 LDP - LIMITE DIARIO DE PAGAMENTO


EXCEDEU EM: vvv

A02 LDP - EXCEDEU TAMBEM EM OUTROS


DIAS.CONTATE SEU GE

B03 Transação abortada por exceder o tempo limite.

B04 Transação abortada por erro inesperado.

C02 Número da conta do debitado inválida.

C03 Número da conta do creditado inválida.

C05 Conta do débito encerrada.

C06 Conta do debitado ou créditado está bloqueada.

Corporativo | Interno
COD_MOTI_RCUS_PGTO_SSPG NOM_MOTI_RCUS_PGTO_SSPG

C07 Conta do crédito encerrada.

C08 Agência Inválida.

C13 Tipo da conta de débito inválido

C14 Tipo da conta de crédito inválido

D05 Erro genérico no processamento da transação

D06 SPI está indisponivel

G02 Código ISPB inválido

G03 Transação não suportada ou não autorizada.

G07 Transação não suportada ou não autorizada.

M01 Transação fora da grade de horário acordada

M03 Código moeda inválida

M04 Saldo insuficiente

M12 Valor da transação inválido.

M21 Valor limite para a transação foi excedido.

T01 Data da transação inválida

U03 Transação já processada.

Corporativo | Interno

Você também pode gostar