Serviço de Consulta de Pré-Autorização

Em caso de falha na comunicação ou demora excessiva na resposta (timeout) em qualquer uma das operações subsequentes ao beginTransaction, a loja obrigatoriamente deverá consumir a operação getStatus. Esta operação permite que se verifique o status de uma requisição a qual o lojista não obteve a resposta, recuperando os parâmetros que não pôde receber no fluxo normal.

A loja deverá recuperar o status da transação (com o prazo máximo para a consulta de 15 dias) desde que possua o nit, através do webservice getStatus, passando como parâmetro a chave de autenticação da loja (merchantKey) e o nit.

Desenvolvimento/Certificação: caso não tenha recebido o merchantKey para desenvolvimento/certificação, favor solicitar através do e-mail autorizadores5317@softwareexpress.com.br ou pelo telefone (11) 3170-5317.

Produção: o merchantKey para Produção será enviado pela equipe do e-SiTef de Produção, caso não tenha recebido depois dos devidos procedimentos para a entrada em Produção, favor solicitar ao e-mail esitef.prod6773@softwareexpress.com.br.

Note que em casos excepcionais a chave de autenticação (merchantKey) pode ser alterada por questões de segurança, porém a equipe de produção irá entrar em contato com a loja antes da alteração.

Lembrando que diversos fatores podem ocasionar a demora na resposta, incluindo instabilidade de internet e o host da rede autorizadora do cartão. Recomendamos que o servidor da loja tenha configurado o timeout igual ou superior a 90 segundos.

Nota: Este serviço só irá devolver os dados se a transação tiver sido efetuada via Web Services, não irá funcionar em caso de transações via Interface HTML.

Atenção: A consulta de transação no e-SiTef NÃO efetua uma consulta do status da transação no adquirente / autorizador. Este serviço retorna o status da transação na base de dados do e-SiTef.
Exemplo: Caso uma transação de pré-autorização seja confirmada no e-SiTef, mas seja estornada via telefone diretamente no adquirente / autorizador, este estorno não será necessariamente refletido no serviço de consulta de transação do e-SiTef.

Detalhes da chamada

Recurso: /v1/transactions/{nit}
Método HTTP: GET
Formato da requisição: JSON
Formato da resposta: JSON
Parâmetros de cabeçalho:

Nome do Parâmetro	Descrição	Tamanho	Obrigatório
`Content-Type`	Valor fixo "application/json"	= 15 A	Sim
`merchant_id`	Código da loja no e-SiTef. Os códigos de produção e certificação serão diferentes
`merchant_key`	Chave de autenticação da loja no e-SiTef. As chaves de produção e certificação serão diferentes.	≤ 80 A	Sim
`nit`	Identificador da transação no e-SiTef. Obtido no retorno da chamada ao beginTransaction.	= 64 A	Sim

Parâmetros de Requisição

Na URL do recurso deve ser enviado o nit

Nome do Parâmetro	Descrição	Tamanho	Obrigatório
`nit`	Identificador da transação no e-SiTef. Obtido no retorno da chamada ao beginTransaction.	= 64 A	Sim

A chamada da operação de consulta de transações – getStatus – não necessita de corpo de requisição.

Parâmetros de Resposta

Nome do Parâmetro	Descrição	Tamanho
`code`	Código de resposta do e-SiTef. Qualquer código diferente de "0" significa falha na consulta. Para maiores informações, consulte o documento Anexo A-2 - Codigos de Resposta.	< 4 N
`message`	Mensagem de resposta do e-SiTef da consulta.	< 500 AN
`acquirer_id`	Código do adquirente/roteamento utilizado na transação.	< 4 N
`acquirer_name`	Nome do adquirente/roteamento utilizado na transação.	< 100 AN
`amount`	Valor da compra especificado pela loja (em centavos) na criação da transação.	< 12 AN
`authorization_number`	Número de autorização.	< 6 AN
`authorizer_code`	Código de resposta do autorizador.	< 10 AN
`authorizer_date`	Data de efetivação da pré-autorização retornada pelo autorizador no formato DD/MM/AAAA’T’HH:mm.
Exemplo: 13/07/2017T16:03	= 16 D
`authorizer_id`	Código da autorizadora utilizada na transação.	< 4 N
`authorizer_merchant_id`	Código de afiliação do lojista na autorizadora.	< 100 AN
`authorizer_message`	Mensagem de resposta do autorizador.	< 500 AN
`customer_receipt`	Cupom (via cliente).	< 4000 AN
`eci`	Eletronic Commerce Indicator (indicador do nível de segurança da transação do pré-autorização via Cielo e-Commerce).	< 3 AN
`esitef_usn`	Número sequencial único da transação de pré-autorização no e-SiTef.	= 6 N
`host_usn`	NSU da autorizadora.	< 15 AN
`issuer`	Código da bandeira retornado pelo autorizador.	< 5 AN
`merchant_receipt`	Cupom (via estabelecimento).	< 4000 AN
`merchant_usn`	Número sequencial único enviado pela loja na criação da transação.	< 12 AN
`nit`	Identificador da transação de pré-autorização no e-SiTef.	= 64 AN
`order_id`	Código de pedido enviado pela loja na criação da transação.	< 40 AN
`payment_type`	Tipo do pagamento da autorizadora escolhida: B = boleto, C = crédito, D = débito, P = cartão crédito Private Label puro, T = tranferência bancária, G = cartão gift, O = outros meios de pagamentos, W = Boleto NR via Web Service	= 1 A
`sitef_usn`	Número sequencial único da transação de pré-autorização no SiTef.	= 6 N
`status`	Status da transação de pré-autorização no e-SiTef.	= 3 AN
`tid`	ID da transação no adquirente/roteamento. Este campo só é retornado em transações com adquirentes externos ao SiTef.	< 40 AN
`xid`	Campo XID retornado em autenticações 3DS ou certos adquirentes/roteamentos.	< 40 AN
`acquirer_id`	Código do adquirente/roteamento utilizado na transação.	< 4 N
`acquirer_name`	Nome do adquirente/roteamento utilizado na transação.	< 100 AN
`amount`	Valor da compra especificado pela loja (em centavos) na criação da transação.	< 12 AN
`authorization_number`	Número de autorização.	< 6 AN
`authorizer_code`	Código de resposta do autorizador.	< 10 AN
`authorizer_date`	Data de efetivação do pré-autorização retornada pelo autorizador no formato DD/MM/AAAA’T’HH:mm. Exemplo: 13/07/2017T16:03	= 16 D
`authorizer_id`	Código da autorizadora utilizada na transação.	< 4 N
`authorizer_merchant_id`	Código de afiliação do lojista na autorizadora.	< 100 AN
`authorizer_message`	Mensagem de resposta do autorizador.	< 500 AN
`customer_receipt`	Cupom (via cliente).	< 4000 AN
`eci`	Eletronic Commerce Indicator (indicador do nível de segurança da transação do pré-autorização via Cielo e-Commerce).	< 3 AN
`esitef_usn`	Número sequencial único da transação de pré-autorização no e-SiTef.	= 6 N
`host_usn`	NSU da autorizadora.	< 15 AN
`issuer`	Código da bandeira retornado pelo autorizador.	< 5 AN
`merchant_receipt`	Cupom (via estabelecimento).	< 4000 AN
`merchant_usn`	Número sequencial único enviado pela loja na criação da transação.	< 12 AN
`nit`	Identificador da transação de pré-autorização no e-SiTef.	= 64 AN
`order_id`	Código de pedido enviado pela loja na criação da transação.	< 40 AN
`payment_type`	Tipo do pagamento da autorizadora escolhida: B = boleto, C = crédito, D = débito, P = cartão crédito Private Label puro, T = tranferência bancária, G = cartão gift, O = outros meios de pagamentos, W = Boleto NR via Web Service	= 1 A
`sitef_usn`	Número sequencial único da transação de pré-autorização no SiTef.	= 6 N
`status`	Status da transação de pré-autorização no e-SiTef.	= 3 AN
`tid`	ID da transação no adquirente/roteamento. Este campo só é retornado em transações com adquirentes externos ao SiTef.	< 40 AN
`xid`	Campo XID retornado em autenticações 3DS ou certos adquirentes/roteamentos.	< 40 AN

Atenção: Os campos code e message se referem ao código e mensagem referentes à requisição de consulta. Estes não se referem às transações consultadas.

Exemplo

Requisição:

curl
--request GET "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--verbose

Resposta:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "pre_authorization": {
        "acquirer_id": "1181",
        "acquirer_name": "GetNet Lac",
        "amount": "1470",
        "authorization_number": "301367",
        "authorizer_code": "000",
        "authorizer_date": "30/10/2018T11:58",
        "authorizer_id": "1",
        "authorizer_merchant_id": "000000000000000",
        "authorizer_message": "Transacao OK"
            "SDO DISPONIVEL                  244,00",
        "customer_receipt": 
            ".....S.O.F.T.W.A.R.E.E.X.P.R.E.S.S...."
            "\nSI                            Rede 181"
            "\nMU               Codigo transacao: 100"
            "\nLA             Codigo operacao: 113000"
            "\nDO                        Valor: 14,70"
            "\n.....S...I...M...U...L...A...D...O...."
            "\nSI                   NSU SiTef: 301367"
            "\nMU                      30/10/18 11:58"
            "\nLA                    ID PDV: ES000025"
            "\nDO             Estab.: 000000000000000"
            "\n.....S...I...M...U...L...A...D...O...."
            "\nSI                     Host: 010301367"
            "\nMU         Transacao Simulada Aprovada"
            "\n                               (SiTef)"
            "\n",
        "esitef_usn": "181030016873984",
        "host_usn": "010301367   ",
        "issuer": "1",
        "merchant_receipt": 
            ".....S.O.F.T.W.A.R.E.E.X.P.R.E.S.S.... " 
            "\nSI                            Rede 181"
            "\nMU               Codigo transacao: 100"
            "\nLA             Codigo operacao: 113000"
            "\nDO                        Valor: 14,70"
            "\n.....S...I...M...U...L...A...D...O...."
            "\nSI                   NSU SiTef: 301367"
            "\nMU                      30/10/18 11:58"
            "\nLA                    ID PDV: ES000025"
            "\nDO             Estab.: 000000000000000"
            "\n.....S...I...M...U...L...A...D...O...."
            "\nSI                     Host: 010301367"
            "\nMU         Transacao Simulada Aprovada"
            "\n                               (SiTef)" 
            "\n",
        "merchant_usn": "20180809",
        "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
        "order_id": "oioi",
        "payment_type": "C",
        "sitef_usn": "301367",
        "status": "CON"
    },
    "capture": {
        "acquirer_id": "1181",
        "acquirer_name": "GetNet Lac",
        "amount": "1380",
        "authorization_number": "000000",
        "authorizer_date": "30/10/2018T12:00",
        "authorizer_id": "1",
        "customer_receipt": 
            ".....S.O.F.T.W.A.R.E.E.X.P.R.E.S.S.... "
            "\nSI                            Rede 181"
            "\nMU               Codigo transacao: 220"
            "\nLA             Codigo operacao: 113002"
            "\nDO                        Valor: 13,80"
            "\n.....S...I...M...U...L...A...D...O...."
            "\nSI                   NSU SiTef: 301368"
            "\nMU                      30/10/18 12:00"
            "\nLA                    ID PDV: ES000025"
            "\nDO             Estab.: 000000000000000"
            "\n.....S...I...M...U...L...A...D...O...."
            "\nSI                     Host: 010301368"
            "\nMU         Transacao Simulada Aprovada"
            "\n                               (SiTef)"                                         
            "\n",
        "esitef_usn": "181030016874034",
        "host_usn": "010301368   ",
        "issuer": "1",
        "authorizer_code": "000",
        "authorizer_message": "Transacao OK"
            "SDO DISPONIVEL          244,00",
        "merchant_receipt": 
            ".....S.O.F.T.W.A.R.E.E.X.P.R.E.S.S...."
            "\nSI                            Rede 181"                                          
            "\nMU               Codigo transacao: 220"                                          
            "\nLA             Codigo operacao: 113002"                                          
            "\nDO                        Valor: 13,80"                                          
            "\n.....S...I...M...U...L...A...D...O...."                                          
            "\nSI                   NSU SiTef: 301368"                                          
            "\nMU                      30/10/18 12:00"                                          
            "\nLA                    ID PDV: ES000025"                                          
            "\nDO             Estab.: 000000000000000"                             
            "\n.....S...I...M...U...L...A...D...O...."                                          
            "\nSI                     Host: 010301368"               
            "\nMU         Transacao Simulada Aprovada"
            "\n                               (SiTef)"                                          
            "\n",
        "merchant_usn": "20180809",
        "nit": "abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr1234567890",
        "order_id": "201808020001",
        "authorizer_merchant_id": "000000000000000"
        "payment_type": "C",
        "sitef_usn": "301368",
        "status": "CON"
    }
}

Consulta de transações em um grupo de lojas

O e-SiTef exige que as credenciais (merchant_id e merchant_key) sejam as mesmas utilizadas na transação a ser consultada. No entanto, caso o lojista precise, o e-SiTef pode permitir consultas com credenciais de outras lojas de um mesmo grupo. Para isso, basta solicitar às nossas equipes de suporte e produção para que façam essa liberação.