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âmetro	Descrição	Tamanho	Obrigatório
`nit`	Identificador da transação no Carat. Obtido no retorno da chamada ao beginTransaction.	= 64 A	Sim
`authorizer_id`	Código da autorizadora no Carat. Ver lista de autorizadoras.	≤ 3 N	Sim
`additional_amount`	Valor que será incrementado na compra (em centavos).	≤ 12 N	Sim
`number`(*)	Número do cartão do comprador (PAN).	≤ 19 N	Sim
`token`(*)	Utilizado para casos de pagamento recorrente, onde o cartão já deverá estar armazenado na base de dados do Carat.	= 88 A	Condicional
`wallet_transaction_id`(*)	Código de identificação de transação com wallet Visa Checkout.	< 25 A	Condicional
`expiry_date`	Data de vencimento no formato MMAA.	= 4 N	Sim
`security_code`	Código de segurança.	≤ 5 N	Sim

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

Parâmetros de Resposta:

Nome do Parâmetro	Descrição	Tamanho
`code`	Código de resposta do Carat. Qualquer código diferente de "0" significa falha. Para maiores informações, consulte o documento Anexo A-2 - Codigos de Resposta.	< 4 N
`message`	Mensagem de resposta do Carat.	< 500 AN
`acquirer_id`	Código do adquirente/roteamento utilizado na transação.	< 4 N
`acquirer_name`	Nome do adquirente/roteamento utilizado na transação.	< 100 AN
`amount`	Valor total da compra (em centavos), isto é, valor pré-autorizado inicialmente mais o(s) valor(es) incrementado(s).	< 12 AN
`authorization_number`	Número de autorização do incremento.	< 6 AN
`authorizer_code`	Código de resposta do autorizador do incremento.	< 10 AN
`authorizer_date`	Data 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_id`	Código da autorizadora utilizada no incremento.	< 4 N
`authorizer_merchant_id`	Código de afiliação do lojista na autorizadora.	< 100 AN
`authorizer_message`	Mensagem de resposta do autorizador do incremento.	< 500 AN
`customer_receipt`	Cupom (via cliente) do incremento.	< 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 Carat.	= 15 N
`host_usn`	NSU da autorizadora do incremento.	< 15 AN
`issuer`	Código da bandeira retornado pelo autorizador.	< 5 AN
`merchant_receipt`	Cupom (via estabelecimento) do incremento.	< 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 Carat.	= 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 e pagamentos	= 1 A
`sitef_usn`	Número sequencial único do incremento de pré-autorização no SiTef.	= 6 N
`status`	Status do incremento de pré-autorização no Carat.	= 3 AN
`tid`	ID do incremento 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

Em caso de sucesso, será retornado o responseCode '0'. O status da transação na base dados do Carat 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 Carat. 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"
  }
}