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

Para determinados roteamentos é possível incrementar o valor de uma pré-autorização não capturada. Consulte nosso atendimento para avaliar quais roteamentos possuem esta funcionalidade.

Para utilizar essa funcionalidade, basta chamar novamente a operação doPreAuthorization com os dados de uma transação de pré-autorização com status CON (confirmada) com adição do campo additional_amount. Abaixo estão os detalhes dessa chamada.

Parâmetros de Requisição:

Nome do ParâmetroDescriçãoTamanhoObrigatório
nitIdentificador da transação no e-SiTef. Obtido no retorno da chamada ao beginTransaction.= 64 ASim
authorizer_idCódigo da autorizadora no e-SiTef. Ver lista de autorizadoras.≤ 3 NSim
additional_amountValor que será incrementado na compra (em centavos).≤ 12 NSim
number(*)Número do cartão do comprador (PAN).≤ 19 NSim
token(*)Utilizado para casos de pagamento recorrente, onde o cartão já deverá estar armazenado na base de dados do e-SiTef.= 88 ACondicional
wallet_transaction_id(*)Código de identificação de transação com wallet Visa Checkout.< 25 ACondicional
expiry_dateData de vencimento no formato MMAA.= 4 NSim
security_codeCódigo de segurança.≤ 5 NSim

(*) Obrigatório utilizar apenas um entre os campos: number, token ou wallet_transaction_id

Parâmetros de Resposta:

Nome do ParâmetroDescriçãoTamanho
codeCódigo de resposta do e-SiTef. Qualquer código diferente de "0" significa falha. Para maiores informações, consulte o documento Anexo A-2 - Codigos de Resposta.< 4 N
messageMensagem de resposta do e-SiTef.< 500 AN
acquirer_idCódigo do adquirente/roteamento utilizado na transação.< 4 N
acquirer_nameNome do adquirente/roteamento utilizado na transação.< 100 AN
amountValor total da compra (em centavos), isto é, valor pré-autorizado inicialmente mais o(s) valor(es) incrementado(s).< 12 AN
authorization_numberNúmero de autorização do incremento.< 6 AN
authorizer_codeCódigo de resposta do autorizador do incremento.< 10 AN
authorizer_dateData de efetivação do incremento de pré-autorização retornada pelo autorizador no formato DD/MM/AAAA’T’HH:mm. Exemplo: 13/07/2017T16:03= 16 D
authorizer_idCódigo da autorizadora utilizada no incremento.< 4 N
authorizer_merchant_idCódigo de afiliação do lojista na autorizadora.< 100 AN
authorizer_messageMensagem de resposta do autorizador do incremento.< 500 AN
customer_receiptCupom (via cliente) do incremento.< 4000 AN
eciEletronic Commerce Indicator (indicador do nível de segurança da transação da pré-autorização via Cielo e-Commerce).< 3 AN
esitef_usnNúmero sequencial único da transação de pré-autorização no e-SiTef.= 6 N
host_usnNSU da autorizadora do incremento.< 15 AN
issuerCódigo da bandeira retornado pelo autorizador.< 5 AN
merchant_receiptCupom (via estabelecimento) do incremento.< 4000 AN
merchant_usnNúmero sequencial único enviado pela loja na criação da transação.< 12 AN
nitIdentificador da transação de pré-autorização no e-SiTef.= 64 AN
order_idCódigo de pedido enviado pela loja na criação da transação.< 40 AN
payment_typeTipo 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 e pagamentos= 1 A
sitef_usnNúmero sequencial único do incremento de pré-autorização no SiTef.= 6 N
statusStatus do incremento de pré-autorização no e-SiTef.= 3 AN
tidID do incremento no adquirente/roteamento. Este campo só é retornado em transações com adquirentes externos ao SiTef.< 40 AN
xidCampo XID retornado em autenticações 3DS ou certos adquirentes/roteamentos.< 40 AN

Em caso de sucesso, será retornado o responseCode '0'. O status da transação na base dados do e-SiTef não será alterado em hipótese alguma (sucesso ou falha).

Os campos sitef_usn, host_usn, authorization_number, sitef_date, customer_receipt e merchant_receipt na resposta são referentes ao incremento, porém os respectivos dados não são alterados na base de dados do e-SiTef. Apenas o valor total é incrementado na transação.

Exemplo:

1. Criação e de efetivação de pré-autorização de R$20,00:

a. criação - requisição

{
    "order_id":"orderID",
    "merchant_usn":"20190101",
    "amount":"2000",
    "transaction_type":"preauthorization"
}

supondo que a criação foi efetuada com sucesso...

b. efetivação - requisição

{
    "authorizer_id":"2",
    "installments":"2",
    "installment_type":"4",
    "card":{
        "number":"xxxxxxxxxxxxxxxx",
        "expiry_date":"1222",
        "security_code":"yyy"
    }
}

c. 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":"1296",
      "acquirer_name":"Safra",
      "authorization_number":"013245",
      "merchant_usn":"20190101",
      "esitef_usn":"181109017689784",
      "order_id":"orderID",
      "sitef_usn":"212194",
      "host_usn":"999212194",
      "amount":"2000",
      "issuer":"2",
      "payment_type":"C",
      "authorizer_merchant_id":"000000000000000"
   }
}

2. Incremento de pré-autorização de R$2,00

a. incremento - requisição

{
    "authorizer_id":"2",
    "installments":"2",
    "installment_type":"4",
    "additional_amount": "200",
    "card":{
        "number":"xxxxxxxxxxxxxxxx",
        "expiry_date":"1222",
        "security_code":"yyy"
    }
}

b. incremento - resposta

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "pre_authorization":{
      "authorizer_code":"000",
      "authorizer_message":"Transacao OK.",
      "status":"CON",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "customer_receipt":"=== CUSTOMER RECEIPT INCREMENT ===",
      "merchant_receipt":"=== MERCHANT RECEIPT INCREMENT ===",
      "authorizer_id":"2",
      "authorizer_date":"09/11/2018T19:42",
      "acquirer_id":"1296",
      "acquirer_name":"Safra",
      "authorization_number":"013246",
      "merchant_usn":"20190101",
      "esitef_usn":"181109017689785",
      "order_id":"orderID",
      "sitef_usn":"212195",
      "host_usn":"999212195",
      "amount":"2200",
      "issuer":"2",
      "payment_type":"C",
      "authorizer_merchant_id":"000000000000000"
   }
}

O detalhe desta resposta é que o campo amount contem o valor total pré-autorizado.

3. Consulta de status da transação de pré-autorização resultante

a. consulta de transação - 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":"1296",
      "acquirer_name":"Safra",
      "authorization_number":"013245",
      "merchant_usn":"20190101",
      "esitef_usn":"181109017689784",
      "order_id":"orderID",
      "sitef_usn":"212194",
      "host_usn":"999212194",
      "amount":"2200",
      "issuer":"2",
      "payment_type":"C",
      "authorizer_merchant_id":"000000000000000"
   }
}
← Serviço de Edição de Pré-Autorização de Origem ExternaServiço de Captura de Pré-Autorização →