Retornos das requisições
Abaixo estão os diversos formatos de retorno possíveis das diversas requisições acima.
Lista de Transações
O JSON retornado terá o seguinte formato:
{
"transacoes": [
{
"codSit": 181,
"dataTrn": "20130926",
"nsusitef": "260005",
"codLojaSiTef": "01024750",
"codLojaTronco": "12345678",
"horaTrn": "151808",
"valor": "12098",
"tipo": "TEF",
"codResp": "00",
"estado": "PENDENTE",
"codAutorizacao": "162253",
"cupomFiscal": "1234",
"produto": "Mastercard",
"infoTransacao": "Credito a Vista",
"documento": "123456******7890",
"numParcelas": "1",
"numPdv": "MS000000",
"nsuHost": "000000000000",
"nsuHostOriginal": null,
"modoEntrada": "chip",
"codEstabelecimento": "000000000000005",
"cnpj": "00000000000000",
"descrRede": "GetNetLac",
"codigoCliente": "458",
"nsuHostAux": null,
"docCancel": null,
"quem_negou": null,
"data_fiscal": "20130926",
"hora_fiscal": "151000",
"id_cliente": " 0077060038 ",
"cod_operadora": null,
"cod_filial": null,
"valor_repasse": null,
"valor_avista": null,
"valor_cartao": null,
"cod_rede_autoriz": null,
"data_exportacao": " 20130926151810 ",
"cod_autorizacao_aux": null,
"forma_pagamento_cd": null,
"subtipo_pagamento_cd": null,
"bandeira_pagamento_cd": null,
"psp": null,
"tid": null,
"forma_pagamento_1":null,
"valor_pagamento_1":null,
"forma_pagamento_2":null,
"valor_pagamento_2":null,
"forma_pagamento_3":null,
"valor_pagamento_3":null,
"forma_pagamento_4":null,
"valor_pagamento_4":null,
"nome_adquirente": "Bin",
"nome_produto": null,
"modalidade_captura": null,
"fonte_pagadora": null
}
],
"status": "OK"
}
| Campo | Descrição | Tipo | Formato |
|---|---|---|---|
| transacoes | Lista de Transações encontradas | Lista | - |
| status | Status da Requisição: <br /> OK (Transação encontrada) <br /> Nenhum registro encontrado | Texto | - |
| codsit | Código de Rede do SiTef (vide Tabela de códigos de rede) | Numérico | - |
| datatrn | Data da transação | Numérico | AAAAMMDD |
| nsusitef | NSU SiTef da transação | Numérico | - |
| codlojasitef | Código de loja SiTef | Alfanumérico | - |
| codlojatronco | Código de loja sub-adquirente | Alfanumérico | - |
| horatrn | Hora da Transação | Numérico | HHMMSS |
| valor | Valor da transação | Numérico | - |
| tipo | Tipo da Transação (vide Tabela de Tipo) | Alfanumérico | - |
| codResp | Código de Resposta | Numérico | - |
| estado | Estado da Transação (vide Tabela de Estados da Transação) | Alfanumérico | - |
| codAutorizacao | Código de Autorização | Alfanumérico | - |
| cupomFiscal | Cupom Fiscal | Texto | - |
| produto | Produto associado à transação | Texto | - |
| infoTransacao | Tipo de transação (vide Tabela de Transações) | Texto | - |
| documento | Numero cartão / Código de Barras / Celular / EAN | Texto | - |
| numParcelas | Numero de parcelas da transação | Numérico | - |
| numPdv | Identificação do terminal PDV | Alfanumérico | - |
| nsuHost | NSU Host | Alfanumérico | - |
| nsuHostOriginal | NSU Host Original | Alfanumérico | - |
| modoEntrada | Descrição do modo de entrada utilizado na transação (vide Tabela de Descrição de modos de entradas) | Texto | - |
| codEstabelecimento | Código do estabelecimento | Alfanumérico | - |
| cnpj | CNPJ da loja SiTef da transação | Numérico | - |
| descRede | Descrição da Rede do SiTef (vide Tabela de códigos de rede) | Alfanumérico | - |
| codigoCliente | Código do cliente na plataforma GW/Express (em caso de SiTefWeb, valor fixo null) | Numérico | - |
| nsuHostAux | NSU Host aux. Pode vir null ou com o nsu da Autorizadora, no caso de autorizações pelo FEPAS (SE) | Alfanumérico | - |
| docCancel | Doc. Cancelado | Alfanumérico | - |
| quem_negou | Indicação de quem negou a transação (vide Tabela de “Quem Negou” a transação) | Alfanumérico | * |
| data_fiscal | Data fiscal da transação (enviado pela automação de frente de caixa) | Numérico | AAAAMMDD |
| hora_fiscal | Hora fiscal da transação (enviado pela automação de frente de caixa) | Numérico | HHMMSS |
| id_cliente | Identificação do cliente (enviado pela automação de frente de caixa) | Alfanumérico | - |
| cod_operadora | Identificação da concessionária de telefonia (vide Tabela de Operadoras) | Numérico | ** |
| cod_filial | Identificação da unidade filial da concessionária (vide Tabela de Filiais) | Numérico | ** |
| valor_repasse | Valor repassado Numérico | *** | |
| valor_avista | Valor recebido em dinheiro Numérico | *** | |
| valor_cartao | Valor recebido em TEF Numérico | ** | |
| cod_rede_autoriz | Código da rede autorizadora (este campo está presente somente para as transações do módulo CardSE) (vide Tabela de redes Autorizadoras) | Numérico | - |
| data_exportacao | Data e hora em que foi executada a exportação ou reexportação | Numérico | AAAAMMDD <br /> HHMMSS |
| cod_autorizacao_aux | Código de autorização auxiliar (Este campo está presente somente para as transações do módulo Vero (antigo Banrisul)) | Numérico | - |
| forma_pagamento_cd | Forma de pagamento utilizada na Carteira Digital. Pode vir null ou com o código informado pelo FEPAS (SE) | Alfanumérico | 01 = Credito <br /> 02 = Debito <br /> 04 = Pre-Pago <br /> 05 = Frota |
| subtipo_pagamento_cd | Código do pagamento utilizado na Carteira Digital. Pode vir null ou com o codigo informado pelo FEPAS (SE) | Alfanumerico | 01 = Alimentacao <br /> 02 = Refeicao <br /> 03 = Cultura <br /> 04 = Premium <br /> 05 = Beneficio <br /> 06 = Farmacia <br /> 07 = Multiplos <br /> 19 = Outros <br /> 20 = Saldo <br /> 30 = Pix <br /> |
| bandeira_pagamento_cd | Código da bandeira utilizada na Carteira Digital. Pode vir null ou com o codigo informado pelo FEPAS (SE) | Numérico | - |
| psp | Código do PSP. Pode vir null ou com o código do PSP informado pelo FEPAS (SE) | Alfanumérico | - |
| tid | Transaction ID - Número de identificação da transação | Alfanumérico | - |
| nome_adquirente | Nome da Adquirente | Alfanumérico | - |
| nome_produto | Nome da Produto | Alfanumérico | - |
| modalidade_captura | Modalidade de captura | Alfanumérico | - |
| fonte_pagadora | Fonte Pagadora | Alfanumérico | - |
* No caso de transações de estado diferente de “negada”, ignorar valor do campo.
** Estes campos são preenchidos somente para as transações de recarga celular.
*** Estes campos são preenchidos somente para as transações de PBM.
Lista de Transações de Estornos e Estornadas
{
"transacoes": [
{
"estorno": {
"codSit": 181,
"dataTrn": "20130926",
"nsusitef": "260005",
"codLojaSiTef": "01024750",
"codLojaTronco": "12345678",
"horaTrn": "151808",
"valor": "12098",
"tipo": "TEF",
"codResp": "00",
"estado": "CONFIRMADA_PDV",
"codAutorizacao": "162253",
"cupomFiscal": "1234",
"produto": "Mastercard",
"infoTransacao": "Credito a Vista",
"documento": "123456******7890",
"numParcelas": "1",
"numPdv": "MS000000",
"NSUHost": "000000000000",
"modoEntrada": "chip",
"codEstabelecimento": "000000000000005",
"cnpj": "00000000000000",
"descrRede": "GetNetLac",
"codigoCliente": " 458 ",
"quem_negou": null,
"data_fiscal": "20130926",
"hora_fiscal": "151000",
"id_cliente": null,
"cod_operadora": null,
"cod_filial": null,
"valor_repasse": null,
"valor_avista": null,
"valor_cartao": null,
"cod_rede_autoriz": null,
"data_exportacao": "20130926151810",
"cod_autorizacao_aux": null,
"nsuHostaux": null,
"forma_pagto_cd": null,
"subtipo_pagto_cd": null,
"band_pagto_cd": null,
"psp": null,
"forma_pagamento_1":null,
"valor_pagamento_1":null,
"forma_pagamento_2":null,
"valor_pagamento_2":null,
"forma_pagamento_3":null,
"valor_pagamento_3":null,
"forma_pagamento_4":null,
"valor_pagamento_4":null
},
"estornada": {
"codSit": 181,
"dataTrn": "20130926",
"nsusitef": "260005",
"codLojaSiTef": "01024750",
"codLojaTronco": "12345678",
"horaTrn": "151808",
"valor": "12098",
"tipo": "TEF",
"codResp": "00",
"estado": "ESTORNADA",
"codAutorizacao": "162253",
"cupomFiscal": "1234",
"produto": "Mastercard",
"infoTransacao": "Credito a Vista",
"documento": "123456******7890",
"numParcelas": "1",
"numPdv": "MS000000",
"NSUHost": "000000000000",
"modoEntrada": "chip",
"codEstabelecimento": "000000000000005",
"cnpj": "00000000000000",
"descrRede": "GetNetLac",
"codigoCliente": " 458 ",
"quem_negou": null,
"data_fiscal": "20130926",
"hora_fiscal": "151100",
"id_cliente": null,
"cod_operadora": null,
"cod_filial": null,
"valor_repasse": null,
"valor_avista": null,
"valor_cartao": null,
"cod_rede_autoriz": null,
"data_exportacao": " 20130926151810 ",
"cod_autorizacao_aux": null,
"nsuHostaux": null,
"forma_pagto_cd": null,
"subtipo_pagto_cd": null,
"band_pagto_cd": null,
"psp": null,
"forma_pagamento_1":null,
"valor_pagamento_1":null,
"forma_pagamento_2":null,
"valor_pagamento_2":null,
"forma_pagamento_3":null,
"valor_pagamento_3":null,
"forma_pagamento_4":null,
"valor_pagamento_4":null
}
}
],
"status": "OK"
}
| Campo | Descrição | Tipo | Formato |
|---|---|---|---|
| transacoes | Lista de Transações encontradas | Lista | - |
| estorno | Informações sobre a transação de estorno | - | - |
| estornada | Informações sobre a transação estornada | - | - |
| status | Status da Requisição: <br /> OK (Transação encontrada) <br /> Nenhum registro encontrado | Texto | - |
| codsit | Código de Rede do SiTef (vide Tabela de códigos de rede) | Numérico | - |
| datatrn | Data da transação | Numérico | AAAAMMDD |
| nsusitef | NSU SiTef da transação | Numérico | - |
| codlojasitef | Código de loja SiTef | Alfanumérico | - |
| codlojatronco | Código de loja sub-adquirente | Alfanumérico | - |
| horatrn | Hora da Transação | Numérico | HHMMSS |
| valor | Valor da transação | Numérico | - |
| tipo | Tipo da Transação (vide Tabela de Tipo) | Alfanumérico | - |
| codResp | Código de Resposta | Numérico | - |
| estado | Estado da Transação (vide Tabela de Estados da Transação) | Alfanumérico | - |
| codAutorizacao | Código de Autorização | Alfanumérico | - |
| cupomFiscal | Cupom Fiscal | Texto | - |
| produto | Produto associado à transação | Texto | - |
| infoTransacao | Tipo de transação (vide Tabela de Transações) | Texto | - |
| documento | Numero cartão / Código de Barras / Celular / EAN | Texto | - |
| numParcelas | Numero de parcelas da transação | Numérico | - |
| numPdv | Identificação do terminal PDV | Alfanumérico | - |
| nsuHost | NSU | Host | Alfanumérico |
| modoEntrada | Descrição do modo de entrada utilizado na transação (vide Tabela de Descrição de modos de entradas) | Texto | - |
| codEstabelecimento | Código do estabelecimento | Alfanumérico | - |
| cnpj | CNPJ da loja SiTef da transação | Numérico | - |
| descRede | Descrição da Rede do SiTef (vide Tabela de códigos de rede) | Alfanumérico | - |
| codigoCliente | Código do cliente na plataforma GW/Express (em caso de SiTefWeb, valor fixo null) | Numérico | - |
| quem_negou | Indicação de quem negou a transação (vide Tabela de “Quem Negou” a transação) | Alfanumérico | * |
| data_fiscal | Data fiscal da transação (enviado pela automação de frente de caixa) | Numérico | AAAAMMDD |
| hora_fiscal | Hora fiscal da transação (enviado pela automação de frente de caixa) | Numérico | HHMMSS |
| id_cliente | Identificação do cliente (enviado pela automação de frente de caixa) | Alfanumérico | - |
| cod_operadora | Identificação da concessionária de telefonia (vide Tabela de Operadoras) | Numérico | ** |
| cod_filial | Identificação da unidade filial da concessionária (vide Tabela de Filiais) | Numérico | ** |
| valor_repasse | Valor repassado Numérico | *** | |
| valor_avista | Valor recebido em dinheiro Numérico | *** | |
| valor_cartao | Valor recebido em TEF Numérico | ** | |
| cod_rede_autoriz | Código da rede autorizadora (este campo está presente somente para as transações do módulo CardSE) (vide Tabela de redes Autorizadoras) | Numérico | - |
| data_exportacao | Data e hora em que foi executada a exportação ou reexportação | Numérico | AAAAMMDD <br /> HHMMSS |
| cod_autorizacao_aux | Código de autorização auxiliar (Este campo está presente somente para as transações do módulo Vero (antigo Banrisul)) | Numérico | - |
| nsuHostaux | NSU Host aux. Pode vir null ou com o nsu da Autorizadora, no caso de autorizações pelo FEPAS (SE) | Alfanumérico | - |
| forma_pagto_cd | Forma de pagamento utilizada na Carteira Digital. Pode vir null ou com o código informado pelo FEPAS (SE) | Alfanumérico | 01 = Credito <br /> 02 = Debito <br /> 04 = Pre-Pago <br /> 05 = Frota |
| subtipo_pagto_cd_estorno | Código do pagamento utilizado na Carteira Digital. Pode vir null ou com o codigo informado pelo FEPAS (SE) | Alfanumerico | 01 = Alimentacao <br /> 02 = Refeicao <br /> 03 = Cultura <br /> 04 = Premium <br /> 05 = Beneficio <br /> 06 = Farmacia <br /> 07 = Multiplos <br /> 19 = Outros <br /> 20 = Saldo <br /> 30 = Pix <br /> |
| band_pagto_cd | Código da bandeira utilizada na Carteira Digital. Pode vir null ou com o codigo informado pelo FEPAS (SE) | Numérico | - |
| psp | Código do PSP. Pode vir null ou com o código do PSP informado pelo FEPAS (SE) | Alfanumérico | - |
* No caso de transações de estado diferente de “negada”, ignorar valor do campo.
** Estes campos são preenchidos somente para as transações de recarga celular.
*** Estes campos são preenchidos somente para as transações de PBM.
Lista paginada de Transações
O JSON retornado terá o seguinte formato:
{
"totalElements": 3,
"totalPages": 3,
"number": 0,
"hash": "20250804171719202403214010363000000235959",
"status": "Executado com sucesso",
"size": 1,
"content": [
{
"codSit": 181,
"dataTrn": "20130926",
"nsusitef": "260005",
"codLojaSiTef": "01024750",
"codLojaTronco": "12345678",
"horaTrn": "151808",
"valor": "12098",
"tipo": "TEF",
"codResp": "00",
"estado": "PENDENTE",
"codAutorizacao": "162253",
"cupomFiscal": "1234",
"produto": "Mastercard",
"infoTransacao": "Credito a Vista",
"documento": "123456******7890",
"numParcelas": "1",
"numPdv": "MS000000",
"nsuHost": "000000000000",
"nsuHostOriginal": null,
"modoEntrada": "chip",
"codEstabelecimento": "000000000000005",
"cnpj": "00000000000000",
"descrRede": "GetNetLac",
"codigoCliente": "458",
"nsuHostAux": null,
"docCancel": null,
"quem_negou": null,
"data_fiscal": "20130926",
"hora_fiscal": "151000",
"id_cliente": " 0077060038 ",
"cod_operadora": null,
"cod_filial": null,
"valor_repasse": null,
"valor_avista": null,
"valor_cartao": null,
"cod_rede_autoriz": null,
"data_exportacao": " 20130926151810 ",
"cod_autorizacao_aux": null,
"forma_pagamento_cd": null,
"subtipo_pagamento_cd": null,
"bandeira_pagamento_cd": null,
"psp": null,
"tid": null,
"forma_pagamento_1":null,
"valor_pagamento_1":null,
"forma_pagamento_2":null,
"valor_pagamento_2":null,
"forma_pagamento_3":null,
"valor_pagamento_3":null,
"forma_pagamento_4":null,
"valor_pagamento_4":null,
"nome_adquirente": "Bin",
"nome_produto": null,
"modalidade_captura": null,
"fonte_pagadora": null
}
],
"status": "OK"
}
| Campo | Descrição | Tipo | Formato |
|---|---|---|---|
| totalElements | Quantidade total de registros no sistema | Numérico | - |
| totalPages | Quantidade total de páginas (neste exemplo 3 páginas: 0, 1 e 2) | Numérico | - |
| number | Número da página atual | Numérico | - |
| hash | Hash para ser utilizado na busca das páginas seguintes | Texto | - |
| status | Status da execução | Numérico | - |
| size | Quantidade de registros na página atual (na lista do atributo ‘content’) | Numérico | - |
| content | Lista de Transações encontradas <br/> | Lista | - |
| status | Status da Requisição: <br /> OK (Transação encontrada) <br /> Nenhum registro encontrado | Texto | - |
| codsit | Código de Rede do SiTef (vide Tabela de códigos de rede) | Numérico | - |
| datatrn | Data da transação | Numérico | AAAAMMDD |
| nsusitef | NSU SiTef da transação | Numérico | - |
| nsuHostOriginal | NSU Host Original | Alfanumérico | - |
| codlojasitef | Código de loja SiTef | Alfanumérico | - |
| codlojatronco | Código de loja sub-adquirente | Alfanumérico | - |
| horatrn | Hora da Transação | Numérico | HHMMSS |
| valor | Valor da transação | Numérico | - |
| tipo | Tipo da Transação (vide Tabela de Tipo) | Alfanumérico | - |
| codResp | Código de Resposta | Numérico | - |
| estado | Estado da Transação (vide Tabela de Estados da Transação) | Alfanumérico | - |
| codAutorizacao | Código de Autorização | Alfanumérico | - |
| cupomFiscal | Cupom Fiscal | Texto | - |
| produto | Produto associado à transação | Texto | - |
| infoTransacao | Tipo de transação (vide Tabela de Transações) | Texto | - |
| documento | Numero cartão / Código de Barras / Celular / EAN | Texto | - |
| numParcelas | Numero de parcelas da transação | Numérico | - |
| numPdv | Identificação do terminal PDV | Alfanumérico | - |
| nsuHost | NSU Host | Alfanumérico | - |
| modoEntrada | Descrição do modo de entrada utilizado na transação (vide Tabela de Descrição de modos de entradas) | Texto | - |
| codEstabelecimento | Código do estabelecimento | Alfanumérico | - |
| cnpj | CNPJ da loja SiTef da transação | Numérico | - |
| descRede | Descrição da Rede do SiTef (vide Tabela de códigos de rede) | Alfanumérico | - |
| codigoCliente | Código do cliente na plataforma GW/Express (em caso de SiTefWeb, valor fixo null) | Numérico | - |
| nsuHostAux | NSU Host aux. Pode vir null ou com o nsu da Autorizadora, no caso de autorizações pelo FEPAS (SE) | Alfanumérico | - |
| docCancel | Doc. Cancelado | Alfanumérico | - |
| quem_negou | Indicação de quem negou a transação (vide Tabela de “Quem Negou” a transação) | Alfanumérico | * |
| data_fiscal | Data fiscal da transação (enviado pela automação de frente de caixa) | Numérico | AAAAMMDD |
| hora_fiscal | Hora fiscal da transação (enviado pela automação de frente de caixa) | Numérico | HHMMSS |
| id_cliente | Identificação do cliente (enviado pela automação de frente de caixa) | Alfanumérico | - |
| cod_operadora | Identificação da concessionária de telefonia (vide Tabela de Operadoras) | Numérico | ** |
| cod_filial | Identificação da unidade filial da concessionária (vide Tabela de Filiais) | Numérico | ** |
| valor_repasse | Valor repassado Numérico | *** | |
| valor_avista | Valor recebido em dinheiro Numérico | *** | |
| valor_cartao | Valor recebido em TEF Numérico | ** | |
| cod_rede_autoriz | Código da rede autorizadora (este campo está presente somente para as transações do módulo CardSE) (vide Tabela de redes Autorizadoras) | Numérico | - |
| data_exportacao | Data e hora em que foi executada a exportação ou reexportação | Numérico | AAAAMMDD <br /> HHMMSS |
| cod_autorizacao_aux | Código de autorização auxiliar (Este campo está presente somente para as transações do módulo Vero (antigo Banrisul)) | Numérico | - |
| forma_pagamento_cd | Forma de pagamento utilizada na Carteira Digital. Pode vir null ou com o código informado pelo FEPAS (SE) | Alfanumérico | 01 = Credito <br /> 02 = Debito <br /> 04 = Pre-Pago <br /> 05 = Frota |
| subtipo_pagamento_cd | Código do pagamento utilizado na Carteira Digital. Pode vir null ou com o codigo informado pelo FEPAS (SE) | Alfanumerico | 01 = Alimentacao <br /> 02 = Refeicao <br /> 03 = Cultura <br /> 04 = Premium <br /> 05 = Beneficio <br /> 06 = Farmacia <br /> 07 = Multiplos <br /> 19 = Outros <br /> 20 = Saldo <br /> 30 = Pix <br /> |
| bandeira_pagamento_cd | Código da bandeira utilizada na Carteira Digital. Pode vir null ou com o codigo informado pelo FEPAS (SE) | Numérico | - |
| psp | Código do PSP. Pode vir null ou com o código do PSP informado pelo FEPAS (SE) | Alfanumérico | - |
| tid | Transaction ID - Número de identificação da transação | Alfanumérico | - |
| nome_adquirente | Nome da Adquirente | Alfanumérico | - |
| nome_produto | Nome da Produto | Alfanumérico | - |
| modalidade_captura | Modalidade de captura | Alfanumérico | - |
| fonte_pagadora | Fonte Pagadora | Alfanumérico | - |
* No caso de transações de estado diferente de “negada”, ignorar valor do campo.
** Estes campos são preenchidos somente para as transações de recarga celular.
*** Estes campos são preenchidos somente para as transações de PBM.