Serviço de efetivação de pagamento

import ApiDoc from '../../src/components/api-doc/ApiDoc'; import ResponseCodes from './codigos-de-resposta.md'; import CardOnFile from './parametros-do-card-on-file.md'; import Recorrencia from './parametros-da-recorrencia.md';

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 Carat 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 Carat. Os códigos de produção e certificação serão diferentes.	< 15 AN	SIM
`merchant_key`	Chave de autenticação da loja no Carat. 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:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor <URLPOSTMAN/>

curl
--request POST "https://{{url}}/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": "229",
    "acquirer_name": "Bin",
    "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:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor <URLPOSTMAN/>

curl
--request POST "https://{{url}}/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": "229",
    "acquirer_name": "Bin",
    "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:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor <URLPOSTMAN/>

curl
--request POST "https://{{url}}/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": "229",
    "acquirer_name": "Bin",
    "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:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor <URLPOSTMAN/>

curl
--request POST "https://{{url}}/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": "229",
    "acquirer_name": "Bin",
    "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

Atenção: É importante que na criação da transação oinstallmentsseja maior que 1 para parcelamento.

Requisição:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor <URLPOSTMAN/>

curl
--request POST "https://{{url}}/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"
   },
   "authorizer_id": "313",
   "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:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor <URLPOSTMAN/>

curl
--request POST "https://{{url}}/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": "229",
    "acquirer_name": "Bin",
    "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"
  }
}

Retentativa de Pagamento

Requisição:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor <URLPOSTMAN/>

curl --location --request POST 'https://{{url}}/e-sitef/api/v1/payments/461e709fee10271129a52abd81b43ab08a777cf029a76c9bc56685d2a18eff40' \
--header 'Content-Type: application/json' \
--header 'merchant_id: LOJABIN' \
--header 'merchant_key: {SEU_MERCHANT_KEY}' \
--data-raw '{
    "card": {
        "expiry_date": "1023",
        "number": "4220619003385567",
        "security_code": "123"
    }
}'
--verbose

Resposta:

{
    "code": "255",
    "message": "Transaction Denied",
    "payment": {
        "authorizer_code": "XYZ",
        "authorizer_message": "NEGADA",
        "status": "NEG",
        "nit": "461e709fee10271129a52abd81b43ab08a777cf029a76c9bc56685d2a18eff40",
        "order_id": "1648150290180",
        "authorizer_id": "2",
        "acquirer_id": "229",
        "acquirer_name": "Bin",
        "merchant_usn": "16114726760",
        "esitef_usn": "220411095715390",
        "sitef_usn": "500211",
        "host_usn": "004500211   ",
        "amount": "2000001",
        "payment_type": "C",
        "issuer": "1",
        "authorizer_merchant_id": "000000000000000",
        "terminal_id": "ES000001",
        "retryable_code": "01"
    }
}

Pagamento - Token Bandeira

Algumas bandeiras de cartão possuem uma solução de tokenização que oferece o armazenamento de cartões em cofres na própria bandeira, de forma criptografada. Essa tokenização de bandeira tem o intuito de melhorar a segurança e qualidade das informações de cartão trafegadas, o que acarreta em possíveis aumentos na conversão de aprovação pelos bancos emissores.

Requisição:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor <URLPOSTMAN/>

curl 
--request POST 'https://{{url}}/e-sitef/api/v1/payments/150533212ef1d2082ccff166fd2fb8d98ae645a541ad8ef54225c320bb0587a6' \
--header 'Content-Type: application/json' \
--header 'merchant_id: **********' \
--header 'merchant_key: **********' \
--data-raw '{
    "amount": 3000,
    "discount": 0,
    "installments": 1,
    "installment_type": 4,
    "authorizer_id": "2",
    "subtotal": 3000,
    "card": {
        "expiry_date": "1222",
        "security_code": "123",
        "number": "5555555555555555",
        "cryptogram": "ALRzlt6NKQtPAAZAkOuIAAADFA==",
        "wallet_type": "network_token"
    }
}'
--verbose

Resposta:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "payment": {
        "authorizer_code": "000",
        "authorizer_message": "Transacao Aprov.",
        "status": "CON",
        "nit": "7aef0962f2d2ec05c4cd35fd0d91a11fb4a5ce77e9dff69bbb5fc0992d0bc017",
        "customer_receipt": "====CUPOM COMPRADOR====",
        "merchant_receipt": "====CUPOM ESTABELECIMENTO====",
        "authorizer_id": "2",
        "acquirer_id": "229",
        "acquirer_name": "Bin",
        "authorizer_date": "27/12/2022T17:06",
        "authorization_number": "276147",
        "esitef_usn": "221227000216620",
        "sitef_usn": "276147",
        "host_usn": "999276147   ",
        "amount": "3000",
        "payment_type": "C",
        "issuer": "2",
        "authorizer_merchant_id": "000000000000005",
        "terminal_id": "ES000023",
        "payment_date": "27/12/2022T17:06"
    }
}

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 Carat. Saiba mais.<br />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). <br/><br/> Token gerado pela bandeira (DPAN) para pagamento com Token Bandeira. Saiba mais <br/>	< 19 N	SIM
`cryptogram`	Criptograma gerado pela bandeira.	= 28 A	Sim para pagamentos com token bandeira
`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. Entretanto é possível configurar a obrigatoriedade do campo nas configurações da loja, consulte o suporte do Carat para mais informações.<br />Importante: um pagamento com agendamento implica no armazenamento dos dados do cartão do comprador no ambiente do Carat. 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 Carat. 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.<br />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
`wallet_type`	Campo que especifica se a transação é processada com PAN ou DPAN. Se “tipo” estiver vazio, o valor padrão é PAN (número de cartão não tokenizado). Se houver uma transação tokenizada, deverá enviar o valor “network_token”.	AN	NÃO
external_authentication	Este elemento recebe campos de resultados de autenticação MPI.
`version`	Versão do 3DS utilizado no processo de autenticação (atualmente só está sendo aceito versão 2).	< 1 AN	NÃO
`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
`reference_id`	Identificador da transação de autenticação do dono do cartão, feita em serviço externo ao Carat (No nosso Web Checkout o `reference_id` é referenciado pelo `ds.transId` no retorno da autenticação do 3DS )	< 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.<br />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.
`recurrency_original_amount`	Valor original da transação que originou a recorrência. Este valor deve ser informado em todas a recorrências subsequentes. Só é utilizado quando for uma recorrência. Campo utilizado somente no roteamento BIN, obrigatório quando for recorrência	< 18 AN	NÃO
`product_code`	Código de produto.<br /> É obrigatório em roteamento via Marisa.	< 6 N	COND.
`terminal`	Terminal SiTef que se deseja usar. Se não for enviado, o Carat 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 Carat enviará o código de empresa cadastrado na loja.	= 8 N	NÃO
`authorization_number`	Código de autorização. Obrigatório para autorizadora Bradescard Voucher.	< 6 AN	COND.
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.<br /> Exemplo:<br /> Não se quer aceitar Vouchers: Cultura, Combustível, Benefício. Deve enviar: <br />"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 Carat invalidará a transação, impedindo que se dê uma falsa impressão do uso de uma determinada funcionalidade. <br /><br /> Exemplo: <br /> `{ "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.<br />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
acquirer.card_on_file	É destinado ao envio de informações específicas como, por exemplo, autorização de armazenamento de cartão, confirmando que o dono do cartão autorizou o armazenamento do cartão.<br /> Saiba mais Saiba mais
`usage`	Identifica a utilização.<br />Por exemplo, para autorização de armazenamento: `authorized`	< 11 AN	NÃO
`reason`	Identifica o motivo.<br />Por exemplo, para autorização de armazenamento: `card`	< 11 AN	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 Carat a permissão Permite envio de Empresa e Terminal Sitef via REST.

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âmetro	Descrição	Formato
`code`	Código de resposta do Carat. Qualquer código diferente de `0` significa falha. Saiba mais.	< 4 N
`message`	Mensagem de resposta do Carat.	< 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 Carat. Saiba mais.	= 3 AN
`nit`	Identificador da transação de pagamento no Carat.	= 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 Carat.	= 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. <br/> Ressalva para efetivação de pagamentos PIX Saiba mais.	< 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 Carat 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
`retryable_code`	Indicador de reversibilidade de uma transação cuja autorização foi negada pela autorizadora. Esse campo será retornado na resposta da requisição de pagamento com cartão e deve ser levado em consideração no mecanismo de retentativa de transação da loja virtual. Códigos válidos:<br />`01` – Transação negada reversível, retente mais tarde.<br />`02` – Transação negada irreversível, não retente.<br />	= 2 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 Carat. Este campo pode assumir os seguintes valores:<br />`NOV` – Nova.<br />`EXP` – Expirada.<br />`ACC` – Aceita<br />`REJ` – Rejeitada<br />`REV` – Em revisão<br />`INV` – Inválida	= 3 AN
schedule
`status`	Status do agendamento no Carat. Saiba mais.	= 3 AN
`sid`	Identificador da transação de agendamento no Carat.	= 64 AN
`schedule_usn`	Número sequencial único do agendamento no Carat.	= 15 N
`authorizer_id`	Código da autorizadora a ser utilizada nos pagamentos agendados. <br/><br/> Nas operações com cartão tokenizado, se a autorizadora não for informada, será usado o código da autorizadora usado no armazenamento do cartão.	= 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
`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_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 pagamentos, W = Boleto NR via Web Service	= 1 AN