Pagamento REST

Visão Geral

O e-SiTef possui duas interfaces para integração com a loja virtual, POST/HTML e Web Services (REST ou SOAP), possibilitando a maneira adequada de interação da loja com o e-SiTef, conforme a linguagem e plataforma de execução da loja virtual.

Na interface REST, a coleta dos dados do cartão e do pagamento será realizada pela Loja Virtual e o e-SiTef apenas se encarregará de efetuar o pagamento com a instituição financeira.

Nessa interface estão disponíveis os pagamentos com cartão de crédito, débito ou voucher. Para pagamentos via banco como transferência bancária, boleto, utilize a interface POST/HTML.

Comunicação

Para realizar uma transação Web Service, toda a comunicação será realizada via HTTPS/SSL. É importante que o servidor do lojista suporte criptografia com no mínimo 128 bits. O servidor da loja deverá realizar chamadas em endereços específicos para transações REST.

Cada serviço deve ser chamado utilizando a URL base concatenada do recurso desejado (veja o capítulo referente ao serviço a ser consumido). O método HTTP (GET, POST ou PUT) indica a ação esperada sobre o recurso escolhido. Abaixo estão as URLs base do e-SiTef:

URL base de Produção:

https://esitef-ec.softwareexpress.com.br/e-sitef/api

URL base de Homologação:

https://esitef-homologacao.softwareexpress.com.br/e-sitef/api

Todas as chamadas realizadas para os serviços serão respondidas de forma síncrona.

Atenção:

Nunca utilize o IP ao invés do domínio esitef-ec.softwareexpress.com.br. O IP pode mudar a qualquer momento e sem aviso prévio, portanto é importante a utilização do domínio para acesso ao e-SiTef.

Importante:

Além dos parâmetros de retorno dos serviços descritos nesta especificação o e-SiTef poderá devolver outros parâmetros sem aviso prévio.

É importante que o aplicativo esteja preparado para receber os parâmetros desconhecidos além dos parâmetros já especificados e simplesmente desprezá-los.

Fluxo

O fluxo de pagamento será iniciado pelo aplicativo da loja virtual após o cliente finalizar a compra e preencher suas informações de pagamento.

Existem dois tipos de fluxo de pagamento: com confirmação automática, onde o e-SiTef se responsabiliza por confirmar o pagamento com as Redes Adquirentes e com confirmação tardia, onde a aplicação se responsabiliza por confirmar o pagamento, consumindo o serviço de confirmação.

A confirmação tardia geralmente é utilizada quando o aplicativo da loja virtual permite o pagamento com mais de um cartão ou se realiza alguma validação antes de efetuar o pagamento.

Pagamento com confirmação automática

Descrição do fluxo:

O lojista cria uma transação no e-SiTef passando informações como código da loja, número de parcelas e código de pedido e obtém como resposta um NIT (Número Identificador de Transação).
A loja virtual prossegue então consumindo o serviço de efetivação do pagamento, passando o NIT e os dados do cartão do comprador. Em caso de sucesso, a transação de pagamento mudará seu status para CON (confirmada).

Pagamento com confirmação tardia

Descrição do fluxo:

Assim como no fluxo de pagamento com confirmação automática, o lojista cria uma transação no e-SiTef passando os dados do pagamento. Adicionalmente, ele deve enviar o parâmetro postpone_confirmation com valor true.
A loja virtual prossegue então consumindo o serviço de efetivação do pagamento, passando o NIT e os dados do cartão do comprador. Em caso de sucesso, a transação de pagamento mudará seu status para PPC (pagamento pendente de confirmação).
Concluindo, a loja virtual chama o serviço de confirmação do pagamento, passando o NIT novamente e o parâmetro confirm com valor true, resultando numa transação com status CON (confirmada). Também existe a possibilidade do lojista desfazer a transação em vez de confirmar. Para isso, o parâmetro confirm deve ser enviado com valor false, o que resultará numa transação com status PPN (desfeita).

Quick start

Este guia mostra o processo de efetivação de um pagamento à vista, utilizando a interface web service REST do e-SiTef.

O que você precisará

Cadastro ativo no ambiente de homologação do e-SiTef (obtido com nossa equipe de suporte)
Uma ferramenta capaz de realizar chamadas HTTP, como Postman, REST Client ou cURL

Criando a transação

Tipo de requisição: POST

URL: https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions

Headers:

Content-Type: application/json
merchant_id: {seu código de loja}
merchant_key: {chave da sua loja}

Requisição:

JSON

cURL

{
   "merchant_usn":"12042142155",
   "order_id":"12042142155",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1"
}

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"12042142155",
   "order_id":"12042142155",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1"
}
--verbose

Resposta:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "payment": {
        "status": "NOV",
        "nit": "<nit>",
        "order_id": "12042142155",
        "merchant_usn": "12042142155",
        "amount": "1"
    }
}

Saiba mais sobre esse serviço.

Efetuando o pagamento

Tipo de requisição: POST

URL: https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/<nit>

Preencha o campo <nit> na URL acima com o NIT obtido na resposta da fase anterior de criação da transação.

Headers:

Content-Type: application/json
merchant_id: {seu código de loja}
merchant_key: {chave da sua loja}

Requisição:

JSON

cURL

{
   "card":{
      "number":"5555555555555555",
      "expiry_date":"1222",
      "security_code":"601"
   }
}

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/<nit>"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "number":"5555555555555555",
      "expiry_date":"1222",
      "security_code":"601"
   }
}
--verbose

Resposta:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "payment": {
        "authorizer_code": "000",
        "authorizer_message": "Transacao OK",
        "status": "CON",
        "nit": "<nit>",
        "order_id": "12042142155",
        "customer_receipt": "====CUPOM COMPRADOR====",
        "merchant_receipt": "====CUPOM ESTABELECIMENTO====",
        "authorizer_id": "2",
        "acquirer_id": "1005",
        "acquirer_name": "Redecard",
        "authorizer_date": "13/04/2018T10:56",
        "authorization_number": "132324",
        "merchant_usn": "12042142155",
        "esitef_usn": "180413005038220",
        "sitef_usn": "132324",
        "host_usn": "999132324   ",
        "amount": "1",
        "payment_type": "C",
        "issuer": "2",
        "authorizer_merchant_id": "000000000000005",
        "payment_date": "13/04/2018T10:56"
    }
}

Saiba mais sobre esse serviço.

Verificando o estado do pagamento

Tipo de requisição: GET

URL: https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions/<nit>

Preencha o campo <nit> na URL acima com o NIT obtido na resposta da fase de criação da transação.

Headers:

Content-Type: application/json
merchant_id: {seu código de loja}
merchant_key: {chave da sua loja}

Requisição:

cURL

curl
--request GET "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions/<nit>"
--header "merchant_id: xxxxxxxxxxxxxxx" 
--header "merchant_key: xxxxxxxxxxx"
--verbose

Resposta:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "payment": {
        "authorizer_code": "000",
        "authorizer_message": "Transacao OK",
        "status": "CON",
        "nit": "<nit>",
        "order_id": "12042142155",
        "customer_receipt": "====CUPOM COMPRADOR====",
        "merchant_receipt": "====CUPOM ESTABELECIMENTO====",
        "authorizer_id": "2",
        "acquirer_id": "1005",
        "acquirer_name": "Redecard",
        "authorizer_date": "13/04/2018T10:56",
        "authorization_number": "132324",
        "merchant_usn": "12042142155",
        "esitef_usn": "180413005038220",
        "sitef_usn": "132324",
        "host_usn": "999132324   ",
        "amount": "1",
        "payment_type": "C",
        "issuer": "2",
        "authorizer_merchant_id": "000000000000005",
        "payment_date": "13/04/2018T10:56"
    }
}

Saiba mais sobre esse serviço.

Serviço de criação da transação

O consumo do serviço de criação de transação é obrigatório nos fluxos de pagamento e agendamento. Como resultado dessa operação, o lojista obterá um NIT (pagamento) e/ou um SID (agendamento) que serão necessários para os próximos passos do fluxo, assim como a utilização do serviço de consulta de transações.

O NIT e o SID possuem um tempo limite para sua utilização. Este prazo está configurado no e-SiTef, e caso seja excedido, a transação passará do status NOV (nova) para EXP (expirada), que impede futuras operações com essa transação, tornando necessário consumir novamente o serviço de criação de transação.

Detalhes da chamada

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

Parâmetro	Descrição	Formato	Obrigatório
`merchant_id`	Código da loja no e-SiTef. Os códigos de produção e certificação serão diferentes.	< 15 AN	SIM
`merchant_key`	Chave de autenticação da loja no e-SiTef. As chaves de produção e certificação serão diferentes.	< 80 AN	SIM
`Content-Type`	Deve ser enviado com o valor `application/json`.	= 15 AN	SIM

Exemplos

Abaixo estão alguns exemplos de chamada do serviço de criação de transações utilizando a ferramenta cURL.

Criação de pagamento com confirmação automática

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"12042142155",
   "order_id":"12042142155",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1000"
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"NOV",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"12042142155",
      "merchant_usn":"12042142155",
      "amount":"1000"
   }
}

Criação de pagamento com confirmação tardia

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"12050620649",
   "order_id":"12050620649",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1000",
   "additional_data":{
      "postpone_confirmation":"true"
   }
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"NOV",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"12050620649",
      "merchant_usn":"12050620649",
      "amount":"1000"
   }
}

Criação de pagamento com agendamento

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"12053724147",
   "order_id":"12053724147",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1000",
   "schedule":{
      "amount":"900",
      "initial_date":"03/08/2017",
      "number_of_times":"3",
      "interval":"1",
      "soft_descriptor":"Assinatura",
      "show_times_invoice":"false"
   },
   "additional_data":{
      "payer":{
         "store_identification":"98253053045"
      }
   }
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"NOV",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"12053724147",
      "merchant_usn":"12053724147",
      "amount":"1000"
   },
   "schedule":{
      "status":"NOV",
      "sid":"qwertyuiopasdfghjklzxcvbnm0123456789qwertyuiopasdfghjklzxcvbnm01",
      "amount":"900",
      "order_id":"12053724147",
      "merchant_usn":"12053724147"
   }
}

Criação de agendamento sem pagamento

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"12055523043",
   "order_id":"12055523043",
   "authorizer_id":"2",
   "schedule":{
      "amount":"900",
      "do_payment_now":"false",
      "initial_date":"03/08/2017",
      "number_of_times":"3",
      "interval":"1",
      "soft_descriptor":"Assinatura",
      "show_times_invoice":"false"
   },
   "additional_data":{
      "payer":{
         "store_identification":"98253053045"
      }
   }
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "schedule":{
      "status":"NOV",
      "sid":"qwertyuiopasdfghjklzxcvbnm0123456789qwertyuiopasdfghjklzxcvbnm01",
      "amount":"900",
      "order_id":"12055523043",
      "merchant_usn":"12055523043"
   }
}

Criação de pagamento com análise de risco Cielo e-Commerce

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"12042142155",
   "order_id":"12042142155",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1000",
   "additional_data":{
      "payer":{
         "name":"Comprador",
         "surname":"credito AF",
         "email":"compradorteste@live.com",
         "city":"Rio de Janeiro",
         "state":"RJ",
         "address_street_name":"Rua Jupiter",
         "address_street_number":"174",
         "address_zip_code":"21241140",
         "born_date":"1991-01-02T08:30:00",
         "address_street_complement":"AP 201",
         "address_country":"BRA"
      },
      "shipment":{
         "method":"LOW_COST",
         "name":"Sr Comprador Teste",
         "phones":[
            {
               "number":"21114740",
               "ddd":"16",
               "ddi":"55"
            }
         ],
         "receiver_address":{
            "complement":"AP 201",
            "city":"Rio de Janeiro",
            "state":"RJ",
            "country":"BRA",
            "zip_code":"21241140",
            "street_number":"174",
            "street_name":"Rua Jupiter"
         }
      },
      "connections":[
         {
            "from":"RAO",
            "to":"SAO",
            "flight_date":"2020-01-02T20:15:00"
         }
      ],
      "gift":"false",
      "browser":{
         "email":"compradorteste@live.com",
         "agent":"Chrome",
         "cookies_accepted":"false",
         "host_name":"Teste",
         "ip_address":"200.190.150.350"
      },
      "items":[
         {
            "title":"ItemTeste",
            "quantity":"1",
            "id":"1487337308522",
            "risk":"HIGH",
            "hedge":{
               "time":"NORMAL",
               "host":"OFF",
               "nonSensical":"OFF",
               "obscenities":"OFF",
               "phone":"OFF",
               "velocity":"HIGH"
            },
            "passenger":{
               "name":"Comprador accept",
               "email":"compradorteste@live.com",
               "rating":"ADULT",
               "phone":{
                  "number":"999994444",
                  "ddd":"11",
                  "ddi":"55"
               },
               "legal_document":"1234567890",
               "customer_class":"Gold"
            },
            "unit_price":"1000",
            "category_id":"other",
            "gift_category":"OFF"
         }
      ],
      "extra_param":{
         "acquirer_params":[
            {
               "key":"95",
               "value":"Eu defini isso"
            }
         ]
      },
      "anti_fraud":"enabled_before_auth",
      "anti_fraud_institution":"AUTHORIZER",
      "anti_fraud_criteria":"ALWAYS",
      "finger_print_id":"074c1ee676ed4998ab66491013c565e2",
      "returns_accepted":"true",
      "journey_type":"OUTWARD"
   }
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"NOV",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"12042142155",
      "merchant_usn":"12042142155",
      "amount":"1000"
   }
}

Criação de pagamento com análise de risco (utlizando o anti fraude Konduto)

Para mais informações verifique nossa seção específica da Konduto

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"2423423434",
   "order_id":"2432342343",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1300",
   "additional_data":{
      "anti_fraud":"enabled_before_auth",
      "visitor_id":"XKhas09jcks",
      "items":[
         {
            "title":"title1",
            "quantity":"1",
            "unit_price":"1111",
            "description":"description1",
            "id":"id1",
            "discount_amount":"111",
            "sku":"sku1",
            "creation_date":"11/01/2011"
         }
      ],
      "payer":{
         "name":"Marcos",
         "surname":"da Silva",
         "email":"marocs@dasilva.com",
         "born_date":"1990-01-01T11:11:11",
         "creation_date":"02/03/2004",
         "is_new_client":"true",
         "is_vip_client":"true",
         "phones":[
            {
               "number":"333333333",
               "ddd":"22",
               "ddi":"11"
            },
            {
               "number":"666666666",
               "ddd":"55",
               "ddi":"44"
            }
         ],
         "identification_number":"47764543004"
      },
      "shipment":{
         "name":"Fernando",
         "surname":"Bezerra",
         "address":{
            "zip_code":"98764312",
            "street_number":"987",
            "street_name":"Rua Shipment",
            "complement":"ap. 587",
            "city":"São Shipment",
            "state":"MA",
            "country":"BRA"
         }
      },
      "passengers":[
         {
            "name":"Miguel",
            "last_name":"Herrera",
            "frequent_flyer_card":"frequentFlyerCard",
            "legal_document_type":"1",
            "legal_document":"12312312312",
            "birth_date":"1980-07-28T10:40:00",
            "customer_class":"customerClass",
            "nationality":"BRA",
            "is_frequent_traveler":"true",
            "is_with_special_needs":"true"
         }
      ],
      "connections":[
         {
            "company":"Verde",
            "class":"first",
            "from":"GRU",
            "to":"CGH",
            "departure_date":"2023-09-07T07:09:00",
            "journey_type":"OUTWARD",
            "origin_city":"San Juan",
            "destination_city":"Homero Lopez",
            "class_code":"VIP"
         },
         {
            "company":"Rosa",
            "class":"economy",
            "from":"BSB",
            "to":"VCP",
            "departure_date":"2022-10-21T16:39:00",
            "journey_type":"RETURN",
            "origin_city":"San Pablo",
            "destination_city":"Juanito Cruz",
            "class_code":"ECONOMY"
         }
      ],
      "hotel_reservations":[
         {
            "hotel":"Hotel Green Tree",
            "address":{
               "zip_code":"83392019",
               "street_number":"529",
               "street_name":"Rua Hoteleira",
               "complement":"ap. 019",
               "city":"San Hotel",
               "state":"AC",
               "country":"EN"
            },
            "rooms":[
               {
                  "number":"902",
                  "code":"ROOM902",
                  "type":"King Size",
                  "check_in_date":"2020-01-09T12:30:00",
                  "check_out_date":"2020-01-19T13:00:00",
                  "number_of_guests":"1",
                  "board_basis":"Vegan",
                  "guests":[
                     {
                        "name":"José Aníbal",
                        "document":"98798798712",
                        "document_type":"cpf",
                        "birth_date":"12/03/1970",
                        "nationality":"BRA"
                     }
                  ]
               }
            ],
            "category":"categoryhotel"
         }
      ],
      "billing_data":{
         "address":{
            "zip_code":"12341234",
            "street_number":"666",
            "street_name":"Rua Billing",
            "complement":"ap. 2369",
            "city":"São Billing",
            "state":"AM",
            "country":"BRA"
         }
      },
      "travel":{
         "transport_type":"flight",
         "expiration_date":"2022-02-14T01:30:00"
      },
      "discount_info":"Informações de desconto",
      "events":[
         {
            "name":"Evento de Rock",
            "date":"2021-11-22T09:28:00",
            "type":"show",
            "subtype":"music",
            "venue":{
               "name":"Debicard Hall",
               "street_name":"Rua do Evento",
               "street_number":"928",
               "city":"Jardinópolis",
               "state":"MS",
               "country":"DO",
               "capacity":"300"
            },
            "tickets":[
               {
                  "id":"12h374612h4h",
                  "category":"social",
                  "section":"Seção 1",
                  "premium":"true",
                  "attendee":{
                     "name":"Daniel Almeida",
                     "document":"71728293945",
                     "document_type":"other",
                     "birth_date":"03/10/1990"
                  }
               }
            ]
         }
      ]
   }
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"NOV",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"12042142155",
      "merchant_usn":"2432342343",
      "amount":"1300"
   }
}

Parâmetros de requisição

Na tabela abaixo está a descrição dos parâmetros de requisição do serviço de criação de transações:

Parâmetro	Descrição	Formato	Obrigatório
`merchant_usn`	Número sequencial único para cada pedido, criado pela loja. O NSU será utilizado em toda a comunicação com a loja, de forma a identificar o pedido. Como se trata de uma possível chave para acesso do lado da loja, apesar de ser opcional para o e-SiTef, é fortemente recomendado que o campo seja formatado e enviado pela aplicação da loja.	< 12 N	NÃO
`order_id`	Código do pedido para ser exibido ao comprador, definido pelo lojista. É aconselhável que seja diferente a cada pedido para que facilite a rastreabilidade. Se a integração da Loja com as redes adquirentes (Cielo, Redecard, etc) for com e-SiTef e SiTef, o campo `orderId` que tem o tamanho máximo de 40 caracteres, será reduzido a 12 caracteres, devido a uma restrição do SiTef. Essa redução será realizada mantendo os caracteres da esquerda para direita (ex.: se um código de pedido inserido for 12345678901234567890 no e-SiTef, no SiTef ele será apenas 123456789012).	< 40 AN	NÃO
`installments`	Número de parcelas. Envie ‘1’ para transações à vista.	< 2 N	SIM
`installment_type`	Tipo de financiamento do parcelamento: valor 3 = parcelamento com juros da administradora do cartão. valor 4 = parcelamento realizado pela loja e sem juros (adotar este valor como padrão/default para transações à vista). Valor 6 = parcelamento com juros da administradora (IATA). valor 7 = parcelamento realizado pela loja e sem juros (IATA). O parcelamento IATA é utilizado somente por empresas do seguimento de transporte aéreo.	< 2 N	SIM
`authorizer_id`	Código da autorizadora no e-SiTef. Saiba mais.	< 3 N	NÃO
`amount`	Valor total da compra (em centavos). Exemplo: 1,00 = 100 ou 1.100,00 = 110000 – enviar o valor sem a vírgula e ponto.	< 12 N	SIM
`soft_descriptor`	Texto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador. Saiba mais	< 30 AN	NÃO
`authorizer_authentication`	Este campo deve ser enviado com valor `true` caso se deseje um pagamento com autenticação. Essa funcionalidade só está disponível para Cielo e-Commerce e e.Rede REST.	< 5 T/F	NÃO
`encrypted_card`	Este campo deve ser enviado com valor `true` caso o número do cartão a ser enviado na próxima etapa do fluxo use a criptografia do SiTef. A opção de envio do cartão criptografado só será possível com roteamento via SiTef e é necessário a configuração prévia do SiTef em questão	< 5 T/F	NÃO
iata	Este elemento contém campos específicos de transações IATA.
`departure_tax`	Taxa de embarque em centavos.	< 12 N	SIM apenas para installment_type = 6 ou 7
`first_installment`	Entrada em transações IATA em centavos. Funcionalidade disponível apenas para o adquirente Rede.	< 12 N	NÃO
schedule	O envio do elemento `schedule` implica no uso da funcionalidade de agendamento de recorrência. Nenhum de seus campos é obrigatório caso se deseje apenas fazer um pagamento simples.
`amount`	Valor em centavos dos pagamentos recorrentes. Caso esse campo não seja enviado, será utilizado o valor do pagamento.	< 12 N	SIM
`initial_date`	Data de execução do primeiro pagamento agendado. Essa data deve ter pelo menos dois dias à frente do dia atual e dias 29, 30 e 31 nunca são permitidos. O formato da data a ser seguido é: `DD/MM/AAAA` Exemplo: 20/04/2021	= 10 D	SIM
`number_of_times`	Número de pagamentos agendados a serem executados. Caso esse campo não seja enviado, agendamento ficará ativo infinitamente.	< 3 N	NÃO
`interval`	Intervalo em meses entre cada pagamento agendado. Caso esse campo não seja enviado, assume-se o valor `1` (execuções mensais).	< 2 N	NÃO
`do_payment_now`	Enviar esse campo com valor `false` caso se deseje realizar um agendamento sem pagamento imediato. No caso deste campo ser ausente ou para qualquer valor diferente de `false`, será criado um agendamento COM pagamento imediato.	< 5 T/F	NÃO
`installments`	Número de parcelas de cada pagamento agendado. Caso esse campo não seja enviado, assume-se o valor `1`.	<2 N	NÃO
`installment_type`	Tipo de financiamento do parcelamento de cada pagamento agendado: Valor `3` = parcelamento com juros da administradora do cartão. Valor `4` = parcelamento realizado pela loja e sem juros. (Adotar este valor como padrão/default para transações à vista). Caso esse campo não seja enviado, assume-se o valor `4`.	< 2 N	NÃO
`soft_descriptor`	Texto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador. Saiba mais	< 30 AN	NÃO
`show_times_invoice`	Para agendamentos por tempo finito, enviar esse campo com valor `true` caso se deseje acrescentar ao final do campo `soft_descriptor` o número de execuções/total de execuções (exemplo: Assinatura 3/12).	< 5 T/F	NÃO
additional_data	Elemento para envio de dados adicionais.
`postpone_confirmation`	Esse campo deve ser enviado com valor `true` caso se deseje um pagamento com confirmação tardia.	< 5 T/F	NÃO
`financing_plan`	Código de plano de financiamento. Necessário apenas para pagamentos parcelados com juros roteados pela Via Certa Financiadora via SiTef.	< 4 N	COND.
additional_data.payer	Elemento para envio de dados referentes ao comprador.
`identification_number`	Documento de identificação do comprador (CPF/RG).	< 20 AN	NÃO
`store_identification`	Identificação do comprador para armazenamento de cartão. Esta identificação deve ser única para cada usuário da loja. Mas atenção, essa garantia de unicidade é de total responsabilidade da loja, o e-SiTef não realizará nenhuma validação.	< 20 AN	SIM para agendamento
additional_data.merchant	Elemento para envio de dados referentes ao lojista.
`email`	Endereço de e-mail do lojista.	< 1024 AN	NÃO
additional_data. extra_param.prefixes	Elemento para envio de prefixos do SiTef, como CICLOS, CPLANO e VLRADD. Caso o prefixo enviado não seja suportado pelo cartão enviado, o e-SiTef invalidará a transação, impedindo que se dê uma falsa impressão do uso de uma determinada funcionalidade. Exemplo: `{ "key" : "value" }` -> `{ "CICLOS" : "01" }`
`key`	Nome do prefixo.	< 1024 AN	NÃO
`value`	Valor do prefixo.	< 1024 AN	NÃO

Na tabela abaixo está a descrição dos parâmetros adicionais que devem ser enviados num pagamento com análise de fraude (por enquanto disponível apenas para Cielo e-Commerce):

Parâmetro	Descrição	Formato	Obrigatório
	additional_data
`anti_fraud_institution`	Instituição que efetuará a análise de fraude para a loja. Deve ser enviado com o valor ‘AUTHORIZER’.	= 10 AN	SIM para análise de fraude
`anti_fraud`	Habilita o serviço de análise de fraude. Valores permitidos: `enabled_before_auth` – a análise de fraude será realizada ANTES da autorização do pagamento. Caso a análise seja rejeitada, o pagamento não será iniciado. `enabled_after_auth` – a análise de fraude será realizada APÓS a autorização do pagamento. Caso a análise seja rejeitada, o pagamento que já foi autorizado será cancelado.	< 19 AN	SIM para análise de fraude
`anti_fraud_criteria`	Critério de execução da análise de fraude. Valores permitidos: `ON_SUCCESS` – só realiza a análise se tiver sucesso na transação. `ALWAYS` – sempre realiza a análise.	< 10 AN	NÃO
`finger_print_id`	Identificador utilizado para cruzar informações obtidas pelo Browser do internauta com os dados enviados para análise. Maiores detalhes em http://apidocs.braspag.com.br/#CriandoumavendacomAnalisedeFraude.	< 50 AN	NÃO
`gift`	Indica se o pedido é para presente ou não.	< 5 T/F	NÃO
`returns_accepted`	Define se devoluções são aceitas para o pedido.	< 5 T/F	NÃO
`journey_type`	Tipo de viagem. Valores permitidos: `ROUND_TRIP` – ida e volta. `OUTWARD` – ida. `RETURN` – volta.	< 10 AN	NÃO
	additional_data.payer
`name`	Nome do comprador. Obs.: a concatenação de nome com o sobrenome não pode ultrapassar 255 caracteres.	< 200 AN	NÃO
`surname`	Sobrenome do comprador. Obs.: a concatenação do nome com o sobrenome não pode ultrapassar 255 caracteres.	< 200 AN	NÃO
`email`	E-mail do comprador.	< 255 AN	NÃO
`born_date`	Data de nascimento do comprador, no formato `YYYY-MM-DDTHH:MM:SS`. Ex.: 1991-01-02T08:30:00.	= 19 AN	NÃO
`adress_street_name`	Endereço do comprador.	< 255 AN	NÃO
`adress_street_number`	Número do endereço do comprador.	< 15 AN	NÃO
`adress_street_complement`	Complemento do endereço do comprador.	< 50 AN	NÃO
`adress_zip_code`	CEP do endereço do comprador. Ex.: 21241140.	< 9 AN	NÃO
`city`	Cidade do endereço do comprador.	< 50 AN	NÃO
`state`	Estado do endereço do comprador. Ex.: SP.	= 2 AN	NÃO
`address_country`	País do endereço do comprador. Ex.: BRA.	< 35 AN	NÃO
	additional_data.shipment.receiver_address
`street_name`	Endereço de entrega.	< 255 AN	NÃO
`street_number`	Número do endereço de entrega.	< 15 AN	NÃO
`complement`	Complemento do endereço de entrega.	< 50 AN	NÃO
`zip_code`	CEP do endereço de entrega. Ex.: 21241-140.	< 9 AN	NÃO
`city`	Cidade do endereço de entrega.	< 50 AN	NÃO
`state`	Estado do endereço de entrega.	= 2 AN	NÃO
`country`	País do endereço de entrega seguindo a AN 3166-1. Ex.: BRA	= 3 AN	NÃO
	additional_data.browser
`cookies_accepted`	Identifica se o browser do cliente aceita cookies. Enviar `true` caso positivo.	< 5 T/F	NÃO
`email`	E-mail registrado no browser do comprador.	< 100 AN	NÃO
`host_name`	Nome do host onde o comprador estava antes de entrar no site da loja.	< 60 AN	NÃO
`ip_address`	Endereço IP do comprador. É altamente recomendável o envio deste campo.	< 15 AN	NÃO
`agent`	Nome do browser utilizado pelo comprador. Ex.: Chrome.	< 40 AN	NÃO
	additional_data.items[]
`gift_category`	Campo que avaliará os endereços de cobrança e entrega para diferentes cidades, estados ou países. Pode assumir os seguintes valores: `OFF` – Ignora a análise de risco para endereços divergentes. `YES` – Em caso de divergência entre endereços de cobrança e entrega, marca com risco pequeno. `NO` – Em caso de divergência entre endereços de cobrança e entrega, marca com risco alto.	< 3 AN	NÃO
`risk`	Nível do risco do produto. Pode assumir os seguintes valores: `LOW` – O produto tem um histórico de poucos chargebacks. `NORMAL` – O produto tem um histórico de chargebacks considerado normal. `HIGH` – O produto tem um histórico de chargebacks acima da média.	< 6 AN	NÃO
`title`	Nome do produto.	< 255 AN	NÃO
`quantity`	Quantidade do produto a ser adquirido.	< 15 N	NÃO
`id`	Código comerciante identificador do produto.	< 255 AN	NÃO
`unit_price`	Preço unitário do produto em centavos.	< 15 N	NÃO
`category_id`	Tipo do produto. Pode assumir os seguintes valores: `art`, `baby`, `coupon`, `donation`, `computing`, `camera`, `video_game`, `television`, `car_electronic`, `electronic`, `automotive`, `entertainment`, `fashion`, `game`, `home`, `musical`, `phone`, `service`, `learning`, `ticket`, `travel`, `virtual_good`, `physical`, `other`, `adult_content`, `gift_certificate`, `handling`, `shipping`, `shipping_and_handling` ou `subscription`.	< 21 AN	NÃO
	additional_data.items[].hedge
`time`	Nível de importância da hora do dia do pedido do cliente. Pode assumir os seguintes valores: `LOW` – Baixa importância no horário do dia em que foi feita a compra, para a análise de risco. `NORMAL` – Média importância no horário do dia em que foi feita a compra, para a análise de risco. `HIGH` – Alta importância no horário do dia em que foi feita a compra, para a análise de risco. `OFF` – O horário da compra não afeta a análise de risco.	< 6 AN	NÃO
`host`	Nível de importância do e-mail e endereços IP dos clientes em risco de pontuação. Pode assumir os seguintes valores: `LOW` – Baixa importância do e-mail e endereço IP na análise de risco. `NORMAL` – Média importância do e-mail e endereço IP na análise de risco. `HIGH` – Alta importância do e-mail e endereço IP na análise de risco. `OFF` – E-mail e endereço IP não afetam a análise de risco.	< 6 AN	NÃO
`non_sensical`	Nível dos testes realizados sobre os dados do comprador com pedidos recebidos sem sentido. Pode assumir os seguintes valores: `LOW` – Baixa importância da verificação feita sobre o pedido do comprador, na análise de risco. `NORMAL` – Média importância da verificação feita sobre o pedido do comprador, na análise de risco. `HIGH` – Alta importância da verificação feita sobre o pedido do comprador, na análise de risco. `OFF` – Verificação do pedido do comprador não afeta a análise de risco.	< 6 AN	NÃO
`obscenities`	Nível de obscenidade dos pedidos recebidos. Pode assumir os seguintes valores: `LOW` – Baixa importância da verificação sobre obscenidades do pedido do comprador, na análise de risco. `NORMAL` – Média importância da verificação sobre obscenidades do pedido do comprador, na análise de risco. `HIGH` – Alta importância da verificação sobre obscenidades do pedido do comprador, na análise de risco. `OFF` – Verificação de obscenidade no pedido do comprador não afeta a análise de risco.	< 6 AN	NÃO
`phone`	Nível dos testes realizados com os números de telefones. Pode assumir os seguintes valores: `LOW` – Baixa importância nos testes realizados com números de telefone. `NORMAL` – Média importância nos testes realizados com números de telefone. `HIGH` – Alta importância nos testes realizados com números de telefone. `OFF` – Testes de números de telefone não afetam a análise de risco.	< 6 AN	NÃO
`velocity`	Nível de importância de frequência de compra do cliente. Pode assumir os seguintes valores: `LOW` – Baixa importância no número de compras realizadas pelo cliente nos últimos 15 minutos. `NORMAL` – Média importância no número de compras realizadas pelo cliente nos últimos 15 minutos. `HIGH` – Alta importância no número de compras realizadas pelo cliente nos últimos 15 minutos. `OFF` – A frequência de compras realizadas pelo cliente não afeta a análise de fraude.	< 6 AN	NÃO
	additional_data.items[].passenger
`email`	E-mail do passageiro.	< 255 AN	NÃO
`legal_document`	Id do passageiro a quem o bilhete foi emitido.	< 32 AN	NÃO
`name`	Nome do passageiro.	< 120 AN	NÃO
`rating`	Classificação do passageiro. Pode assumir os seguintes valores: `ADULT` – Passageiro adulto. `CHILD` – Passageiro criança. `INFANT` – Passageiro infantil. `YOUTH` – Passageiro adolescente. `STUDENT` – Passageiro estudante. `SENIOR_CITIZEN` – Passageiro idoso. `MILITARY` – Passageiro militar.	< 14 AN	NÃO
`customer_class`	Classificação da empresa aérea. Pode-se usar valores como Gold ou Platina.	< 32 AN	NÃO
	additional_data.items[].passenger.phone
`ddi`	Código do país do telefone do passageiro. Para pedidos fora dos E.U.A., é recomendável o envio deste campo.	< 3 N	NÃO
`ddd`	Código da área do telefone do passageiro.	< 3 N	NÃO
`number`	Número de telefone do passageiro.	< 9 N	NÃO
	additional_data.extra_param.acquirer_params[]
`key`	Id das informações adicionais a serem enviadas. Maiores detalhes sobre o envio desse campo em https://developercielo.github.io/Webservice-3.0/#merchant-defined-data.	< 1024 N	NÃO
`value`	Valor das informações adicionais a serem enviadas.	< 1024 AN	NÃO
	additional_data.shipment
`name`	Nome do destinatário da entrega.	< 255 AN	NÃO
`method`	Tipo de serviço de entrega do produto. Pode assumir os seguintes valores: `SAME_DAY` – Serviço de entrega no mesmo dia. `ONE_DAY` – Serviço de entrega noturna ou no dia seguinte. `TWO_DAY` – Serviço de entrega em dois dias. `THREE_DAY` – Serviço de entrega em três dias. `LOW_COST` – Serviço de entrega de baixo custo. `PICKUP` – Produto retirado na loja. `OTHER` – Outro método de entrega. `NONE` – Sem serviço de entrega, pois é um serviço ou assinatura.	< 9 AN	NÃO
	additional_data.shipment.phones[]
`ddi`	Código do país do telefone do destinatário da entrega. Para pedidos fora dos E.U.A., é recomendável o envio deste campo.	< 3 N	NÃO
`ddd`	Código da área do telefone do destinatário da entrega.	< 3 N	NÃO
`number`	Número de telefone do destinatário da entrega.	< 9 N	NÃO
	additional_data.connections[]
`flight_date`	Data, hora e minuto de partida do voo no formato `YYYY-MM-DDTHH:MM:SS`. Ex.: 1991-01-02T08:30:00.	= 19 AN	NÃO
`from`	Código do aeroporto do ponto de origem da viagem. Ex.: CGH.	= 3 AN	NÃO
`to`	Código do aeroporto do ponto de destino da viagem. Ex.: GYN.	= 3 AN	NÃO

Parâmetros de resposta

Em caso de sucesso, o código de resposta HTTP será 201. Qualquer outro código deve ser interpretado como erro. Na tabela abaixo está a descrição dos parâmetros de resposta do serviço de criação de transações:

Parâmetro	Descrição	Formato
`code`	Código de resposta do e-SiTef. Qualquer código diferente de `0` significa falha. Saiba mais.	< 4 N
`message`	Mensagem de resposta do e-SiTef.	< 500 AN
	payment
`status`	Status da transação de pagamento no e-SiTef. Saiba mais.	= 3 AN
`nit`	Identificador da transação de pagamento no e-SiTef.	= 64 AN
`order_id`	Código de pedido enviado pela loja na criação da transação.	< 40 AN
`merchant_usn`	Número sequencial único enviado pela loja na criação da transação.	< 12 N
`amount`	Valor da compra especificado pela loja (em centavos) na criação da transação.	< 12 N
	schedule
`sid`	Identificador da transação de agendamento no e-SiTef.	= 64 AN
`amount`	Valor dos pagamentos agendados especificado pela loja (em centavos) na criação da transação.	< 12 N
`status`	Status do agendamento no e-SiTef. Saiba mais.	= 3 AN
`order_id`	Código de pedido enviado pela loja na criação da transação.	< 40 AN
`merchant_usn`	Número sequencial único enviado pela loja na criação da transação.	< 12 N

Serviço de efetivação de pagamento

Após consumir o serviço de criação de transação e obter um NIT, é possível prosseguir para a próxima etapa do fluxo: a chamada ao serviço de efetivação de pagamento. Esta operação deve ser consumida também em fluxos de pagamento com agendamento. Nesse caso, o e-SiTef garante que o agendamento só será ativado caso o pagamento seja confirmado.

Detalhes da chamada

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

Parâmetro	Descrição	Formato	Obrigatório
`merchant_id`	Código da loja no e-SiTef. Os códigos de produção e certificação serão diferentes.	< 15 AN	SIM
`merchant_key`	Chave de autenticação da loja no e-SiTef. As chaves de produção e certificação serão diferentes.	< 80 AN	SIM
`Content-Type`	Deve ser enviado com o valor `application/json`.	= 15 AN	SIM

Exemplos

Abaixo estão alguns exemplos de chamada do serviço de efetivação de pagamento utilizando a ferramenta cURL.

Pagamento com captura automática

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "number":"5555555555555555",
      "expiry_date":"1222",
      "security_code":"123"
   }
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "authorizer_code":"000",
      "authorizer_message":"Transacao OK",
      "status":"CON",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"13034649671",
      "customer_receipt":"====CUPOM COMPRADOR====",
      "merchant_receipt":"====CUPOM ESTABELECIMENTO====",
      "authorizer_id":"2",
      "acquirer_id":"1005",
      "acquirer_name":"Redecard",
      "authorizer_date":"13/07/2017T15:52",
      "authorization_number":"132030",
      "merchant_usn":"13034649671",
      "esitef_usn":"170713097340300",
      "sitef_usn":"132030",
      "host_usn":"999132030",
      "payment_date":"13/07/2017T15:52",
      "amount":"1000",
      "payment_type":"C",
      "issuer":"2",
      "authorizer_merchant_id":"000000000000005"
   }
}

Pagamento com confirmação tardia

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "number":"5555555555555555",
      "expiry_date":"1222",
      "security_code":"123"
   }
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "authorizer_code":"000",
      "authorizer_message":"Transacao OK",
      "status":"PPC",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"13035748930",
      "customer_receipt":"==== CUPOM COMPRADOR ====",
      "merchant_receipt":"==== CUPOM ESTABELECIMENTO ====",
      "authorizer_id":"2",
      "acquirer_id":"1005",
      "acquirer_name":"Redecard",
      "authorizer_date":"13/07/2017T15:58",
      "authorization_number":"132031",
      "merchant_usn":"13035748930",
      "esitef_usn":"170713097340340",
      "sitef_usn":"132031",
      "host_usn":"999132031   ",
      "payment_date":"13/07/2017T15:58",
      "amount":"1000",
      "payment_type":"C",
      "issuer":"2",
      "authorizer_merchant_id":"000000000000005"
   }
}

Pagamento com agendamento

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "number":"5555555555555555",
      "expiry_date":"1222",
      "security_code":"123"
   }
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "authorizer_code":"000",
      "authorizer_message":"Transacao OK",
      "status":"CON",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"13040222890",
      "customer_receipt":"==== CUPOM COMPRADOR ====",
      "merchant_receipt":"==== CUPOM ESTABELECIMENTO ====",
      "authorizer_id":"2",
      "acquirer_id":"1005",
      "acquirer_name":"Redecard",
      "authorizer_date":"13/07/2017T16:03",
      "authorization_number":"132032",
      "merchant_usn":"13040222890",
      "esitef_usn":"170713097340360",
      "sitef_usn":"132032",
      "host_usn":"999132032   ",
      "payment_date":"13/07/2017T16:03",
      "amount":"1000",
      "payment_type":"C",
      "issuer":"2",
      "authorizer_merchant_id":"000000000000005"
   },
   "schedule":{
      "status":"ATV",
      "sid":"qwertyuiopasdfghjklzxcvbnm0123456789qwertyuiopasdfghjklzxcvbnm01",
      "schedule_usn":"170713000000020",
      "amount":"900",
      "initial_date":"03/08/2017",
      "next_date":"03/08/2017",
      "number_of_times":"3",
      "soft_descriptor":"Assinatura",
      "show_times_invoice":"false"
   }
}

Pagamento com cartão armazenado

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "token":"g16hJtpdU6XEN3FP-ApQ9pKTGII5Fa9Y12tRX-qfyC-+BUCV5OaFn807zwwOR6rDtKoRnIJg0QbikaJqJqosyQ=="  
   }
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "authorizer_code":"000",
      "authorizer_message":"Transacao OK",
      "status":"CON",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"13034649671",
      "customer_receipt":"====CUPOM COMPRADOR====",
      "merchant_receipt":"====CUPOM ESTABELECIMENTO====",
      "authorizer_id":"2",
      "acquirer_id":"1005",
      "acquirer_name":"Redecard",
      "authorizer_date":"13/07/2017T15:52",
      "authorization_number":"132030",
      "merchant_usn":"13034649671",
      "esitef_usn":"170713097340300",
      "sitef_usn":"132030",
      "host_usn":"999132030",
      "payment_date":"13/07/2017T15:52",
      "amount":"1000",
      "payment_type":"C",
      "issuer":"2",
      "authorizer_merchant_id":"000000000000005"
   }
}

Pagamento com planos de financiamento Via Certa Financiadora

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "expiry_date":"1222",
      "security_code":"123",
      "number":"5555555555555555"
   },
   "acquirer":{
      "financing_plan":"0302"
   }
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "authorizer_code":"000",
      "authorizer_message":"Transacao OK",
      "status":"CON",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"21105507366",
      "customer_receipt":"====CUPOM COMPRADOR====",
      "merchant_receipt":"====CUPOM ESTABELECIMENTO====",
      "authorizer_id":"313",
      "acquirer_id":"1313",
      "acquirer_name":"Via Certa Financiadora",
      "authorizer_date":"21/11/2017T10:55",
      "authorization_number":"211982",
      "merchant_usn":"21105507366",
      "esitef_usn":"171121108905101",
      "sitef_usn":"211982",
      "host_usn":"999211982   ",
      "amount":"1000",
      "payment_type":"C",
      "issuer":"2",
      "authorizer_merchant_id":"0000000000000313",
      "payment_date":"21/11/2017T10:55"
   }
}

Pagamento com prefixos

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "expiry_date":"1222",
      "security_code":"123",
      "number":"5555555555555555"
   },
   "acquirer":{
      "prefixes":{
         "TRAT":"1"
      }
   }
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "authorizer_code":"000",
      "authorizer_message":"Transacao OK",
      "status":"CON",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"21105507366",
      "customer_receipt":"====CUPOM COMPRADOR====",
      "merchant_receipt":"====CUPOM ESTABELECIMENTO====",
      "authorizer_id":"2",
      "acquirer_id":"1005",
      "acquirer_name":"Redecard",
      "authorizer_date":"21/11/2017T10:55",
      "authorization_number":"211981",
      "merchant_usn":"21105507366",
      "esitef_usn":"171121108905100",
      "sitef_usn":"211981",
      "host_usn":"999211981   ",
      "amount":"1000",
      "payment_type":"C",
      "issuer":"2",
      "authorizer_merchant_id":"000000000000005",
      "payment_date":"21/11/2017T10:55"
   }
}

Pagamento split para roteamentos BIN e Sipag via SiTef

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "number":"5555555555555555",
      "expiry_date":"1222",
      "security_code":"123"
   },
   "acquirer":{
      "submerchant_split":[
         {
            "submerchant_code":"empresa01",
            "submerchant_amount":"10"
         },
         {
            "submerchant_code":"empresa02",
            "submerchant_amount":"20"
         },
         {
            "submerchant_code":"empresa03",
            "submerchant_amount":"20"
         },
         {
            "submerchant_code":"empresa04",
            "submerchant_amount":"30"
         },
         {
            "submerchant_code":"empresa05",
            "submerchant_amount":"30"
         }
      ]
   }
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "authorizer_code": "000",
      "authorizer_message": "APROVADA",
      "status": "CON",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "authorizer_id": "1",
      "acquirer_id": "229",
      "acquirer_name": "Bin",
      "authorizer_date": "29/03/2019T13:26",
      "authorization_number": "000058",
      "merchant_usn": "20180809",
      "esitef_usn": "190329026585100",
      "sitef_usn": "000058",
      "host_usn": "003000058   ",
      "amount": "13000",
      "payment_type": "C",
      "issuer": "1",
      "authorizer_merchant_id": "000000000000000",
      "payment_date": "29/03/2019T13:26"
   }
}

Parâmetros de requisição

Na tabela abaixo está a descrição dos parâmetros de requisição do serviço de efetivação de pagamento:

Parâmetro	Descrição	Formato	Obrigatório
`authorizer_id`	Código da autorizadora no e-SiTef. Saiba mais. Caso este campo não tenha sido enviado na etapa de criação da transação, ele passa a ser obrigatório ao consumir o serviço de efetivação do pagamento.	< 3 N	COND.
`customer_postal_code`	Código postal (CEP no Brasil) do usuário. Este deve ser enviado para transações roteadas iCards via SiTef, caso a coleta deste for indicada no serviço de consulta de cartão pelo campo is_customer_postal_code_required.	< 8 N	COND.
`mcc`	O MCC (Merchant Category Code) é um código que classifica um negócio pelo tipo de bens ou produtos fornecidos.	< 4 N	NÃO
`subacquirer_merchant_id`	Identificação da loja na subadquirente.	< 22 N	NÃO
card	Dados do cartão.
`number`	Número do cartão do comprador (PAN).	< 19 N	SIM
`expiry_date`	Data de vencimento do cartão no formato `MMAA`. Sua obrigatoriedade depende do adquirente escolhido. Na maioria dos casos, esse campo é obrigatório.	= 4 N	COND.
`security_code`	Código de segurança. Este campo pode não ser obrigatório se a empresa possuir um acordo no contrato firmado com as redes adquirentes, somente para o pagamento de determinados seguimentos. Importante: um pagamento com agendamento implica no armazenamento dos dados do cartão do comprador no ambiente do e-SiTef. Porém, por questões de segurança, o código de segurança não pode ser armazenado. Por isso, os pagamentos agendados sempre serão executados sem o envio do código de segurança.	< 5 N	COND.
`holder`	Nome do portador do cartão. Obrigatório apenas para pagamentos com e-Rede, GetNet WS e VR (SmartNet).	< 30 AN	COND.
`token`	HASH de um cartão armazenado no e-SiTef. Não é permitido enviar um número de cartão aberto (campo `number`) e um cartão armazenado (campo `token`) na mesma requisição.	= 88 AN	NÃO
`wallet_transaction_id`	ID de uma transação de carteiras digitais. Por enquanto, essa funcionalidade está disponível apenas para as autorizadoras Visa Checkout, VEE (via CardSE-SiTef) e Google Pay. Não é permitido enviar um número de cartão aberto (campo `number`), um cartão armazenado (campo `token`) e um `wallet_transaction_id` na mesma requisição.	< 25 AN	NÃO
`initial_wallet_transaction_id`	Informa se o Wallet ID (`wallet_transaction_id`) está sendo utilizado pela primeira vez. Se for a primeira vez, enviar `true`, caso contrário enviar `false`.	< 5 T/F	NÃO
external_authentication	Este elemento recebe campos de resultados de autenticação MPI.
`eci`	Eletronic Commerce Indicator – indica o nível de segurança da transação com autenticação do dono do cartão	< 3 N	NÃO
`xid`	Identificador da transação de autenticação do dono do cartão, feita em serviço externo ao e-SiTef	< 40 N	NÃO
`cavv`	Cardholder Authentication Verification Value - Código que indica o resultado da autenticação do dono do cartão.	< 40 N	NÃO
acquirer	Dados específicos necessários dependendo da adquirente/roteamento.
`financing_plan`	Código de plano de financiamento. Necessário apenas para pagamentos parcelados com juros roteados pela Via Certa Financiadora via SiTef.	< 4 N	NÃO
`special_code`	Código de uso geral da Conductor/Renner.	< 6 N	NÃO
`recurrency`	Flag que define se o pagamento é ou não recorrente. Aceito para todos os roteamentos via SiTef, Cielo e-Commerce, Stone WS, Global Payments WS, SafraPay, e.Rede REST e GetnetWS. No caso de recorrência via Stone WS, é obrigatório o envio adicional de apenas um dos campos abaixo, `is_first_recurring` OU `is_subsequent_recurring`.	< 5 T/F	NÃO
`recurrency_tid`	TID da primeira transação da recorrência. Identificador que diferencia a primeira recorrência das subsequentes. Só é utilizado quando for uma recorrência. Campo utilizado somente no roteamento e.Rede REST para as bandeiras Visa e Mastercard e roteamento GetnetWS.	< 18 AN	NÃO
`is_first_recurring`	Flag usada apenas para roteamento StoneWS. Indica que a transação é a primeira de uma série de transações recorrentes.	< 5 T/F	COND.
`is_subsequent_recurring`	Flag usada apenas para roteamento StoneWS. Indica que a transação é a segunda ou n-ésima de uma série de transações recorrentes, onde n > 2.	< 5 T/F	COND.
`product_code`	Códido de produto. É obrigatório em roteamento via Marisa.	< 6 N	COND.
`terminal`	Terminal SiTef que se deseja usar. Se não for enviado, o e-SiTef gerará um terminal aleatório.	= 14 N	Não
`company_code`	Código de empresa SiTef que se deseja usar. Se não for enviado, o e-SiTef enviará o código de empresa cadastrado na loja.	= 8 N	Não
acquirer.vouchers_filter[]	Filtro de Vouchers - Escolha dos vouchers que não serão aceitos. Opções de "Vouchers": 01 - Alimentação, 02 - Refeição 03 - Cultura, 04 - Combustível, 05 - Benefício. Exemplo: Não se quer aceitar Vouchers: Cultura, Combustível, Benefício. Deve enviar: "vouchers_filter": [ "03", "04", "05" ]
acquirer.prefixes	Elemento para envio de prefixos do SiTef, como CICLOS, CPLANO e VLRADD. Caso o prefixo enviado não seja suportado pelo cartão enviado, o e-SiTef invalidará a transação, impedindo que se dê uma falsa impressão do uso de uma determinada funcionalidade. Exemplo: `{ "key" : "value" }` -> `{ "CICLOS" : "01" }`
`key`	Nome do prefixo.	< 1024 AN	NÃO
`value`	Valor do prefixo.	< 1024 AN	NÃO
acquirer.submerchant_split[]	Consiste em um array para pagamentos split, exclusivos para roteamentos BIN e Sipag, ambos via SiTef. Permite a divisão de partes do valor total do pagamento entre outras empresas. O máximo de itens permitido neste array é de 5 itens. Cada item é composto pelos campos `submechant_code` e `submerchant_amount`.
`submerchant_code`	código de estabelecimento BIN/Sipag	< 51 AN	NÃO
`submerchant_amount`	valor de transação referente ao estabelecimento	< 12 N	NÃO

ATENÇÃO: Os parâmetros terminal e company_code deverão ser usados somente para roteamentos via SiTef e devem ser enviados simultaneamente.
É necessário também solicitar à equipe de atendimento do e-SiTef a permissão Permite envio de Empresa e Terminal Sitef via REST.

Parâmetros de resposta

Parâmetro	Descrição	Formato
`code`	Código de resposta do e-SiTef. Qualquer código diferente de `0` significa falha. Saiba mais.	< 4 N
`message`	Mensagem de resposta do e-SiTef.	< 500 AN
	payment
`authorizer_code`	Código de resposta do autorizador.	< 10 AN
`authorizer_message`	Mensagem de resposta do autorizador.	< 500 AN
`status`	Status da transação de pagamento no e-SiTef. Saiba mais.	= 3 AN
`nit`	Identificador da transação de pagamento no e-SiTef.	= 64 AN
`order_id`	Código de pedido enviado pela loja na criação da transação.	< 40 AN
`merchant_usn`	Número sequencial único enviado pela loja na criação da transação.	< 12 N
`amount`	Valor da compra especificado pela loja (em centavos) na criação da transação.	< 12 N
`sitef_usn`	Número sequencial único da transação de pagamento no SiTef.	= 6 N
`esitef_usn`	Número sequencial único da transação de pagamento no e-SiTef.	= 15 N
`customer_receipt`	Cupom (via cliente).	< 4000 AN
`merchant_receipt`	Cupom (via estabelecimento).	< 4000 AN
`authorizer_id`	Código da autorizadora utilizada na transação.	< 4 N
`acquirer_id`	Código do adquirente utilizado na transação.	< 4 N
`acquirer_name`	Nome do adquirente utilizado na transação.	< 100 AN
`authorizer_date`	Data de efetivação do pagamento retornada pelo autorizador no formato `DD/MM/AAAA'T'HH:mm`. Exemplo: 13/07/2017T16:03	= 16 D
`authorization_number`	Número de autorização.	< 6 AN
`host_usn`	NSU da autorizadora.	< 15 AN
`tid`	ID da transação no adquirente. Este campo só é retornado em transações com adquirentes externos ao SiTef.	< 40 AN
`eci`	Eletronic Commerce Indicator (indicador do nível de segurança da transação do pagamento via Cielo e-Commerce).	< 3 AN
`payment_date`	Data de efetivação do pagamento no e-SiTef no formato `DD/MM/AAAA'T'HH:mm`. Exemplo: 13/07/2017T16:03	= 16 D
`issuer`	Código da bandeira retornado pelo autorizador.	< 5 AN
`authorizer_merchant_id`	Código de afiliação do lojista na autorizadora.	< 100 AN
`xid`	Campo XID retornado em autenticações 3DS ou certos adquirentes.	< 40 AN
`authentication_url`	URL de autenticação retornada em fluxos de pagamento com autenticação. Disponível apenas para Cielo e-Commerce.	< 56 AN
`balance`	Saldo disponível após pagamentos com cartões tipo Gift.	< 12 N
`recurrency_tid`	Id de transação (TID) da bandeira, referente à primeira transação da recorrência. Só é retornado quando for uma recorrência. Campo utilizado somente no roteamento e.Rede REST para as bandeiras Visa e Mastercard.	< 16 AN
	payment.analysis
`code`	Código de resposta da operação de análise de fraude.	< 4 N
`message`	Mensagem de resposta da operação de análise de fraude.	< 200 AN
`status`	Status da transação de análise de fraude do e-SiTef. Este campo pode assumir os seguintes valores: `NOV` – Nova. `EXP` – Expirada. `ACC` – Aceita `REJ` – Rejeitada `REV` – Em revisão `INV` – Inválida	= 3 AN
	schedule
`status`	Status do agendamento no e-SiTef. Saiba mais.	= 3 AN
`sid`	Identificador da transação de agendamento no e-SiTef.	= 64 AN
`schedule_usn`	Número sequencial único do agendamento no e-SiTef.	= 15 N
`authorizer_id`	Código da autorizadora a ser utilizada nos pagamentos agendados.	= 4 N
`amount`	Valor dos pagamentos agendados especificado pela loja (em centavos) na criação da transação.	< 12 N
`order_id`	Código de pedido enviado pela loja na criação da transação.	< 40 AN
`merchant_usn`	Número sequencial único enviado pela loja na criação da transação.	< 12 N
`initial_date`	Data de execução do primeiro pagamento agendado no formato `DD/MM/AAAA`.	= 10 D
`next_date`	Data de execução do próximo pagamento agendado no formato `DD/MM/AAAA`.	= 10 D
`number_of_times`	Número total de pagamentos agendados.	< 3 N
`installments`	Número de parcelas a ser utilizado nos pagamentos agendados.	< 2 N
`installment_type`	Tipo de financiamento a ser utilizado nos pagamentos agendados.	< 2 N
`soft_descriptor`	Texto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador.	< 30 AN
`show_times_invoice`	Para agendamentos por tempo finito, caso esse campo tenha valor `true` acrescenta ao final do campo `soft_descriptor` o número de execuções/total de execuções (exemplo: Assinatura 3/12).	< 5 T/F
`terminal_id`	Código do terminal utilizada na transação	< 8 AN

Serviço de confirmação de pagamento

Após criar e efetuar um pagamento pendente de confirmação, o lojista deve chamar o serviço de confirmação para confirmar ou desfazer o pagamento utilizando o mesmo NIT obtido na primeira etapa do fluxo.

Detalhes da chamada

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

Parâmetro	Descrição	Formato	Obrigatório
`merchant_id`	Código da loja no e-SiTef. Os códigos de produção e certificação serão diferentes.	< 15 AN	SIM
`merchant_key`	Chave de autenticação da loja no e-SiTef. As chaves de produção e certificação serão diferentes.	< 80 AN	SIM

Exemplo

Abaixo está um exemplo de chamada do serviço de confirmação de pagamento utilizando a ferramenta cURL.

Requisição:

curl
--request PUT "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr?confirm=true"
--header "merchant_id:xxxxxxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"CON"
   }
}

Parâmetros de requisição

Na tabela abaixo está a descrição dos parâmetros de requisição do serviço de confirmação de pagamento:

Parâmetro	Descrição	Formato	Obrigatório
`confirm`	Este campo deve ser enviado com o valor `true` caso se deseje confirmar a transação, ou `false`, caso queira desfazer o pagamento.	< 5 T/F	SIM
`amount`	Valor a ser capturado. Deve ser menor ou igual ao autorizado. Confirmações com valor menor só são suportadas por roteamentos não-SiTef. Caso este campo não seja enviado, é utilizado o valor total da transação.	< 12 N	NÃO

Parâmetros de resposta

Em caso de sucesso, o código de resposta HTTP será 200. Qualquer outro código deve ser interpretado como erro. Na tabela abaixo está a descrição dos parâmetros de resposta do serviço de confirmação de pagamento:

Parâmetro	Descrição	Formato
`code`	Código de resposta do e-SiTef. Qualquer código diferente de `0` significa falha. Saiba mais.	< 4 N
`message`	Mensagem de resposta do e-SiTef.	< 500 AN
	payment
`status`	Status da transação de pagamento no e-SiTef. Saiba mais.	= 3 AN
`payment_date`	Data de efetivação do pagamento no e-SiTef no formato `DD/MM/AAAA'T'HH:mm`. Exemplo: 13/07/2017T16:03	= 16 D
`host_usn`	NSU da autorizadora.	< 15 AN

Serviço de consulta de transação

Estes serviços podem ser chamados para obter os dados da transação de pagamento, cancelamento ou agendamento. É essencial o uso dessa operação em casos de erro de comunicação para verificar o status atual da transação, que pode ter sido efetuada ou não recebida pelo e-SiTef.

O e-SiTef disponibiliza um serviço para consulta a partir do NIT (pagamento/cancelamento) e um serviço para consulta a partir do SID (agendamento). No caso de pagamento com agendamento, as consultas retornarão os dados das duas transações.

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 pagamento 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

Consulta por NIT

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

Parâmetro	Descrição	Formato	Obrigatório
`merchant_id`	Código da loja no e-SiTef. Os códigos de produção e certificação serão diferentes.	< 15 AN	SIM
`merchant_key`	Chave de autenticação da loja no e-SiTef. As chaves de produção e certificação serão diferentes.	< 80 AN	SIM

Consulta por SID

Recurso: /v1/schedules/{sid}
Método HTTP: GET
Formato da requisição: não há parâmetros de requisição
Formato da resposta: JSON
Parâmetros de cabeçalho:

Parâmetro	Descrição	Formato	Obrigatório
`merchant_id`	Código da loja no e-SiTef. Os códigos de produção e certificação serão diferentes.	< 15 AN	SIM
`merchant_key`	Chave de autenticação da loja no e-SiTef. As chaves de produção e certificação serão diferentes.	< 80 AN	SIM

Exemplos

Abaixo estão alguns exemplos de chamada dos serviços de consulta utilizando a ferramenta cURL.

Consulta de pagamento

Requisição:

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

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "authorizer_code":"000",
      "authorizer_message":"Transacao OK",
      "status":"CON",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"13064421440",
      "customer_receipt":"==== CUPOM COMPRADOR ====",
      "merchant_receipt":"==== CUPOM ESTABELECIMENTO ====",
      "authorizer_id":"2",
      "acquirer_id":"1005",
      "acquirer_name":"Redecard",
      "authorizer_date":"13/07/2017T18:44",
      "authorization_number":"132048",
      "merchant_usn":"13064421441",
      "esitef_usn":"170713097341620",
      "sitef_usn":"132048",
      "host_usn":"999132048   ",
      "payment_date":"13/07/2017T18:44",
      "amount":"1000",
      "payment_type":"C",
      "issuer":"2",
      "authorizer_merchant_id":"000000000000005"
   }
}

Consulta de agendamento

Requisição:

curl
--request GET "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/schedules/qwertyuiopasdfghjklzxcvbnm0123456789qwertyuiopasdfghjklzxcvbnm01"
--header "merchant_id: xxxxxxxxxxxxxxx" 
--header "merchant_key: xxxxxxxxxxx"
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "schedule":{
      "status":"ATV",
      "sid":"qwertyuiopasdfghjklzxcvbnm0123456789qwertyuiopasdfghjklzxcvbnm01",
      "schedule_usn":"170713000000050",
      "authorizerId":"2",
      "amount":"900",
      "initial_date":"03/08/2017",
      "next_date":"03/08/2017",
      "number_of_times":"3",
      "current_times":"0",
      "installments":"1",
      "installment_type":"4",
      "soft_descriptor":"Assinatura",
      "show_times_invoice":"false"
   }
}

Consulta por NIT de pagamento com agendamento

Requisição:

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

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "authorizer_code":"000",
      "authorizer_message":"Transacao OK",
      "status":"CON",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"13065054564",
      "customer_receipt":"==== CUPOM COMPRADOR ====",
      "merchant_receipt":"==== CUPOM ESTABELECIMENTO ====",
      "authorizer_id":"2",
      "acquirer_id":"1005",
      "acquirer_name":"Redecard",
      "authorizer_date":"13/07/2017T18:51",
      "authorization_number":"132050",
      "merchant_usn":"13065054565",
      "esitef_usn":"170713097341630",
      "sitef_usn":"132050",
      "host_usn":"999132050   ",
      "payment_date":"13/07/2017T18:51",
      "amount":"1000",
      "payment_type":"C",
      "issuer":"2",
      "authorizer_merchant_id":"000000000000005"
   },
   "schedule":{
      "status":"ATV",
      "sid":"qwertyuiopasdfghjklzxcvbnm0123456789qwertyuiopasdfghjklzxcvbnm01",
      "schedule_usn":"170713000000060",
      "authorizerId":"2",
      "amount":"900",
      "initial_date":"03/08/2017",
      "next_date":"03/10/2017",
      "number_of_times":"3",
      "current_times":"2",
      "installments":"1",
      "installment_type":"4",
      "soft_descriptor":"Assinatura",
      "show_times_invoice":"false",
      "nits":[
         "123412341234111",
         "123412341234222"
      ]
   }
}

Consulta por SID de agendamento com pagamento

Requisição:

curl
--request GET "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/schedules/qwertyuiopasdfghjklzxcvbnm0123456789qwertyuiopasdfghjklzxcvbnm01"
--header "merchant_id: xxxxxxxxxxxxxxx" 
--header "merchant_key: xxxxxxxxxxx"
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "authorizer_code":"000",
      "authorizer_message":"Transacao OK",
      "status":"CON",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"13065054564",
      "customer_receipt":"==== CUPOM COMPRADOR ====",
      "merchant_receipt":"==== CUPOM ESTABELECIMENTO ====",
      "authorizer_id":"2",
      "acquirer_id":"1005",
      "acquirer_name":"Redecard",
      "authorizer_date":"13/07/2017T18:51",
      "authorization_number":"132050",
      "merchant_usn":"13065054565",
      "esitef_usn":"170713097341630",
      "sitef_usn":"132050",
      "host_usn":"999132050   ",
      "payment_date":"13/07/2017T18:51",
      "amount":"1000",
      "payment_type":"C",
      "issuer":"2",
      "authorizer_merchant_id":"000000000000005"
   },
   "schedule":{
      "status":"ATV",
      "sid":"qwertyuiopasdfghjklzxcvbnm0123456789qwertyuiopasdfghjklzxcvbnm01",
      "schedule_usn":"170713000000060",
      "authorizerId":"2",
      "amount":"900",
      "initial_date":"03/08/2017",
      "next_date":"03/10/2017",
      "number_of_times":"3",
      "current_times":"2",
      "installments":"1",
      "installment_type":"4",
      "soft_descriptor":"Assinatura",
      "show_times_invoice":"false",
      "nits":[
         "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqs",
         "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqt"
      ]
   }
}

Parâmetros de resposta

Parâmetro	Descrição	Formato
`code`	Código de resposta do e-SiTef. Qualquer código diferente de `0` significa falha. Saiba mais.	< 4 N
`message`	Mensagem de resposta do e-SiTef.	< 500 AN
	payment
`authorizer_code`	Código de resposta do autorizador.	< 10 AN
`authorizer_message`	Mensagem de resposta do autorizador.	< 500 AN
`status`	Status da transação de pagamento no e-SiTef. Saiba mais.	= 3 AN
`nit`	Identificador da transação de pagamento no e-SiTef.	= 64 AN
`order_id`	Código de pedido enviado pela loja na criação da transação.	< 40 AN
`merchant_usn`	Número sequencial único enviado pela loja na criação da transação.	< 12 N
`amount`	Valor da compra especificado pela loja (em centavos) na criação da transação.	< 12 N
`sitef_usn`	Número sequencial único da transação de pagamento no SiTef.	= 6 N
`esitef_usn`	Número sequencial único da transação de pagamento no e-SiTef.	= 15 N
`customer_receipt`	Cupom (via cliente).	< 4000 AN
`merchant_receipt`	Cupom (via estabelecimento).	< 4000 AN
`authorizer_id`	Código da autorizadora utilizada na transação.	< 4 N
`acquirer_id`	Código do adquirente utilizado na transação.	< 4 N
`acquirer_name`	Nome do adquirente utilizado na transação.	< 100 AN
`authorizer_date`	Data de efetivação do pagamento retornada pelo autorizador no formato `DD/MM/AAAA'T'HH:mm`. Exemplo: 13/07/2017T16:03	= 16 D
`authorization_number`	Número de autorização.	< 6 AN
`host_usn`	NSU da autorizadora.	< 15 AN
`tid`	ID da transação no adquirente. Este campo só é retornado em transações com adquirentes externos ao SiTef.	< 40 AN
`eci`	Eletronic Commerce Indicator (indicador do nível de segurança da transação do pagamento via Cielo e-Commerce).	< 3 AN
`payment_date`	Data de efetivação do pagamento no e-SiTef no formato `DD/MM/AAAA'T'HH:mm`. Exemplo: 13/07/2017T16:03	= 16 D
`issuer`	Código da bandeira retornado pelo autorizador.	< 5 AN
`authorizer_merchant_id`	Código de afiliação do lojista na autorizadora.	< 100 AN
`xid`	Campo XID retornado em autenticações 3DS ou certos adquirentes.	< 40 AN
`balance`	Saldo disponível após pagamentos com cartões tipo Gift.	< 12 N
	payment.analysis
`code`	Código de resposta da operação de análise de fraude.	< 4 N
`message`	Mensagem de resposta da operação de análise de fraude.	< 200 AN
`status`	Status da transação de análise de fraude do e-SiTef. Este campo pode assumir os seguintes valores: `NOV` – Nova. `EXP` – Expirada. `ACC` – Aceita `REJ` – Rejeitada `REV` – Em revisão `INV` – Inválida	= 3 AN
	schedule
`status`	Status do agendamento no e-SiTef. Saiba mais.	= 3 AN
`sid`	Identificador da transação de agendamento no e-SiTef.	= 64 AN
`schedule_usn`	Número sequencial único do agendamento no e-SiTef.	= 15 N
`authorizer_id`	Código da autorizadora a ser utilizada nos pagamentos agendados.	= 4 N
`amount`	Valor dos pagamentos agendados especificado pela loja (em centavos) na criação da transação.	< 12 N
`order_id`	Código de pedido enviado pela loja na criação da transação.	< 40 AN
`merchant_usn`	Número sequencial único enviado pela loja na criação da transação.	< 12 N
`initial_date`	Data de execução do primeiro pagamento agendado no formato `DD/MM/AAAA`.	= 10 D
`next_date`	Data de execução do próximo pagamento agendado no formato `DD/MM/AAAA`.	= 10 D
`number_of_times`	Número total de pagamentos agendados.	< 3 N
`current_times`	Número de pagamentos agendados já executados.	< 3 N
`installments`	Número de parcelas a ser utilizado nos pagamentos agendados.	< 2 N
`installment_type`	Tipo de financiamento a ser utilizado nos pagamentos agendados.	< 2 N
`soft_descriptor`	Texto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador.	< 30 AN
`show_times_invoice`	Para agendamentos por tempo finito, caso esse campo tenha valor `true` acrescenta ao final do campo `soft_descriptor` o número de execuções/total de execuções (exemplo: Assinatura 3/12).	< 5 T/F
`nits`	NITs dos últimos seis pagamentos agendados já executados.	= 64 AN[]
	cancellation
`authorizer_code`	Código de resposta do autorizador.	< 10 AN
`authorizer_message`	Mensagem de resposta do autorizador.	< 500 AN
`status`	Status da transação de cancelamento no e-SiTef. Saiba mais.	= 3 AN
`nit`	Número identificador da transação de cancelamento no e-SiTef.	= 64 AN
`order_id`	Código de pedido enviado pela loja na criação da transação.	< 40 AN
`merchant_usn`	Número sequencial único enviado pela loja na criação da transação.	< 12 N
`amount`	Valor do cancelamento especificado pela loja (em centavos).	< 12 N
`sitef_usn`	Número sequencial único da transação de cancelamento no SiTef.	= 6 N
`esitef_usn`	Número sequencial único da transação de cancelamento no e-SiTef.	= 15 N
`customer_receipt`	Cupom (via cliente).	< 4000 AN
`merchant_receipt`	Cupom (via estabelecimento).	< 4000 AN
`authorizer_id`	Código da autorizadora utilizada na transação.	< 4 N
`acquirer_id`	Código do adquirente utilizado na transação.	< 4 N
`acquirer_name`	Nome do adquirente utilizado na transação.	< 100 AN
`authorizer_date`	Data de efetivação do cancelamento retornada pelo autorizador no formato `DD/MM/AAAA'T'HH:mm`. Exemplo: 13/07/2017T16:03	= 16 D
`authorization_number`	Número de autorização.	< 6 AN
`host_usn`	NSU da autorizadora.	< 15 AN
`tid`	ID da transação no adquirente. Este campo só é retornado em transações com adquirentes externos ao SiTef.	< 40 AN
`esitef_date`	Data de efetivação do cancelamento no e-SiTef no formato `DD/MM/AAAA'T'HH:mm`. Exemplo: 13/07/2017T16:03	= 16 D
`issuer`	Código da bandeira retornado pelo autorizador.	< 5 AN
`authorizer_merchant_id`	Código de afiliação do lojista na autorizadora.	< 100 AN
`is_host_cancel`	Este campo retornará o valor `true` em caso de cancelamento via host.	< 5 T/F
`terminal_id`	Código do terminal utilizada na transação	< 8 AN

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.

Serviço de consulta de múltiplas transações

Estes serviços podem ser chamados para obter os dados de múltiplas transações para uma loja ou grupo da loja. É essencial o uso dessa operação em casos de erro de comunicação para verificar o status atual de transações, que podem ter sido efetuada ou não recebida pelo e-SiTef.

Atenção:

A consulta de transações no e-SiTef NÃO efetua uma consulta do status da transações 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 pagamento 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
Método HTTP: GET
Formato da requisição: query string
Formato da resposta: JSON
Parâmetros de cabeçalho:

Parâmetro	Descrição	Formato	Obrigatório
`merchant_id`	Código da loja no e-SiTef. Os códigos de produção e certificação serão diferentes.	< 15 AN	SIM
`merchant_key`	Chave de autenticação da loja no e-SiTef. As chaves de produção e certificação serão diferentes.	< 80 AN	SIM
`group_id`	Código do grupo de loja no e-SiTef. Caso seja enviado, será feito uma busca pelo grupo da loja. É necessário que o código da loja esteja dentro do grupo.	< 38 N	NÃO

Parâmetros de requisição:

Parâmetro	Descrição	Formato	Obrigatório
`start_date`	Data inicial das transações a serem listadas. Formato: `dd/MM/aaaa`	= 10 AN	SIM
`end_date`	Data final das transações a serem listadas. Período máximo: 5 dias (configurável). Formato: `dd/MM/aaaa`	= 10 AN	SIM
`status`	Filtro de status de transações. Ex.: "CON"	= 3 N	NÃO
`page`	Página da listagem. A primeira página tem valor "0". Caso não seja enviada, assumiremos o valor "0".	< 1000 N	NÃO
`limit`	Número máximo de registros por página. Caso não seja enviado, assumiremos o valor máximo 1000 de transações por vez (configurável).	< 4 N	NÃO
`payment_link`	Filtro para indicar a busca por transações de pagamento por link. Apenas ativo no caso de valor true	< 5 T/F	NÃO

Exemplos

Abaixo estão alguns exemplos de chamada dos serviços de consulta utilizando a ferramenta cURL.

Consulta de múltiplas transações

Requisição:

curl
--request GET "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions?start_date=25/11/2020&end_date=27/11/2020&status=CON&page=0&limit=50"
--header "merchant_id: xxxxxxxxxxxxxxx" 
--header "merchant_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
--header "group_id: 12345"
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "current_page":"0",
   "total_pages":"1",
   "count":"2",
   "transactions":[
      {
         "type":"P",
         "authorizer_code":"000",
         "authorizer_message":"Transacao OK",
         "status":"CON",
         "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
         "order_id":"13064421440",
         "customer_receipt":"==== CUPOM COMPRADOR ====",
         "merchant_receipt":"==== CUPOM ESTABELECIMENTO ====",
         "authorizer_id":"2",
         "acquirer_id":"1005",
         "acquirer_name":"Redecard",
         "authorizer_date":"13/07/2017T18:44",
         "authorization_number":"132048",
         "merchant_usn":"13064421441",
         "esitef_usn":"170713097341620",
         "sitef_usn":"132048",
         "host_usn":"999132048   ",
         "payment_date":"13/07/2017T18:44",
         "amount":"1000",
         "payment_type":"C",
         "issuer":"2",
         "authorizer_merchant_id":"000000000000005",
         "merchant_id": "xxxxxxxxxxxxxxx",
         "creation_date": "13/07/2017T18:43",
         "installments": "1"
      },
      {
         "type":"F",
         "authorizer_code":"000",
         "authorizer_message":"Transacao OK",
         "status":"CON",
         "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
         "order_id":"13064421440",
         "customer_receipt":"==== CUPOM COMPRADOR ====",
         "merchant_receipt":"==== CUPOM ESTABELECIMENTO ====",
         "authorizer_id":"2",
         "acquirer_id":"1005",
         "acquirer_name":"Redecard",
         "authorizer_date":"13/07/2017T18:44",
         "authorization_number":"132048",
         "merchant_usn":"13064421441",
         "esitef_usn":"170713097341620",
         "sitef_usn":"132048",
         "host_usn":"999132048   ",
         "payment_date":"13/07/2017T18:44",
         "amount":"1000",
         "payment_type":"C",
         "issuer":"2",
         "authorizer_merchant_id":"000000000000005",
         "merchant_id": "xxxxxxxxxxxxxxx",
         "creation_date": "13/07/2017T18:42",
         "installments": "3"
      }
   ]
}

Parâmetros de resposta

Parâmetro	Descrição	Formato
`code`	Código de resposta do e-SiTef. Qualquer código diferente de `0` significa falha. Saiba mais.	< 4 N
`message`	Mensagem de resposta do e-SiTef.	< 500 AN
`current_page`	Página atual dos registros.	< 4 N
`total_pages`	Número total de páginas.	< 4 N
`count`	Contagem total de registros.	< 4 N
transactions[]	Lista de transações encontradas para os filtros selecionados. Retornaremos apenas os campos em comum entre os vários tipos de transação, além do novo campo "type", que explicita qual é o tipo da transação.
`type`	Tipo da transação. `G = Captura de Pré-Autorização, A = Consulta AVS, E = Estorno, P = Pagamento, F = Pré-Autorização, R = Recarga`	< 1 A
`authorizer_code`	Código de resposta do autorizador.	< 10 AN
`authorizer_message`	Mensagem de resposta do autorizador.	< 500 AN
`status`	Status da transação de pagamento no e-SiTef. Saiba mais.	= 3 AN
`nit`	Identificador da transação de pagamento no e-SiTef.	= 64 AN
`merchant_id`	Código da loja no e-SiTef. Os códigos de produção e certificação serão diferentes.	< 15 AN
`order_id`	Código de pedido enviado pela loja na criação da transação.	< 40 AN
`merchant_usn`	Número sequencial único enviado pela loja na criação da transação.	< 12 N
`amount`	Valor da compra especificado pela loja (em centavos) na criação da transação.	< 12 N
`sitef_usn`	Número sequencial único da transação de pagamento no SiTef.	= 6 N
`esitef_usn`	Número sequencial único da transação de pagamento no e-SiTef.	= 15 N
`customer_receipt`	Cupom (via cliente).	< 4000 AN
`merchant_receipt`	Cupom (via estabelecimento).	< 4000 AN
`authorizer_id`	Código da autorizadora utilizada na transação.	< 4 N
`acquirer_id`	Código do adquirente utilizado na transação.	< 4 N
`acquirer_name`	Nome do adquirente utilizado na transação.	< 100 AN
`authorizer_date`	Data de efetivação do pagamento retornada pelo autorizador no formato `dd/MM/aaaa'T'HH:mm`. Exemplo: `13/07/2017T16:03`	= 16 D
`authorization_number`	Número de autorização.	< 6 AN
`host_usn`	NSU da autorizadora.	< 15 AN
`tid`	ID da transação no adquirente. Este campo só é retornado em transações com adquirentes externos ao SiTef.	< 40 AN
`payment_date`	Data de efetivação do pagamento no e-SiTef no formato `dd/MM/aaaa'T'HH:mm`. Exemplo: `13/07/2017T16:03`	= 16 D
`issuer`	Código da bandeira retornado pelo autorizador.	< 5 AN
`authorizer_merchant_id`	Código de afiliação do lojista na autorizadora.	< 100 AN
`payment_type`	Tipo do pagamento da autorizadora escolhida. Ex.: `C = Crédito, D = Débito`	< 1 A
`creation_date`	Data da criação da transação no e-SiTef, no formato `dd/MM/aaaa'T'HH:mm`. Exemplo: `13/07/2017T16:03`	= 16 D
`installments`	Número de parcelas da transação	< 2 N

Serviço de consulta de cartão

A partir de um NIT de pagamento com status NOV (novo), é possível realizar uma consulta do BIN do cartão (seis primeiros dígitos) no SiTef para obter dados sobre suas capacidades (possibilidade de pagamento parcelado, máximo de parcelas, exigência de código de segurança, etc.), ou ainda, saber qual autorizadora da loja é a mais adequada para a realização do pagamento.

No caso de transações com Visa Checkout, este serviço também retornará dados do cartão e do usuário retornados pelo Visa.

Fluxo

Consulta Cartão

Descrição do fluxo:

O lojista cria uma transação no e-SiTef passando informações como código da loja, número de parcelas e código de pedido e obtém como resposta um NIT (Número Identificador de Transação).
O lojista envia o NIT obtido na etapa anterior e os dados do cartão a ser consultado. Com isso, o e-SiTef retorna dados sobre as capacidades do cartão enviado.
A loja virtual prossegue então consumindo o serviço de efetivação do pagamento, passando o NIT e os dados do cartão do comprador. Em caso de sucesso, a transação de pagamento mudará seu status para CON (confirmada).

Detalhes da chamada

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

Parâmetro	Descrição	Formato	Obrigatório
`merchant_id`	Código da loja no e-SiTef. Os códigos de produção e certificação serão diferentes.	< 15 AN	SIM
`merchant_key`	Chave de autenticação da loja no e-SiTef. As chaves de produção e certificação serão diferentes.	< 80 AN	SIM
`Content-Type`	Deve ser enviado com o valor `application/json`.	= 15 AN	SIM

Obs.: apesar de se tratar de uma consulta, o método POST foi escolhido por questões de segurança.

Exemplos

Abaixo estão alguns exemplos de chamada do serviço de consulta de cartão utilizando a ferramenta cURL.

Consulta de cartão com envio de autorizadora

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "number":"5555555555555555"
   },
   "authorizer_id":"1"
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"NOV"
   },
   "card":{
      "acquirer_name":"Redecard",
      "authorizer_id":"1",
      "authorizer_response_code":"000",
      "is_customer_id_required":"false",
      "is_expiry_date_required":"true",
      "is_installment_funding_enabled":"true",
      "is_security_code_required":"true",
      "is_spot_sale_enabled":"true",
      "is_with_interest_sale_enabled":"true",
      "is_without_interest_sale_enabled":"true",
      "max_installments_with_interest":"12",
      "min_installments_with_interest":"01",
      "prefixes":{
         "TRAT":"2",
         "PERIFERICO":"1",
         "CSEG":"2"
      }
   }
}

Consulta de cartão sem envio de autorizadora

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "number":"6543210987654321"
   }
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"NOV"
   },
   "card":{
      "acquirer_name":"Redecard",
      "authorizer_id":"1",
      "authorizer_response_code":"000",
      "is_customer_id_required":"false",
      "is_expiry_date_required":"true",
      "is_installment_funding_enabled":"true",
      "is_security_code_required":"true",
      "is_spot_sale_enabled":"true",
      "is_with_interest_sale_enabled":"true",
      "is_without_interest_sale_enabled":"true",
      "max_installments_with_interest":"12",
      "min_installments_with_interest":"01",
      "prefixes":{
         "TRAT":"2",
         "PERIFERICO":"1",
         "CSEG":"2"
      }
   }
}

Consulta de cartão Visa Checkout

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "wallet_transaction_id":"4444444444444444444"
   },
   "authorizer_id":"406"
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"NOV"
   },
   "card":{
      "acquirer_name":"Redecard",
      "authorizer_id":"406",
      "authorizer_response_code":"000",
      "is_customer_id_required":"false",
      "is_expiry_date_required":"true",
      "is_installment_funding_enabled":"true",
      "is_security_code_required":"true",
      "is_spot_sale_enabled":"true",
      "is_with_interest_sale_enabled":"true",
      "is_without_interest_sale_enabled":"true",
      "max_installments_with_interest":"12",
      "min_installments_with_interest":"01",
      "prefixes":{
         "TRAT":"2",
         "PERIFERICO":"1"
      },
      "visa_checkout_data":{
         "payment_request":{
            "currency_code":"BRL",
            "subtotal":"115.5",
            "total":"115.5",
            "order_id":"09387",
            "source_id":"LOJAVISACHECK"
         },
         "user_data":{
            "user_first_name":"Comprador",
            "user_last_name":"Esitef",
            "user_full_name":"Comprador Esitef",
            "user_name":"esitef2@gmail.com",
            "user_email":"esitef2@gmail.com",
            "enc_user_id":"c5DmPXTXC3VwZywsFESEGAqiLM5PXSZG7hgyQgRv0j8=",
            "user_personal_id":"12345678909"
         },
         "creation_time_stamp":1502206049403,
         "payment_instrument":{
            "id":"AWUU0/rQrmKCMx+C740kBefZP2GNsdAMYUTXAzCPk+M=",
            "last_four_digits":"1010",
            "bin_six_digits":"406897",
            "verification_status":"VERIFIED",
            "expired":"false",
            "issuer_bid":"10029901",
            "nick_name":"Cartão PAN",
            "name_on_card":"aaaaaaaaaa vvvvvvvvvv",
            "card_first_name":"aaaaaaaaaa",
            "card_last_name":"vvvvvvvvvv",
            "payment_type":{
               "card_brand":"VISA",
               "card_type":"CREDIT"
            },
            "billing_address":{
               "person_name":"aaaaaaaaaa vvvvvvvvvv",
               "first_name":"aaaaaaaaaa",
               "last_name":"vvvvvvvvvv",
               "line1":"qqqqqqqqqq",
               "line2":"eeeeee",
               "line3":"wwwwwwwww",
               "city":"cccccccc",
               "state_province_code":"SP",
               "postal_code":"01238010",
               "country_code":"BR",
               "phone":"987654321",
               "default":"false"
            },
            "card_arts":{
               "card_art":[
                  {
                     "base_image_file_name":"https://sandbox.secure.checkout.visa.com/VmeCardArts/lg_visa_card.png",
                     "height":105,
                     "width":164
                  }
               ]
            },
            "expiration_date":{
               "month":"11",
               "year":"2022"
            }
         },
         "risk_data":{
            "advice":"UNAVAILABLE",
            "score":0,
            "avs_response_code":"0",
            "cvv_response_code":"0",
            "age_of_account":"704"
         },
         "visa_checkout_guest":"false"
      }
   }
}

Consulta de cartão com planos de financiamento

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "number":"6543210987654321"
   },
   "authorizer_id":"313"
}
--verbose

Resposta:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "payment": {
        "status": "NOV"
    },
    "card": {
        "acquirer_name": "Via Certa Financiadora",
        "authorizer_id": "313",
        "authorizer_response_code": "000",
        "is_customer_id_required": "false",
        "is_expiry_date_required": "true",
        "is_installment_funding_enabled": "true",
        "is_security_code_required": "true",
        "is_spot_sale_enabled": "true",
        "is_with_interest_sale_enabled": "true",
        "is_without_interest_sale_enabled": "true",
        "max_installments_with_interest": "99",
        "min_installments_with_interest": "00",
        "prefixes": {
            "CADSENHA": "11",
            "NPSAQ": "0199",
            "ECHO": "MIG3DH00000"
        },
        "financing_plan_list": [
            {
                "cod_plano": "0201",
                "tipo_plano": "02",
                "desc_plano": "Plano de Teste para CDC 01                        ",
                "parc_plano": "99"
            },
            {
                "cod_plano": "0301",
                "tipo_plano": "03",
                "desc_plano": "Plano de Teste para Saque e CDC 01                ",
                "parc_plano": "99"
            },
            {
                "cod_plano": "0201",
                "tipo_plano": "02",
                "desc_plano": "Plano de Teste para CDC 01                        ",
                "parc_plano": "99"
            },
            {
                "cod_plano": "0202",
                "tipo_plano": "02",
                "desc_plano": "Plano de Teste para CDC 02                        ",
                "parc_plano": "99"
            },
            {
                "cod_plano": "0301",
                "tipo_plano": "03",
                "desc_plano": "Plano de Teste para Saque e CDC 01                ",
                "parc_plano": "99"
            },
            {
                "cod_plano": "0302",
                "tipo_plano": "03",
                "desc_plano": "Plano de Teste para Saque e CDC 02                ",
                "parc_plano": "99"
            },
            {
                "cod_plano": "0303",
                "tipo_plano": "03",
                "desc_plano": "Plano de Teste para Saque e CDC 03                ",
                "parc_plano": "99"
            }
        ]
    }
}

Consulta de cartão com dados adicionais para roteamento iCards via SiTef

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "number":"6543210987654321"
   },
   "authorizer_id":"38"
}
--verbose

Resposta:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "card": {
        "acquirer_name": "iCards",
        "authorizer_id": "38",
        "authorizer_response_code": "000",
        "is_customer_id_required": "true",
        "is_expiry_date_required": "true",
        "is_installment_funding_enabled": "true",
        "is_security_code_required": "true",
        "is_spot_sale_enabled": "true",
        "is_with_interest_sale_enabled": "true",
        "is_without_interest_sale_enabled": "true",
        "max_installments_with_interest": "12",
        "min_installments_with_interest": "01",
        "prefixes": {
            "NPSAQ": "0299",
            "CAPTPPRE": "1",
            "XCAPPREAUT": "11"
        },
        "is_customer_postal_code_required": "true",
        "is_card_holder_required": "true"
    },
    "payment": {
        "status": "NOV"
    }
}

Consulta de cartão com dados adicionais para roteamento IPG

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
  "card":{
    "number":"4036952187654321"
  },
  "routing_id":"414"
}
--verbose

Resposta:

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "payment": {
    "status": "NOV"
  },
  "details": [
    {
      "brand": "VISA",
      "brand_product_id": "VI",
      "card_function": "CREDIT",
      "issuer_country": "USA",
      "issuer_name": "Simulation"
    },
    {
      "brand": "VISA",
      "brand_product_id": "VI",
      "card_function": "DEBIT",
      "issuer_country": "BRA",
      "issuer_name": "Simulation"
    }
  ]
}

Parâmetros de requisição

Na tabela abaixo está a descrição dos parâmetros de requisição do serviço de consulta de cartão:

Parâmetro	Descrição	Formato	Obrigatório
`authorizer_id`	Código da autorizadora no e-SiTef. Saiba mais. Este campo só é obrigatório caso o campo `wallet_transaction_id` seja enviado. Se esse campo não é enviado, o e-SiTef assume que se trata de um cartão de crédito	< 3 N	COND.
`routing_id`	Código do roteamento no e-SiTef. Este campo só é obrigatório para obter dados adicionais pela IPG.	< 3 N	COND.
	card
`number`	Número do cartão do comprador (PAN).	< 19 N	SIM
`token`	HASH de um cartão armazenado no e-SiTef. Não é permitido enviar um número de cartão aberto (campo `number`) e um cartão armazenado (campo `token`) na mesma requisição.	= 88 AN	NÃO
`wallet_transaction_id`	ID de uma transação de carteiras digitais. Por enquanto, essa funcionalidade está disponível apenas para a autorizadora Visa Checkout (`authorizer_id`:`406`). Não é permitido enviar um número de cartão aberto (campo `number`), um cartão armazenado (campo `token`) e um `wallet_transaction_id` na mesma requisição.	< 25 AN	NÃO
`do_par_inquiry`	Informa se a chamada para o VISA PAR Inquiry será realizada. O Valor resposta será retornado no campo `par` do do retorno da chamada. Valores permitidos: `true` - Requisição de PAR será realizada `false` - Requisição de PAR não será realizada. Valor default: `false`	< 5 A	NÃO

Parâmetros de resposta

Parâmetro	Descrição	Formato
`code`	Código de resposta do e-SiTef. Qualquer código diferente de `0` significa falha. Saiba mais.	< 4 N
`message`	Mensagem de resposta do e-SiTef.	< 500 AN
	payment
`status`	Status da transação de pagamento no e-SiTef. Saiba mais.	= 3 AN
	card
`authorizer_code`	Código de resposta do autorizador.	< 10 AN
`authorizer_message`	Mensagem de resposta do autorizador.	< 500 AN
`acquirer_name`	Nome do roteamento. Ex.: Cielo	< 256 AN
`authorizer_id`	Código da autorizadora (utilizar este ID ao realizar o pagamento).	< 3 N
`is_customer_id_required`	Indica a obrigatoriedade da coleta do documento do cliente.	< 5 T/F
`is_expiry_date_required`	Indica a obrigatoriedade da coleta da data de validade do cartão do comprador.	< 5 T/F
`is_installment_funding_enabled`	Indica se o parcelamento está habilitado.	< 5 T/F
`is_security_code_required`	Indica a obrigatoriedade da coleta do código de segurança.	< 5 T/F
`is_spot_sale_enabled`	Indica se o pagamento à vista está habilitado.	< 5 T/F
`is_with_interest_sale_enabled`	Indica se o pagamento com juros está habilitado.	< 5 T/F
`is_without_interest_sale_enabled`	Indica se o pagamento sem juros está habilitado.	< 5 T/F
`max_installments_with_interest`	Parcelamento máximo com juros.	< 2 N
`min_installments_with_interest`	Parcelamento mínimo com juros.	< 2 N
`visa_checkout_data`	Objeto com os dados retornados pela Visa Checkout.	O
`financing_plan_list`	Objeto que consiste em um array de planos de financiamento apresentados em roteamento Via Certa Financiadora. Um plano de financiamento consiste dos seguintes campos: `cod_plano`: código de identificação do plano de financiamento, que deve ser enviado no momento da efetivação do pagamento; `tipo_plano`: código do tipo do plano de financiamento; `desc_plano`: descrição do plano, que pode ser apresentado ao comprador; `parc_plano`: número máximo de parcelas possíveis para o plano.	O
`is_customer_postal_code_required`	Indica a obrigatoriedade da coleta do código postal do usuário (CEP no Brasil).	< 5 T/F
`par`	Valor do PAR retornado pela VISA caso o campo `do_par_inquiry` seja enviado com o valor `true` na requisição.	< 32 AN
card.prefixes[]	Este campo contém os prefixos (dados adicionais) retornados pelo SiTef.
key	Nome do prefixo.	< 1024 AN
value	Valor do prefixo.	< 1024 AN
details[]	Este campo contém detalhamentos retornados pelo roteamento IPG
brand	A bandeira do cartão. The card brand.	< 1024 AN
brand_product_id	ID de produto da bandeira do cartão. The product ID of the brand.	< 1024 AN
card_function	Função do cartão. Card function.	CREDIT, DEBIT, PREPAID, VOUCHER, UNDEFINED
commercialCard	Indica se o cartao é corporativo ou nao-corporativo. Indicates whether it is a corporate or non-corporate card.	CORPORATE, NON_CORPORATE
issuer_country	O país da emissora do cartão. The country of the issuer.	< 1024 AN
issuer_name	O nome da emissora do cartão. The name of the issuer.	< 1024 AN

Roteamentos que permitem consulta de cartão.

Cód.	Roteamento	Possui consulta de cartão
1004	VisaNet via SiTef (rede:4)
1005	Redecard via SiTef (rede:5)
1018	Standby (Excard) via SiTef (rede:18)
1019	Edmcard via SiTef (rede:19)
1021	Vero via SiTef (rede:21)
1026	CCCWeb (Master/Visa/Amex) via SiTef (rede:26)
1029	Softway via SiTef (rede:29)
1030	Multicheque via SiTef (rede:30)
70	Ticket via SiTef (rede:41)
430	Senff via SiTef (rede:43)
1045	Coopercred via SiTef (rede:45)
1047	Sorocred via SiTef (rede:47)
1051	Hipercard via SiTef (rede:51)
1052	Tricard via SiTef (rede:52)
1054	Policard via SiTef (rede:54)
1057	CCC (Master/Visa) via SiTef (rede:57)
1059	Telenet via SiTef (rede:59)
1061	Brasilcard via SiTef (rede:61)
1064	CCC (Amex) via SiTef (rede:64)
1068	Banese via SiTef (rede:68)
1072	Bigcard via SiTef (rede:72)
1077	Valecard via SiTef (rede:77)
1081	Supercard via SiTef (rede:81)
1182	GetNet via SiTef (rede:82)
1086	Marisa via SiTef (rede:86)
1087	Maxicred via SiTef (rede:87)
1089	Expansiva via SiTef (rede:89)
1091	Leader II via SiTef (rede:91)
1093	Cetelem via SiTef (rede:93)
1094	Cabal via SiTef (rede:94)
1095	Credsystem via SiTef (rede:95)
1096	BBVA via SiTef (rede:96)
1102	Check Check (Smart Shop) via SiTef (rede:102)
1103	Dacasa via SiTef (rede:103)
1104	Bradesco Private Label via SiTef (rede:104)
1105	Platinum (Credimais) via SiTef (rede:105)
1111	Tredenexx via SiTef (rede:111)
1113	Credishop via SiTef (rede:113)
1115	IBI via SiTef (rede:115)
1118	Oboe via SiTef (rede:118)
1121	Hot Card via SiTef (rede:121)
1122	PAN via SiTef (rede:122)
1125	Cielo via SiTef (rede:125)
1127	Marisa Cartao Presente via SiTef (rede:127)
1128	Cooplife via SiTef (rede:128)
1129	BOD via SiTef (rede:129)
1144	Accredito (ACSP) via SiTef (rede:144)
1149	Fidelidade Mais via SiTef (rede:149)
160	Orbitall via SiTef (rede:160)
1161	iCards via SiTef (rede:161)
1165	Banco Ge (Tivit) via SiTef (rede:165)
1169	Banescard via SiTef (rede:169)
1181	GetNet Lac via SiTef (rede:181)
1187	Sicredi - nao usar, usar o bin via SiTef (rede:187)
1192	AVISTA via SiTef (rede:192)
1193	Algorix via SiTef (rede:193)
1194	Amex EMV via SiTef (rede:194)
1006	Amex EMV via SiTef (rede:194)
1201	SmartNet via SiTef (rede:201)
1203	Peela via SiTef (rede:203)
1206	GlobalPayments via SiTef (rede:206)
1207	Elavon via SiTef (rede:207)
218	Hug via SiTef (rede:218)
225	Fidelity via SiTef (rede:225)
1229	Bin via SiTef (rede:229)
1236	Conductor via SiTef (rede:236)
1249	Riachuelo PL via SiTef (rede:249)
1257	Bradescard via SiTef (rede:257)
1265	Stone via SiTef (rede:265)
1266	DM Card via SiTef (rede:266)
1271	CardSE via SiTef (rede:271)
1279	Sodexo via SiTef (rede:279)
1280	Kredilig via SiTef (rede:280)
1283	ConductorDUP via SiTef (rede:283)
1296	Safra via SiTef (rede:296)
1297	Rede Ticket via SiTef (rede:297)
1303	SiPag via SiTef (rede:303)
1309	ADIQ via SiTef (rede:309)
1313	Via Certa Financiadora via SiTef (rede:313)

Serviço de efetivação de pagamento com múltiplos meios de pagamento

Após consumir o serviço de criação de transação e obter um NIT, é possível prosseguir para a próxima etapa do fluxo: a chamada ao serviço de efetivação de pagamento.

Isso pode ser feito informando apenas um meio de pagamento (veja o documento "Serviço de efetivação de pagamento") ou 2 (dois) meios de pagamento.

Neste capítulo, trataremos dos pagamentos que são feitos com 2 (dois) meios de pagamento, o qual chamamos de Pagamento com múltiplos meios de pagamento.

Para usar esta funcionalidade, entre em contato com o nosso suporte e solicite a ativação da mesma em sua loja.

Fluxo

O fluxo de um pagamento com múltiplos meios de pagamento possui diferenças importantes quando o comparamos com o pagamento tradicional.

A primeira diferença é que temos duas transações para uma mesma chamada e cada uma delas é usada para efetuar o pagamento de um dos meios de pagamento informados. A primeira transação é criada na chamada de criação de transação no e-SiTef e a segunda transação é criada indiretamente na chamada de pagamento com múltiplos meios de pagamento.

A segunda diferença é que, por causa disso, alguns dados da primeira transação são modificados durante a efetivação do pagamento. Inicialmente, a primeira transação possui o valor total da compra, as parcelas e o tipo de financiamento próprios. Quando a chamada de pagamento com múltiplos pagamentos é feita, seu valor é alterado para ser igual ao do primeiro meio de pagamento e o mesmo ocorre com as parcelas e o tipo de financiamento, caso estes sejam informados na requisição. Já a segunda transação terá o valor, as parcelas e o tipo de financiamento informados pelo segundo meio de pagamento. Mas, no caso da segunda transação não informar dados de parcelamento e tipo de financiamento, ela herdará essas configurações da primeira transação original. A soma dos valores da primeira e da segunda transações deve ser igual ao valor informado na criação da primeira transação no e-SiTef.

A terceira diferença é que a resposta de múltiplos pagamentos é composta pelas respostas de cada uma das transações. Sendo assim, haverá situações em que a resposta de uma transação afetará a resposta da outra.

A seguir, iremos abordar os cenários previstos no e-SiTef com mais detalhes.

Fluxo de pagamento com confirmação automática

O fluxo de pagamento com confirmação automática nos pagamentos com múltiplos meios de pagamentos possui uma peculiaridade que é dividir o pagamento em 3 (três) etapas: atualização/inicialização das transações; pagamentos; confirmações.

Em caso de falha em qualquer uma das transações, o e-SiTef não prossegue para a etapa seguinte e faz tratamentos que serão explicados a seguir nos casos de falhas.

Caso de sucesso

Caso de falha no pagamento da primeira transação

Quando o primeiro pagamento falha, a segunda transação será cancelada e não será disparada para a Autorizadora. Uma ocorrência é gerada para a equipe de suporte do e-SiTef e o lojista, caso deseje, pode entrar em contato.