Efetivação de Pré-Autorização

Detalhes da Chamada

O nit obtido no retorno do serviço de criação de pré-autorização deverá ser enviado na operação de efetivação de pré-autorização juntamente com os parâmetros descritos na tabela abaixo (conforme a necessidade de cada aplicação):

Recurso: /v1/preauthorizations/{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
`Content-Type`	Valor fixo `application/json`	= 15 AN	SIM
`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:

Requisição:

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

Resposta:

{
    "code":"0",
    "message":"OK. Transaction successful.",
    "pre_authorization":{
        "authorizer_code":"000",
        "authorizer_message":"Transacao OK.",
        "status":"CON",
        "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
        "customer_receipt":"=== CUSTOMER RECEIPT ===",
        "merchant_receipt":"=== MERCHANT RECEIPT ===",                
        "authorizer_id":"2",
        "authorizer_date":"09/11/2018T19:40",
        "acquirer_id":"1005",
        "acquirer_name":"Redecard",
        "authorization_number":"013245",
        "merchant_usn":"20190101",
        "esitef_usn":"181109017689784",
        "order_id":"orderID",
        "sitef_usn":"212194",
        "host_usn":"999212194",
        "amount":"100",
        "issuer":"2",
        "payment_type":"C",
        "authorizer_merchant_id":"000000000000000"
    }
}

Parâmetros de requisição

Parâmetro	Descrição	Formato	Obrigatório
`authorizer_id`	Código da autorizadora no e-SiTef. Ver documento Autorizadoras.	< 3 N	SIM
`customer_id`	Documento de identidade do comprador. Use apenas caracteres alfanuméricos (sem pontos, traços ou outros caracteres especiais).	< 20 AN	NÃO
`discount`	Valor do desconto, em centavos. Em caso de pré-autorizações com valores promocionais pelo uso do Visa Checkout, a VISA sugere que este campo seja enviado adicionalmente.	< 12 N	NÃO
`installments`	Juntamente com o campo `installment_type`, indica parcelamento (), utilizados APENAS com autorizadoras roteadas por e-Rede, GetNetLac via SiTef, Rede via SiTef, Cetelem via SiTef e iCards via SiTef*. Envie `1` para transações à vista.	< 2 N	COND.
`installment_type`	Juntamente com o campo `installments`, indica parcelamento (), utilizados APENAS com autorizadoras roteadas por e-Rede, GetNetLac via SiTef, Rede via SiTef, Cetelem via SiTef e iCards via SiTef. Para as demais roteamentos, o parcelamento é possível somente na captura*. Os valores possíveis para installment_type são: `3`: Parcelamento com juros da administradora do cartão `4`: Parcelamento realizado pela loja e sem juros (adotar este valor como padrão/default para transações à vista)	= 1 N	COND.
`mcc`	Merchant Category Code - Indica o código de categoria da loja. Necessário ao utilizar subadquirência Stone WS e é possível enviá-lo na subadquirência via SiTef.	< 4 N	Obrigatório apenas para subadquirência Stone WS
`merchant_email`	e-mail da Loja. Este parâmetro quando enviado sobrescreve o e-mail do cadastro da Loja.	< 40 AN	NÃO
`nit`	Identificador da transação no e-SiTef (criptografado). Obtido no retorno da chamada ao beginTransaction.	= 64 AN	SIM
`promo_code`	Código de promoção Visa Checkout utilizado na pré-autorização. Em caso de pré-autorizações com valores promocionais pelo uso do Visa Checkout, a VISA sugere que este campo seja enviado adicionalmente.	AN	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	< 22 AN	NÃO
`subtotal`	Valor do subtotal, em centavos. Em caso de pré-autorizações com valores promocionais pelo uso do Visa Checkout, a VISA sugere que este campo seja enviado adicionalmente.	< 12 N	NÃO
`subacquirer_merchant_id`	Identificação da loja na subadquirente.	< 22 N	NÃO
`card`	Deve ser utilizado apenas um entre os campos: `number`, `token` ou `wallet_transaction_id`
`number`	Número do cartão do comprador (PAN).	< 19 N	COND.
`token`	Utilizado para casos de pré-autorização recorrente, onde o cartão já deverá estar armazenado na base de dados do e-SiTef.	= 88 AN	COND.
`wallet_transaction_id`	Código de identificação de transação com wallet VisaCheckout. Necessário apenas para Visa Checkout	< 25 AN	COND.
`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`. Necessário apenas para Visa Checkout. Valor padrão: `true`	< 5 AN	COND.
`holder`	Nome do portador do cartão. Obrigatório apenas para roteamentos e-Rede, GetNet WS e VR (SmartNet).	< 30 AN	COND.
`expiry_date`	Data de vencimento do cartão no formato `MMAA`.	= 4 N	COND.
`security_code`	Código de segurança.	< 5 N	COND.
`external_authentication`	Este elemento recebe campos 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.
`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

(*) Parcelamento roteada por GetNetLac via SiTef : Neste caso, a loja será responsável pelo controle do parcelamento, logo não entrarão em vigor as regras de parcelamento configuradas para a interface de pagamento HTML do e-SiTef, somente as regras de parcelamento da autorizadora serão verificadas e aplicadas. Para estas redes mencionadas, caso a pré-autorização seja feita à vista, a captura não pode ser parcelada. Ainda, pré- autorizações roteadas por GetNetLac via SiTef, quando parceladas, apenas são aceitos sem juros, isto é, com o parâmetro installment_type = 4. Parcelamentos com juros não são aceitos para este roteamento.

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

A tabela abaixo contém os parâmetros de resposta do serviço de efetivação de pré-autorização. O aplicativo deverá armazenar os parâmetros que achar necessário. Sugerimos que sejam armazenados os parâmetros: order_id, authorization_number, merchant_usn, esitef_usn, sitef_usn, host_usn, status, code, amount, message (o parâmetro message poderá ser exibido ao cliente).

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