e-SiTef

e-SiTef

  • Portal do Desenvolvedor
  • Fale Conosco
  • English

›Pagamento REST

Pagamento REST

  • Visão Geral
  • Quick start
  • Serviço de criação da transação
  • Serviço de efetivação de pagamento
  • Serviço de confirmação de pagamento
  • Serviço de consulta de transação
  • Serviço de consulta de múltiplas transações
  • Serviço de consulta de cartão
  • Serviço de efetivação de pagamento com múltiplos meios de pagamento
  • Serviço de confirmação de pagamento com múltiplos meios de pagamento
  • Serviço de confirmação de pagamento de origem externa

Armazenamento REST

  • Visão Geral

Cancelamento REST

  • Fluxo
  • Quick start
  • Cancelamento via host
  • Cancelamento origem externa
  • Serviço de criação de cancelamento
  • Serviço de cancelamento

Pré-autorização REST

  • Visão Geral
  • Quick start
  • Serviço de Criação de Pré-Autorização
  • Serviço de Efetivação de Pré-Autorização
  • Serviço de Consulta de Pré-Autorização
  • Serviço de Consulta de Cartões
  • Serviço de Edição de Pré-Autorização
  • Serviço de Edição de Pré-Autorização de Origem Externa
  • Serviço de Incremento de Pré-Autorização
  • Serviço de Captura de Pré-Autorização
  • Serviço Captura de Pré autorização com origem externa

Agendamento de Recorrência REST

  • Visão Geral
  • Quick start
  • Serviço de criação da transação
  • Serviço de ativação de agendamento
  • Execução dos pagamentos agendados
  • Fluxo de edição de agendamento
  • Quick start: edição de agendamento
  • Serviço de criação de edição de agendamento
  • Serviço de edição de agendamento

Recarga REST

  • Visão Geral
  • Quick start
  • Serviço de criação de recarga
  • Serviço de listagem de concessionárias
  • Serviço de listagem de dados da filial
  • Serviço de efetivação de recarga
  • Serviço de confirmação de recarga
  • Serviço de consulta de recarga

Pagamento HTML

  • Visão Geral
  • Quick start
  • Iniciando uma transação de pagamento
  • Aviso de Status
  • Serviço de consulta de transação HTML
  • Pagamento com armazenamento de cartão
  • Customização de Páginas
  • Pagamento com Link
  • Pagamento Split
  • Pagamento com múltiplos meios de pagamento
  • Integração 3DS 2.0

Pré-Autorização HTML

  • Visão Geral

Recarga HTML

  • Visão Geral
  • Quick start
  • Iniciando uma transação de recarga

Operações Genéricas REST

  • Visão geral
  • Serviço de geração de token
  • Serviço de operação genérica

Pagamento JavaScript

  • Visão Geral
  • Quick start
  • Serviço de criação da transação
  • Página de pagamento da loja virtual
  • Serviço de consulta de transação

Armazenamento JavaScript

  • Visão Geral
  • Quick start
  • Serviço de criação da transação
  • Página da loja virtual

Portal do Lojista

  • Introdução
  • Acesso ao Portal
  • Autenticação em duas etapas
  • Configurações do usuário
  • Configurar Autorizadoras
  • Relatório de Transações
  • Relatório de Resumo Diário
  • Relatório de Armazenamentos
  • Relatório de Recargas
  • Relatório Analítico
  • Cancelamento de Transações
  • Agendamentos de Recorrência
  • Configurar Análise de Risco
  • Configurar Ordenação de Autorizadoras
  • Administração de Usuários
  • Geração de link de pagamento

Portal do Lojista (POS)

  • Visão Geral
  • Configuração do POS Virtual
  • Pagamento via POS Virtual
  • Relatório de Transações POS

Portal do Lojista (Recarga POS)

  • Visão Geral
  • Recarga via POS Virtual

Retentativa

  • Visão Geral
  • Fluxos
  • Retentativa e Agendamento de Recorrência
  • Retentativa e códigos de retornos permitidos

Roteamentos via SiTef

  • Bradescard
  • Cetelem
  • GetnetLac
  • Orbitall
  • Vero
  • Bin
  • Sipag

Roteamentos Não-SiTef

  • Banco do Brasil
  • Banrisul Vero
  • Cielo e-Commerce
  • EPX
  • e.Rede REST
  • Fepas HUB
  • Getnet WS
  • GlobalPayments WS
  • IPG
  • Itaú Shopline
  • Mercado Pago
  • PagSeguro
  • PayPal
  • SafraPay
  • Stone WS

Auxílio Emergencial

  • Auxílio Emergencial

Carteira digital

  • Visão Geral
  • Carteira Digital VEE via CardSE
  • Pix via CardSE
  • Google Pay
  • Visa Checkout
  • Masterpass
  • Samsung Pay
  • Apple Pay
  • Configurações para Carteiras Digitais

Integração com antifraude

  • Visão Geral
  • Serviço de análise de risco na Interface HTML
  • Retorno da análise de risco
  • Fluxo de Revisao Manual
  • Serviço de marcação de fraude
  • ClearSale
  • CyberSource
  • Konduto
  • Fraud Detect

Informações Gerais

  • Autorizadoras
  • Certificados Digitais
  • Códigos da API
  • Soft Descriptor
  • Autenticação com assinatura

Cadastros em Lote

  • Cadastros de Lojas em Lote
  • Configuração de Roteamento em Lote

Cadastro de Lojas REST

  • Visão Geral
  • Quick start
  • Serviço de criação de token
  • Serviço de criação de loja
  • Serviço de edição de loja
  • Serviço de consulta de loja
  • Serviço de consulta de status loja
  • Serviço de listagem de lojas
  • Códigos da API

3DS Server

  • Visão Geral
  • Quick start
  • Serviço de criação de transação
  • Serviço de autenticação
  • Serviço de consulta de transação
  • Mensagens de desafio
  • Notificação decoupled
  • Iniciando um 3DS Method
  • Códigos da API

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.

Exemplo de resposta
{
    "code": "1013",
    "message": "Error processing multiple payment methods",
    "payments": [
        {
            "authorizer_code": "014",
            "authorizer_message": "14 Cartao Inval.",
            "status": "NEG",
            "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
            "order_id": "1609964926966",
            "authorizer_id": "1",
            "acquirer_id": "5",
            "acquirer_name": "Redecard",
            "authorizer_date": "06/01/2021T17:28",
            "authorization_number": "080384",
            "merchant_usn": "16114726760",
            "esitef_usn": "210106064204400",
            "sitef_usn": "606060",
            "host_usn": "707070",
            "amount": "1254785",
            "payment_type": "C",
            "issuer": "1",
            "authorizer_merchant_id": "00000005",
            "terminal_id": "ES000036"
        },
        {
            "status": "CAN"
        }
    ]
}

Caso de falha no pagamento da segunda transação

Quando o segundo pagamento falha, a primeira transação será desfeita. Uma ocorrência é gerada para a equipe de suporte do e-SiTef e o lojista, caso deseje, pode entrar em contato.

Exemplo de resposta
{
    "code": "1013",
    "message": "Error processing multiple payment methods",
    "payments": [
        {
            "authorizer_code": "000",
            "authorizer_message": "Transacao Aprov.",
            "status": "PPN",
            "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
            "order_id": "25053142469",
            "customer_receipt":"====CUPOM COMPRADOR====",
            "merchant_receipt":"====CUPOM ESTABELECIMENTO====",
            "authorizer_id": "1",
            "acquirer_id": "5",
            "acquirer_name": "Redecard",
            "authorizer_date": "25/03/2020T17:31",
            "authorization_number": "252490",
            "merchant_usn": "25053142469",
            "esitef_usn": "200325048537130",
            "sitef_usn": "252490",
            "host_usn": "999252490   ",
            "amount": "100",
            "payment_type": "C",
            "issuer": "1",
            "authorizer_merchant_id": "000000000000005",
            "payment_date": "25/03/2020T17:31"
        },
        {
            "authorizer_code": "255",
            "authorizer_message": "(2)Cartao invalido",
            "status": "NEG",
            "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
            "order_id": "25053142469",
            "authorizer_id": "2",
            "acquirer_name": "REDE",
            "merchant_usn": "25053142469",
            "esitef_usn": "200325048537140"
        }
    ]
}

Caso de falha na confirmação da primeira transação

Quando a primeira confirmação falha, a segunda transação será desfeita. Uma ocorrência é gerada para a equipe de suporte do e-SiTef e o lojista, caso deseje, pode entrar em contato.

Exemplo de resposta
{
    "code": "1013",
    "message": "Error processing multiple payment methods",
    "payments": [
        {
            "authorizer_code": "200",
            "authorizer_message": "Success. [Cód.: 00]",
            "status": "PEN",
            "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
            "order_id": "1609965604696",
            "customer_receipt":"====CUPOM COMPRADOR====",
            "merchant_receipt":"====CUPOM ESTABELECIMENTO====",
            "authorizer_id": "2",
            "acquirer_id": "202",
            "acquirer_name": "e.Rede REST",
            "authorizer_date": "06/01/2021T17:40",
            "authorization_number": "177013",
            "merchant_usn": "16114726760",
            "esitef_usn": "210106064204470",
            "host_usn": "304123216",
            "tid": "210106064204470",
            "amount": "47",
            "payment_type": "C",
            "payment_date": "06/01/2021T17:40"
        },
        {
            "authorizer_code": "200",
            "authorizer_message": "Success. [Cód.: 00]",
            "status": "PPN",
            "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
            "order_id": "1609965604696",
            "customer_receipt":"====CUPOM COMPRADOR====",
            "merchant_receipt":"====CUPOM ESTABELECIMENTO====",
            "authorizer_id": "2",
            "acquirer_id": "202",
            "acquirer_name": "e.Rede REST",
            "authorizer_date": "06/01/2021T17:40",
            "authorization_number": "962291",
            "merchant_usn": "16114726760",
            "esitef_usn": "210106064204480",
            "host_usn": "487097429",
            "tid": "210106064204480",
            "amount": "510",
            "payment_type": "C",
            "payment_date": "06/01/2021T17:40"
        }
    ]
}

Caso de falha na confirmação da segunda transação

Quando a segunda confirmação falha, a primeira transação já está confirmada e o cancelamento, caso seja desejado, deve ser feito manualmente, seja usando o cancelamento REST ou o Portal do Lojista. Uma ocorrência é gerada para a equipe de suporte do e-SiTef e o lojista, caso deseje, pode entrar em contato.

Exemplo de resposta
{
    "code": "1013",
    "message": "Error processing multiple payment methods",
    "payments": [
        {
            "authorizer_code": "200",
            "authorizer_message": "Function performed error-free [Cód.: 00]",
            "status": "CON",
            "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
            "order_id": "20030404545",
            "customer_receipt":"====CUPOM COMPRADOR====",
            "merchant_receipt":"====CUPOM ESTABELECIMENTO====",
            "authorizer_id": "2",
            "acquirer_id": "414",
            "acquirer_name": "IPG",
            "authorizer_date": "25/03/2020T17:48",
            "authorization_number": "488040",
            "merchant_usn": "20030404545",
            "esitef_usn": "200325048537190",
            "host_usn": "572994560",
            "tid": "SIM64194442",
            "amount": "102",
            "payment_type": "C",
            "payment_date": "25/03/2020T17:48"
        },
        {
            "authorizer_code": "200",
            "authorizer_message": "Function performed error-free [Cód.: 00]",
            "status": "PEN",
            "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
            "order_id": "20030404545",
            "customer_receipt":"====CUPOM COMPRADOR====",
            "merchant_receipt":"====CUPOM ESTABELECIMENTO====",
            "authorizer_id": "2",
            "acquirer_id": "414",
            "acquirer_name": "IPG",
            "authorizer_date": "25/03/2020T17:48",
            "authorization_number": "454463",
            "merchant_usn": "20030404545",
            "esitef_usn": "200325048537200",
            "host_usn": "108829897",
            "tid": "SIM45823552",
            "amount": "103",
            "payment_type": "C",
            "payment_date": "25/03/2020T17:48"
        }
    ]
}

Fluxo de pagamento com confirmação tardia

O fluxo de pagamento com confirmação tardia nos pagamentos com múltiplos meios de pagamentos possui uma peculiaridade que é dividir o pagamento em 2 (duas) fases: atualização/inicialização das transações; pagamentos.

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.

Exemplo de resposta
{
    "code": "1013",
    "message": "Error processing multiple payment methods",
    "payments": [
        {
            "authorizer_code": "19",
            "authorizer_message": "19 Refaca Trans.",
            "status": "NEG",
            "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
            "order_id": "25052428543",
            "authorizer_id": "1",
            "acquirer_id": "5",
            "acquirer_name": "Redecard",
            "authorizer_date": "25/03/2020T17:24",
            "authorization_number": "080384",
            "merchant_usn": "25052428543",
            "esitef_usn": "200325048537090",
            "sitef_usn": "606060",
            "host_usn": "707070",
            "amount": "1254784",
            "payment_type": "C",
            "issuer": "1",
            "authorizer_merchant_id": "00000005"
        },
        {
            "status": "CAN"
        }
    ]
}

Caso de falha no pagamento da segunda transação

Quando o segundo pagamento falha, a primeira transação será desfeita.

Exemplo de resposta
{
    "code": "1013",
    "message": "Error processing multiple payment methods",
    "payments": [
        {
            "authorizer_code": "000",
            "authorizer_message": "Transacao Aprov.",
            "status": "PPN",
            "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
            "order_id": "25053142469",
            "customer_receipt":"====CUPOM COMPRADOR====",
            "merchant_receipt":"====CUPOM ESTABELECIMENTO====",
            "authorizer_id": "1",
            "acquirer_id": "5",
            "acquirer_name": "Redecard",
            "authorizer_date": "25/03/2020T17:31",
            "authorization_number": "252490",
            "merchant_usn": "25053142469",
            "esitef_usn": "200325048537130",
            "sitef_usn": "252490",
            "host_usn": "999252490   ",
            "amount": "100",
            "payment_type": "C",
            "issuer": "1",
            "authorizer_merchant_id": "000000000000005",
            "payment_date": "25/03/2020T17:31"
        },
        {
            "authorizer_code": "255",
            "authorizer_message": "(2)Cartao invalido",
            "status": "NEG",
            "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
            "order_id": "25053142469",
            "authorizer_id": "2",
            "acquirer_name": "REDE",
            "merchant_usn": "25053142469",
            "esitef_usn": "200325048537140"
        }
    ]
}

Detalhes da chamada

  • Recurso: /v1/payments/multiple/{nit}
  • Método HTTP: POST
  • Formato da requisição: JSON
  • Formato da resposta: JSON
  • Parâmetros de cabeçalho:
ParâmetroDescriçãoFormatoObrigatório
merchant_idCódigo da loja no e-SiTef. Os códigos de produção e certificação serão diferentes.< 15 ANSIM
merchant_keyChave de autenticação da loja no e-SiTef. As chaves de produção e certificação serão diferentes.< 80 ANSIM
Content-TypeDeve ser enviado com o valor application/json.= 15 ANSIM

Exemplos

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

Pagamento

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/multiple/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
    "multiple_payment_methods": [
        {
            "number": "45518201234512345",
            "expiry_date": "1222",
            "security_code": "123",
            "authorizer_id": "218",
            "installments": "1",
            "installment_type": "4",
            "amount": "512"
        },
        {
            "number": "45518201234512345",
            "expiry_date": "1222",
            "security_code": "123",
            "authorizer_id": "218",
            "installments": "1",
            "installment_type": "4",
            "amount": "510"
        }
    ]
}
--verbose

Resposta:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "payments": [
        {
            "authorizer_code": "000",
            "authorizer_message": "Transacao Aprov.",
            "status": "PPC",
            "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
            "order_id": "20125445982",
            "customer_receipt":"====CUPOM COMPRADOR====",
            "merchant_receipt":"====CUPOM ESTABELECIMENTO====",
            "authorizer_id": "1",
            "acquirer_id": "5",
            "acquirer_name": "Redecard",
            "authorizer_date": "20/03/2020T14:32",
            "authorization_number": "202650",
            "merchant_usn": "16013439434",
            "esitef_usn": "200320048363850",
            "sitef_usn": "202650",
            "host_usn": "999202650   ",
            "amount": "512",
            "payment_type": "C",
            "issuer": "1",
            "authorizer_merchant_id": "000000000000005",
            "payment_date": "20/03/2020T14:32"
        },
        {
            "authorizer_code": "000",
            "authorizer_message": "Transacao Aprov.",
            "status": "PPC",
            "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
            "order_id": "20125445982",
            "customer_receipt":"====CUPOM COMPRADOR====",
            "merchant_receipt":"====CUPOM ESTABELECIMENTO====",
            "authorizer_id": "2",
            "acquirer_id": "5",
            "acquirer_name": "Redecard",
            "authorizer_date": "20/03/2020T14:32",
            "authorization_number": "202651",
            "merchant_usn": "16013439434",
            "esitef_usn": "200320048363860",
            "sitef_usn": "202651",
            "host_usn": "999202651   ",
            "amount": "510",
            "payment_type": "C",
            "issuer": "2",
            "authorizer_merchant_id": "000000000000005",
            "payment_date": "20/03/2020T14:32"
        }
    ]
}

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
{
    "multiple_payment_methods": [
        {
            "token": "g16hJtpdU6XEN3FP-ApQ9pKTGII5Fa9Y12tRX-qfyC-+BUCV5OaFn807zwwOR6rDtKoRnIJg0QbikaJqJqosyQ==",
            "authorizer_id": "1",
            "installments": "1",
            "installment_type": "4",
            "amount": "512",
            "security_code": "123"
        },
        {
            "token": "g16hJtpdU6XEN3FP-ApQ9pKTGII5Fa9Y12tRX-qfyC-+BUCV5OaFn807zwwOR6rDtKoRnIJg0QbikaJqJqosyQ==",
            "authorizer_id": "2",
            "installments": "1",
            "installment_type": "3",
            "amount": "510",
            "security_code": "321"
        }
    ]
}
--verbose

Resposta:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "payments": [
        {
            "authorizer_code": "000",
            "authorizer_message": "Transacao Aprov.",
            "status": "PPC",
            "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
            "order_id": "20125445982",
            "customer_receipt":"====CUPOM COMPRADOR====",
            "merchant_receipt":"====CUPOM ESTABELECIMENTO====",
            "authorizer_id": "1",
            "acquirer_id": "5",
            "acquirer_name": "Redecard",
            "authorizer_date": "20/03/2020T14:32",
            "authorization_number": "202650",
            "merchant_usn": "16013439434",
            "esitef_usn": "200320048363850",
            "sitef_usn": "202650",
            "host_usn": "999202650   ",
            "amount": "512",
            "payment_type": "C",
            "issuer": "1",
            "authorizer_merchant_id": "000000000000005",
            "payment_date": "20/03/2020T14:32"
        },
        {
            "authorizer_code": "000",
            "authorizer_message": "Transacao Aprov.",
            "status": "PPC",
            "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
            "order_id": "20125445982",
            "customer_receipt":"====CUPOM COMPRADOR====",
            "merchant_receipt":"====CUPOM ESTABELECIMENTO====",
            "authorizer_id": "2",
            "acquirer_id": "5",
            "acquirer_name": "Redecard",
            "authorizer_date": "20/03/2020T14:32",
            "authorization_number": "202651",
            "merchant_usn": "16013439434",
            "esitef_usn": "200320048363860",
            "sitef_usn": "202651",
            "host_usn": "999202651   ",
            "amount": "510",
            "payment_type": "C",
            "issuer": "2",
            "authorizer_merchant_id": "000000000000005",
            "payment_date": "20/03/2020T14:32"
        }
    ]
}

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 com múltiplos meios de pagamento:

ParâmetroDescriçãoFormatoObrigatório
multiple_payment_methods[] Consiste em um array para pagamentos com múltiplos meios de pagamento em que cada item representa um meio de pagamento. Devem ser informados exatamente 2 (dois) itens, os quais são compostos pelos campos descritos abaixo.
authorizer_idCó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 NSIM
installmentsNúmero de parcelas. Caso não seja informado, será usado o valor passado na inicialização da transação no e-SiTef.< 2 NNÃO
installment_typeTipo de financiamento. Caso não seja informado, será usado o valor passado na inicialização da transação no e-SiTef.< 2 NNÃO
amountValor da compra especificado pela loja para este meio de pagamento (em centavos).< 12 NSIM
numberNúmero do cartão do comprador (PAN).< 19 NSIM
expiry_dateData de vencimento do cartão no formato MMAA. Sua obrigatoriedade depende do adquirente escolhido. Na maioria dos casos, esse campo é obrigatório.= 4 NCOND.
tokenHASH 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 ANNÃO
security_codeCó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 NCOND.

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 efetivação de pagamento:

ParâmetroDescriçãoFormato
codeCódigo de resposta do e-SiTef para a operação de múltiplos meios de pagamento. Qualquer código diferente de 0 significa falha. Saiba mais.< 4 N
messageMensagem de resposta do e-SiTef para a operação de múltiplos meios de pagamento.< 500 AN
payments[] Consiste em um array para pagamentos com múltiplos meios de pagamento no qual cada item representa a resposta correspondente a um dos meios de pagamentos. Os itens são compostos pelos campos descritos abaixo.
codeCódigo de resposta do e-SiTef para a operação de pagamento de um dos meios de pagamento. Qualquer código diferente de 0 significa falha. Saiba mais.< 4 N
messageMensagem de resposta do e-SiTef para a operação de pagamento de um dos meios de pagamento.< 500 AN
authorizer_codeCódigo de resposta do autorizador.< 10 AN
authorizer_messageMensagem de resposta do autorizador.< 500 AN
statusStatus da transação de pagamento no e-SiTef. Saiba mais.= 3 AN
nitIdentificador da transação de pagamento no e-SiTef.= 64 AN
order_idCódigo de pedido enviado pela loja na criação da transação.< 20 AN
merchant_usnNúmero sequencial único enviado pela loja na criação da transação.< 12 N
amountValor da compra especificado pela loja para este meio de pagamento (em centavos).< 12 N
sitef_usnNúmero sequencial único da transação de pagamento no SiTef.= 6 N
esitef_usnNúmero sequencial único da transação de pagamento no e-SiTef.= 15 N
customer_receiptCupom (via cliente).< 4000 AN
merchant_receiptCupom (via estabelecimento).< 4000 AN
authorizer_idCódigo da autorizadora utilizada na transação.< 4 N
acquirer_idCódigo do adquirente utilizado na transação.< 4 N
acquirer_nameNome do adquirente utilizado na transação.< 100 AN
authorizer_dateData de efetivação do pagamento retornada pelo autorizador no formato DD/MM/AAAA'T'HH:mm. Exemplo: 13/07/2017T16:03= 16 D
authorization_numberNúmero de autorização.< 6 AN
host_usnNSU da autorizadora.< 15 AN
tidID da transação no adquirente. Este campo só é retornado em transações com adquirentes externos ao SiTef.< 40 AN
eciEletronic Commerce Indicator (indicador do nível de segurança da transação do pagamento via Cielo e-Commerce).< 3 AN
payment_dateData de efetivação do pagamento no e-SiTef no formato DD/MM/AAAA'T'HH:mm. Exemplo: 13/07/2017T16:03= 16 D
issuerCódigo da bandeira retornado pelo autorizador.< 5 AN
authorizer_merchant_idCódigo de afiliação do lojista na autorizadora.< 100 AN
xidCampo XID retornado em autenticações 3DS ou certos adquirentes.< 40 AN
authentication_urlURL de autenticação retornada em fluxos de pagamento com autenticação. Disponível apenas para Cielo e-Commerce.< 56 AN
balanceSaldo disponível após pagamentos com cartões tipo Gift.< 12 N
payment.analysis
codeCódigo de resposta da operação de análise de fraude.< 4 N
messageMensagem de resposta da operação de análise de fraude.< 200 AN
statusStatus 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
← Serviço de consulta de cartãoServiço de confirmação de pagamento com múltiplos meios de pagamento →
  • Fluxo
    • Fluxo de pagamento com confirmação automática
    • Fluxo de pagamento com confirmação tardia
  • Detalhes da chamada
  • Exemplos
    • Pagamento
    • Pagamento com cartão armazenado
  • Parâmetros de requisição
  • Parâmetros de resposta
e-SiTef
Relacionamento com o cliente
+55 (11) 3170-5300+55 (11) 4766-8000comercial@softwareexpress.com.br
Acessos
Portal do DesenvolvedorPortal e-SiTefVersão para impressão
Copyright © 2021 Software Express Informática Ltda - Todos os direitos reservados