Serviço de criação da transação

import ApiDoc from '../../src/components/api-doc/ApiDoc'; import ApiParams from '../../src/components/api-doc/ApiParams'; import ResponseCodes from './codigos-de-resposta.md';

O consumo do serviço de criação de transação é obrigatório nos fluxos de pagamento e agendamento. Como resultado dessa operação, o lojista obterá um NIT (pagamento) e/ou um SID (agendamento) que serão necessários que será necessário para os próximos passos do fluxo, assim como a utilização do serviço de consulta de transações.

O NIT e o SID possuem possui um tempo limite para sua utilização. Este prazo está configurado na API, e caso seja excedido, a transação passará do status NOV (nova) para EXP (expirada), que impede futuras operações com essa transação, tornando necessário consumir novamente o serviço de criação de transação.

Detalhes da chamada

Recurso: /v1/transactions
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 criação de transações utilizando a ferramenta cURL.

Criação de pagamento com confirmação 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/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"12042142155",
   "order_id":"12042142155",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1000"
}
--verbose

Resposta:

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "payment": {
    "status": "NOV",
    "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
    "order_id": "12042142155",
    "merchant_usn": "12042142155",
    "amount": "1000"
  }
}

Criação de 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/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"12050620649",
   "order_id":"12050620649",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1000",
   "additional_data":{
      "postpone_confirmation":"true"
   }
}
--verbose

Resposta:

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "payment": {
    "status": "NOV",
    "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
    "order_id": "12050620649",
    "merchant_usn": "12050620649",
    "amount": "1000"
  }
}

Criação de 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/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"12053724147",
   "order_id":"12053724147",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1000",
   "schedule":{
      "amount":"900",
      "initial_date":"03/08/2017",
      "number_of_times":"3",
      "interval":"1",
      "soft_descriptor":"Assinatura",
      "show_times_invoice":"false"
   },
   "additional_data":{
      "payer":{
         "store_identification":"98253053045"
      }
   }
}
--verbose

Resposta:

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "payment": {
    "status": "NOV",
    "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
    "order_id": "12053724147",
    "merchant_usn": "12053724147",
    "amount": "1000"
  },
  "schedule": {
    "status": "NOV",
    "sid": "qwertyuiopasdfghjklzxcvbnm0123456789qwertyuiopasdfghjklzxcvbnm01",
    "amount": "900",
    "order_id": "12053724147",
    "merchant_usn": "12053724147"
  }
}

Criação de agendamento sem pagamento

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/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"12055523043",
   "order_id":"12055523043",
   "authorizer_id":"2",
   "schedule":{
      "amount":"900",
      "do_payment_now":"false",
      "initial_date":"03/08/2017",
      "number_of_times":"3",
      "interval":"1",
      "soft_descriptor":"Assinatura",
      "show_times_invoice":"false"
   },
   "additional_data":{
      "payer":{
         "store_identification":"98253053045"
      }
   }
}
--verbose

Resposta:

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "schedule": {
    "status": "NOV",
    "sid": "qwertyuiopasdfghjklzxcvbnm0123456789qwertyuiopasdfghjklzxcvbnm01",
    "amount": "900",
    "order_id": "12055523043",
    "merchant_usn": "12055523043"
  }
}

Criação de pagamento com análise de risco Cielo e-Commerce

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/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"12042142155",
   "order_id":"12042142155",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1000",
   "additional_data":{
      "payer":{
         "name":"Comprador",
         "surname":"credito AF",
         "email":"compradorteste@live.com",
         "city":"Rio de Janeiro",
         "state":"RJ",
         "address_street_name":"Rua Jupiter",
         "address_street_number":"174",
         "address_zip_code":"21241140",
         "born_date":"1991-01-02T08:30:00",
         "address_street_complement":"AP 201",
         "address_country":"BRA"
      },
      "shipment":{
         "method":"LOW_COST",
         "name":"Sr Comprador Teste",
         "phones":[
            {
               "number":"21114740",
               "ddd":"16",
               "ddi":"55"
            }
         ],
         "receiver_address":{
            "complement":"AP 201",
            "city":"Rio de Janeiro",
            "state":"RJ",
            "country":"BRA",
            "zip_code":"21241140",
            "street_number":"174",
            "street_name":"Rua Jupiter"
         }
      },
      "connections":[
         {
            "from":"RAO",
            "to":"SAO",
            "flight_date":"2020-01-02T20:15:00"
         }
      ],
      "gift":"false",
      "browser":{
         "email":"compradorteste@live.com",
         "agent":"Chrome",
         "cookies_accepted":"false",
         "host_name":"Teste",
         "ip_address":"200.190.150.350"
      },
      "items":[
         {
            "title":"ItemTeste",
            "quantity":"1",
            "id":"1487337308522",
            "risk":"HIGH",
            "hedge":{
               "time":"NORMAL",
               "host":"OFF",
               "nonSensical":"OFF",
               "obscenities":"OFF",
               "phone":"OFF",
               "velocity":"HIGH"
            },
            "passenger":{
               "name":"Comprador accept",
               "email":"compradorteste@live.com",
               "rating":"ADULT",
               "phone":{
                  "number":"999994444",
                  "ddd":"11",
                  "ddi":"55"
               },
               "legal_document":"1234567890",
               "customer_class":"Gold"
            },
            "unit_price":"1000",
            "category_id":"other",
            "gift_category":"OFF"
         }
      ],
      "extra_param":{
         "acquirer_params":[
            {
               "key":"95",
               "value":"parametros adicionais"
            }
         ]
      },
      "anti_fraud":"enabled_before_auth",
      "anti_fraud_institution":"AUTHORIZER",
      "anti_fraud_criteria":"ALWAYS",
      "finger_print_id":"074c1ee676ed4998ab66491013c565e2",
      "returns_accepted":"true",
      "journey_type":"OUTWARD"
   }
}
--verbose

Resposta:

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "payment": {
    "status": "NOV",
    "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
    "order_id": "12042142155",
    "merchant_usn": "12042142155",
    "amount": "1000"
  }
}

Criação de pagamento com análise de risco (utlizando o anti fraude Konduto)

Para mais informações verifique nossa seção específica da Konduto

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/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"2423423434",
   "order_id":"2432342343",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1300",
   "additional_data":{
      "anti_fraud":"enabled_before_auth",
      "visitor_id":"XKhas09jcks",
      "items":[
         {
            "title":"title1",
            "quantity":"1",
            "unit_price":"1111",
            "description":"description1",
            "id":"id1",
            "discount_amount":"111",
            "sku":"sku1",
            "creation_date":"11/01/2011"
         }
      ],
      "payer":{
         "name":"Marcos",
         "surname":"da Silva",
         "email":"marocs@dasilva.com",
         "born_date":"1990-01-01T11:11:11",
         "creation_date":"02/03/2004",
         "is_new_client":"true",
         "is_vip_client":"true",
         "phones":[
            {
               "number":"333333333",
               "ddd":"22",
               "ddi":"11"
            },
            {
               "number":"666666666",
               "ddd":"55",
               "ddi":"44"
            }
         ],
         "identification_number":"47764543004"
      },
      "shipment":{
         "name":"Fernando",
         "surname":"Bezerra",
         "address":{
            "zip_code":"98764312",
            "street_number":"987",
            "street_name":"Rua Shipment",
            "complement":"ap. 587",
            "city":"São Shipment",
            "state":"MA",
            "country":"BRA"
         }
      },
      "passengers":[
         {
            "name":"Miguel",
            "last_name":"Herrera",
            "frequent_flyer_card":"frequentFlyerCard",
            "legal_document_type":"1",
            "legal_document":"12312312312",
            "birth_date":"1980-07-28T10:40:00",
            "customer_class":"customerClass",
            "nationality":"BRA",
            "is_frequent_traveler":"true",
            "is_with_special_needs":"true"
         }
      ],
      "connections":[
         {
            "company":"Verde",
            "class":"first",
            "from":"GRU",
            "to":"CGH",
            "departure_date":"2023-09-07T07:09:00",
            "journey_type":"OUTWARD",
            "origin_city":"San Juan",
            "destination_city":"Homero Lopez",
            "class_code":"VIP"
         },
         {
            "company":"Rosa",
            "class":"economy",
            "from":"BSB",
            "to":"VCP",
            "departure_date":"2022-10-21T16:39:00",
            "journey_type":"RETURN",
            "origin_city":"San Pablo",
            "destination_city":"Juanito Cruz",
            "class_code":"ECONOMY"
         }
      ],
      "hotel_reservations":[
         {
            "hotel":"Hotel Green Tree",
            "address":{
               "zip_code":"83392019",
               "street_number":"529",
               "street_name":"Rua Hoteleira",
               "complement":"ap. 019",
               "city":"San Hotel",
               "state":"AC",
               "country":"EN"
            },
            "rooms":[
               {
                  "number":"902",
                  "code":"ROOM902",
                  "type":"King Size",
                  "check_in_date":"2020-01-09T12:30:00",
                  "check_out_date":"2020-01-19T13:00:00",
                  "number_of_guests":"1",
                  "board_basis":"Vegan",
                  "guests":[
                     {
                        "name":"José Aníbal",
                        "document":"98798798712",
                        "document_type":"cpf",
                        "birth_date":"12/03/1970",
                        "nationality":"BRA"
                     }
                  ]
               }
            ],
            "category":"categoryhotel"
         }
      ],
      "billing_data":{
         "address":{
            "zip_code":"12341234",
            "street_number":"666",
            "street_name":"Rua Billing",
            "complement":"ap. 2369",
            "city":"São Billing",
            "state":"AM",
            "country":"BRA"
         }
      },
      "travel":{
         "transport_type":"flight",
         "expiration_date":"2022-02-14T01:30:00"
      },
      "discount_info":"Informações de desconto",
      "events":[
         {
            "name":"Evento de Rock",
            "date":"2021-11-22T09:28:00",
            "type":"show",
            "subtype":"music",
            "venue":{
               "name":"Debicard Hall",
               "street_name":"Rua do Evento",
               "street_number":"928",
               "city":"Jardinópolis",
               "state":"MS",
               "country":"DO",
               "capacity":"300"
            },
            "tickets":[
               {
                  "id":"12h374612h4h",
                  "category":"social",
                  "section":"Seção 1",
                  "premium":"true",
                  "attendee":{
                     "name":"Daniel Almeida",
                     "document":"71728293945",
                     "document_type":"other",
                     "birth_date":"03/10/1990"
                  }
               }
            ]
         }
      ]
   }
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"NOV",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"12042142155",
      "merchant_usn":"2432342343",
      "amount":"1300"
   }
}

Parâmetros de requisição

Na tabela abaixo está a descrição dos parâmetros de requisição do serviço de criação de transações:

Parâmetro	Descrição	Formato	Obrigatório
`merchant_usn`	Número sequencial único para cada pedido, criado pela loja. O NSU será utilizado em toda a comunicação com a loja, de forma a identificar o pedido. Como se trata de uma possível chave para acesso do lado da loja, apesar de ser opcional para o Carat, é fortemente recomendado que o campo seja formatado e enviado pela aplicação da loja.	< 12 N	NÃO
`order_id`	Código do pedido para ser exibido ao comprador, definido pelo lojista. É aconselhável que seja diferente a cada pedido para que facilite a rastreabilidade.<br/>Se a integração da Loja com as redes adquirentes (Cielo, Redecard, etc) for com Carat e SiTef, o campo `orderId` que tem o tamanho máximo de 40 caracteres, será reduzido a 12 caracteres, devido a uma restrição do SiTef. Essa redução será realizada mantendo os caracteres da esquerda para direita (ex.: se um código de pedido inserido for 12345678901234567890 no Carat, no SiTef ele será apenas 123456789012).	< 40 AN	NÃO
`installments`	Número de parcelas. Envie ‘1’ para transações à vista.	< 2 N	SIM
`installment_type`	Tipo de financiamento do parcelamento:<br/>valor 3 = parcelamento com juros da administradora do cartão.<br/>valor 4 = parcelamento realizado pela loja e sem juros (adotar este valor como padrão/default para transações à vista).<br/>Valor 6 = parcelamento com juros da administradora (IATA).<br/>valor 7 = parcelamento realizado pela loja e sem juros (IATA).<br/>O parcelamento IATA é utilizado somente por empresas do seguimento de transporte aéreo.	< 2 N	SIM
`authorizer_id`	Código da autorizadora no Carat. Saiba mais. <br/><br/> Nas operações com cartão tokenizado, se o codigo da autorizadora não for informado, será usado o código da autorizadora usado no armazenamento do cartão.	< 3 N	NÃO
`amount`	Valor total da compra (em centavos). Exemplo: 1,00 = 100 ou 1.100,00 = 110000 – enviar o valor sem a vírgula e ponto.	< 12 N	SIM
`soft_descriptor`	Texto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador. Saiba mais	< 25 AN	NÃO
additional_data	Elemento para envio de dados adicionais.
`postpone_confirmation`	Esse campo deve ser enviado com valor `true` caso se deseje um pagamento com confirmação tardia.	< 5 T/F	NÃO
`customer_email`	Para transações REST, envia o cupom do pagamento para o email informado.	< 50 AN	NÃO
additional_data.payer	Elemento para envio de dados referentes ao comprador.
`identification_number`	Documento de identificação do comprador (CPF/RG).	< 20 AN	NÃO
`store_identification`	Identificação do comprador para armazenamento de cartão. Esta identificação deve ser única para cada usuário da loja. Mas atenção, essa garantia de unicidade é de total responsabilidade da loja, A API não realizará nenhuma validação.	< 20 AN	SIM para agendamento
`name`	Primeiro nome do comprador	< 100 AN	Não
`surname`	Sobrenome nome do comprador	< 100 AN	Não
additional_data.merchant	Elemento para envio de dados referentes ao lojista.
`email`	Endereço de e-mail do lojista.	< 1024 AN	NÃO
additional_data.extra_param.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, a API 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

Campos de MCC Dinâmico

Inicialização da transação de pagamento ou de pré-autorização REST

Parâmetros de requisição

Adicionalmente aos campos mencionados, os campos abaixo são usados no cenário específico de MCC dinâmico da integração com a bin:

Parâmetro	Descrição	Formato	Obrigatório
`soft_descriptor`	Frase personalizada que será impressa na fatura do portador. Para informação referente ao MCC dinâmico, equivale ao nome do sublojista.	< 25 AN	SIM
additional_data	<td colspan="3" /> Elemento para envio de dados adicionais.
`mcc`	MCC do sublojista.	= 4 N	SIM
`subacquirer_merchant_id`	Código do sublojista. Campo legado!!! Dar preferência ao `additional_data.subacquirer_merchant.id`	< 15 N	NÃO
additional_data.subacquirer_merchant	<td colspan="3" /> Elemento para envio de dados referentes ao lojista de uma subadquirente.
`id`	Código do sublojista.	< 15 N	SIM
`phone_number`	Número de Telefone do sublojista.	< 14 AN	NÃO
`address`	Endereço do sublojista.	< 48 AN	NÃO
`city`	Cidade do sublojista.	< 13 AN	NÃO
`state`	Estado do sublojista, em formato de sigla de dois dígitos (ex.: SP).	= 2 A	SIM
`country`	País do sublojista. Seguir o padrão ISO 3166-1 alpha-2 (ex.: BR).	= 2 A	SIM
`zip_code`	Código postal do sublojista.	< 9 AN	SIM
`identification_number`	CNPJ do sublojista.	< 18 N	SIM
`payment_facilitator_id`	Código do facilitador.	< 11 N	SIM

Exemplo

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/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
  "merchant_usn": "19035815234",
  "order_id": "1616438400044",
  "installments": "1",
  "installment_type": "4",
  "authorizer_id": "2",
  "amount": "1300",
  "soft_descriptor": "L012121",
  "additional_data": {
    "mcc": "1111",
    "subacquirer_merchant": {
      "id": "12345",
      "address": "Avenida Paulista, 2000",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "zip_code": "01107001",
      "identification_number": "53455823000178",
      "payment_facilitator_id": "654321",
      "phone_number": "+55 11 99999-9999"
    }
  }
}

Resposta:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "payment": {
        "status": "NOV",
        "nit": "6215a32a557f5dc4627b540f517e40abd6a8411cf89a2e073913aa25d7c95590",
        "order_id": "1616438400044",
        "merchant_usn": "19035815234",
        "amount": "1300"
    }
}

Parâmetro	Descrição	Formato	Obrigatório
`merchant_usn`	Número sequencial único para cada pedido, criado pela loja. O NSU será utilizado em toda a comunicação com a loja, de forma a identificar o pedido. Como se trata de uma possível chave para acesso do lado da loja, apesar de ser opcional para o Carat, é fortemente recomendado que o campo seja formatado e enviado pela aplicação da loja.	< 12 N	NÃO
`order_id`	Código do pedido para ser exibido ao comprador, definido pelo lojista. É aconselhável que seja diferente a cada pedido para que facilite a rastreabilidade.<br/>Se a integração da Loja com as redes adquirentes (Cielo, Redecard, etc) for com Carat e SiTef, o campo `orderId` que tem o tamanho máximo de 40 caracteres, será reduzido a 12 caracteres, devido a uma restrição do SiTef. Essa redução será realizada mantendo os caracteres da esquerda para direita (ex.: se um código de pedido inserido for 12345678901234567890 no Carat, no SiTef ele será apenas 123456789012).	< 40 AN	NÃO
`installments`	Número de parcelas. Envie ‘1’ para transações à vista.	< 2 N	SIM
`installment_type`	Tipo de financiamento do parcelamento:<br/>valor 3 = parcelamento com juros da administradora do cartão.<br/>valor 4 = parcelamento realizado pela loja e sem juros (adotar este valor como padrão/default para transações à vista).<br/>Valor 6 = parcelamento com juros da administradora (IATA).<br/>valor 7 = parcelamento realizado pela loja e sem juros (IATA).<br/>O parcelamento IATA é utilizado somente por empresas do seguimento de transporte aéreo.	< 2 N	SIM
`authorizer_id`	Código da autorizadora no Carat. Saiba mais. <br/><br/> Nas operações com cartão tokenizado, se o codigo da autorizadora não for informado, será usado o código da autorizadora usado no armazenamento do cartão.	< 3 N	NÃO
`amount`	Valor total da compra (em centavos). Exemplo: 1,00 = 100 ou 1.100,00 = 110000 – enviar o valor sem a vírgula e ponto.	< 12 N	SIM
`soft_descriptor`	Texto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador. Saiba mais	< 30 AN	NÃO
`authorizer_authentication`	Este campo deve ser enviado com valor `true` caso se deseje um pagamento com autenticação. Essa funcionalidade só está disponível para Cielo e-Commerce e e.Rede REST.	< 5 T/F	NÃO
`encrypted_card`	Este campo deve ser enviado com valor `true` caso o número do cartão a ser enviado na próxima etapa do fluxo use a criptografia do SiTef.<br/>A opção de envio do cartão criptografado só será possível com roteamento via SiTef e é necessário a configuração prévia do SiTef em questão	< 5 T/F	NÃO
iata	Este elemento contém campos específicos de transações IATA.
`departure_tax`	Taxa de embarque em centavos.	< 12 N	SIM apenas para installment_type = 6 ou 7
`first_installment`	Entrada em transações IATA em centavos. Funcionalidade disponível apenas para o adquirente Getnet.	< 12 N	NÃO
schedule	O envio do elemento `schedule` implica no uso da funcionalidade de agendamento de recorrência. Nenhum de seus campos é obrigatório caso se deseje apenas fazer um pagamento simples.
`amount`	Valor em centavos dos pagamentos recorrentes. Caso esse campo não seja enviado, será utilizado o valor do pagamento.	< 12 N	SIM
`initial_date`	Data de execução do primeiro pagamento agendado. Essa data deve ter pelo menos dois dias à frente do dia atual e dias 29, 30 e 31 nunca são permitidos.<br/>O formato da data a ser seguido é: `DD/MM/AAAA`<br/>Exemplo: 20/04/2021	= 10 D	SIM
`number_of_times`	Número de pagamentos agendados a serem executados. Caso esse campo não seja enviado, agendamento ficará ativo infinitamente.	< 3 N	NÃO
`interval`	Intervalo em meses entre cada pagamento agendado. Caso esse campo não seja enviado, assume-se o valor `1` (execuções mensais).	< 2 N	NÃO
`do_payment_now`	Enviar esse campo com valor `false` caso se deseje realizar um agendamento sem pagamento imediato.<br/>No caso deste campo ser ausente ou para qualquer valor diferente de `false`, será criado um agendamento COM pagamento imediato.	< 5 T/F	NÃO
`installments`	Número de parcelas de cada pagamento agendado. Caso esse campo não seja enviado, assume-se o valor `1`.	<2 N	NÃO
`installment_type`	Tipo de financiamento do parcelamento de cada pagamento agendado:<br/>Valor `3` = parcelamento com juros da administradora do cartão.<br/>Valor `4` = parcelamento realizado pela loja e sem juros. (Adotar este valor como padrão/default para transações à vista).<br/>Caso esse campo não seja enviado, assume-se o valor `4`.	< 2 N	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	< 30 AN	NÃO
`show_times_invoice`	Para agendamentos por tempo finito, enviar esse campo com valor `true` caso se deseje acrescentar ao final do campo `soft_descriptor` o número de execuções/total de execuções (exemplo: Assinatura 3/12).	< 5 T/F	NÃO
additional_data	Elemento para envio de dados adicionais.
`postpone_confirmation`	Esse campo deve ser enviado com valor `true` caso se deseje um pagamento com confirmação tardia.	< 5 T/F	NÃO
`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	COND.
`ecomm_pos_ref`	Este campo enviará uma identificação que constará no campo PDV do relatório do SiTef Web para transações e-commerce.	< 8 AF	NÃO
`customer_email`	Se informado, deve conter o e-mail para o envio do recibo do consumidor, quando uma transacao for efetivada via REST.	< 50 AN	NÃO
additional_data.payer	Elemento para envio de dados referentes ao comprador.
`identification_number`	Documento de identificação do comprador (CPF/RG).	< 20 AN	NÃO
`store_identification`	Identificação do comprador para armazenamento de cartão. Esta identificação deve ser única para cada usuário da loja. Mas atenção, essa garantia de unicidade é de total responsabilidade da loja, A API não realizará nenhuma validação.	< 20 AN	SIM para agendamento
`name`	Primeiro nome do comprador	< 100 AN	Não
`surname`	Sobrenome nome do comprador	< 100 AN	Não
additional_data.merchant	Elemento para envio de dados referentes ao lojista.
`email`	Endereço de e-mail do lojista.	< 1024 AN	NÃO
additional_data.extra_param.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, a API 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

Na tabela abaixo está a descrição dos parâmetros adicionais que devem ser enviados num pagamento com análise de fraude (por enquanto disponível apenas para Cielo e-Commerce):

Parâmetro	Descrição	Formato	Obrigatório
additional_data
`anti_fraud_institution`	Esse campo é utilizado quando não se tem um contrato com uma instituição de analise de antifraude e quer que a analise de antifraude seja feita por uma autorizadora, nesse caso deve ser enviado com o valor ‘AUTHORIZER’. Caso você tenha um contrato com uma instituição de analise de antifraude tais como: Konduto, CyberSource e ClearSale esse campo não deve ser usado.	= 10 AN	COND.
`anti_fraud`	Habilita o serviço de análise de fraude. Valores permitidos:<br/>`enabled_before_auth` – a análise de fraude será realizada ANTES da autorização do pagamento. Caso a análise seja rejeitada, o pagamento não será iniciado.<br/>`enabled_after_auth` – a análise de fraude será realizada APÓS a autorização do pagamento. Caso a análise seja rejeitada, o pagamento que já foi autorizado será cancelado.	< 19 AN	SIM para análise de fraude
`anti_fraud_criteria`	Critério de execução da análise de fraude. Valores permitidos:<br/>`ON_SUCCESS` – só realiza a análise se tiver sucesso na transação.<br/>`ALWAYS` – sempre realiza a análise.	< 10 AN	NÃO
`finger_print_id`	Identificador utilizado para cruzar informações obtidas pelo browser do internauta com os dados enviados para annálise. Para maiores detalhes de como executar o fingerprint e obter o identificador, consultar a documentaçãoo disponível com o antifraude escolhido.	< 50 AN	NÃO
`gift`	Indica se o pedido é para presente ou não.	< 5 T/F	NÃO
`returns_accepted`	Define se devoluções são aceitas para o pedido.	< 5 T/F	NÃO
`journey_type`	Tipo de viagem. Valores permitidos:<br/>`ROUND_TRIP` – ida e volta.<br/>`OUTWARD` – ida.<br/>`RETURN` – volta.	< 10 AN	NÃO
additional_data.payer
`name`	Nome do comprador.<br/>Obs.: a concatenação de nome com o sobrenome não pode ultrapassar 255 caracteres.	< 200 AN	NÃO
`surname`	Sobrenome do comprador.<br/>Obs.: a concatenação do nome com o sobrenome não pode ultrapassar 255 caracteres.	< 200 AN	NÃO
`email`	E-mail do comprador.	< 255 AN	NÃO
`born_date`	Data de nascimento do comprador, no formato `YYYY-MM-DDTHH:MM:SS`. Ex.: 1991-01-02T08:30:00.	= 19 AN	NÃO
`address_street_name`	Endereço do comprador.	< 255 AN	NÃO
`address_street_number`	Número do endereço do comprador.	< 15 AN	NÃO
`address_street_complement`	Complemento do endereço do comprador.	< 50 AN	NÃO
`address_zip_code`	CEP do endereço do comprador. Ex.: 21241140.	< 9 AN	NÃO
`city`	Cidade do endereço do comprador.	< 50 AN	NÃO
`state`	Estado do endereço do comprador. Ex.: SP.	= 2 AN	NÃO
`address_country`	País do endereço do comprador. Ex.: BRA.	< 35 AN	NÃO
additional_data.shipment.receiver_address
`street_name`	Endereço de entrega.	< 255 AN	NÃO
`street_number`	Número do endereço de entrega.	< 15 AN	NÃO
`complement`	Complemento do endereço de entrega.	< 50 AN	NÃO
`zip_code`	CEP do endereço de entrega. Ex.: 21241-140.	< 9 AN	NÃO
`city`	Cidade do endereço de entrega.	< 50 AN	NÃO
`state`	Estado do endereço de entrega.	= 2 AN	NÃO
`country`	País do endereço de entrega seguindo a AN 3166-1. Ex.: BRA	= 3 AN	NÃO
additional_data.browser
`cookies_accepted`	Identifica se o browser do cliente aceita cookies. Enviar `true` caso positivo.	< 5 T/F	NÃO
`email`	E-mail registrado no browser do comprador.	< 100 AN	NÃO
`host_name`	Nome do host onde o comprador estava antes de entrar no site da loja.	< 60 AN	NÃO
`ip_address`	Endereço IP do comprador. É altamente recomendável o envio deste campo.	< 15 AN	NÃO
`agent`	Nome do browser utilizado pelo comprador. Ex.: Chrome.	< 40 AN	NÃO
additional_data.items[]
`gift_category`	Campo que avaliará os endereços de cobrança e entrega para diferentes cidades, estados ou países. Pode assumir os seguintes valores: <br/>`OFF` – Ignora a análise de risco para endereços divergentes.<br/>`YES` – Em caso de divergência entre endereços de cobrança e entrega, marca com risco pequeno.<br/>`NO` – Em caso de divergência entre endereços de cobrança e entrega, marca com risco alto.	< 3 AN	NÃO
`risk`	Nível do risco do produto. Pode assumir os seguintes valores: <br/>`LOW` – O produto tem um histórico de poucos chargebacks.<br/>`NORMAL` – O produto tem um histórico de chargebacks considerado normal.<br/>`HIGH` – O produto tem um histórico de chargebacks acima da média.	< 6 AN	NÃO
`title`	Nome do produto.	< 255 AN	NÃO
`quantity`	Quantidade do produto a ser adquirido.	< 15 N	NÃO
`id`	Código comerciante identificador do produto.	< 255 AN	NÃO
`unit_price`	Preço unitário do produto em centavos.	< 15 N	NÃO
`category_id`	Tipo do produto. Pode assumir os seguintes valores: `art`, `baby`, `coupon`, `donation`, `computing`, `camera`, `video_game`, `television`, `car_electronic`, `electronic`, `automotive`, `entertainment`, `fashion`, `game`, `home`, `musical`, `phone`, `service`, `learning`, `ticket`, `travel`, `virtual_good`, `physical`, `other`, `adult_content`, `gift_certificate`, `handling`, `shipping`, `shipping_and_handling` ou `subscription`.	< 21 AN	NÃO
additional_data.items[].hedge
`time`	Nível de importância da hora do dia do pedido do cliente. Pode assumir os seguintes valores:<br/>`LOW` – Baixa importância no horário do dia em que foi feita a compra, para a análise de risco.<br/>`NORMAL` – Média importância no horário do dia em que foi feita a compra, para a análise de risco.<br/>`HIGH` – Alta importância no horário do dia em que foi feita a compra, para a análise de risco.<br/>`OFF` – O horário da compra não afeta a análise de risco.	< 6 AN	NÃO
`host`	Nível de importância do e-mail e endereços IP dos clientes em risco de pontuação. Pode assumir os seguintes valores:<br/>`LOW` – Baixa importância do e-mail e endereço IP na análise de risco.<br/>`NORMAL` – Média importância do e-mail e endereço IP na análise de risco.<br/>`HIGH` – Alta importância do e-mail e endereço IP na análise de risco.<br/>`OFF` – E-mail e endereço IP não afetam a análise de risco.	< 6 AN	NÃO
`non_sensical`	Nível dos testes realizados sobre os dados do comprador com pedidos recebidos sem sentido. Pode assumir os seguintes valores:<br/>`LOW` – Baixa importância da verificação feita sobre o pedido do comprador, na análise de risco.<br/>`NORMAL` – Média importância da verificação feita sobre o pedido do comprador, na análise de risco.<br/>`HIGH` – Alta importância da verificação feita sobre o pedido do comprador, na análise de risco.<br/>`OFF` – Verificação do pedido do comprador não afeta a análise de risco.	< 6 AN	NÃO
`obscenities`	Nível de obscenidade dos pedidos recebidos. Pode assumir os seguintes valores:<br/>`LOW` – Baixa importância da verificação sobre obscenidades do pedido do comprador, na análise de risco.<br/>`NORMAL` – Média importância da verificação sobre obscenidades do pedido do comprador, na análise de risco.<br/>`HIGH` – Alta importância da verificação sobre obscenidades do pedido do comprador, na análise de risco.<br/>`OFF` – Verificação de obscenidade no pedido do comprador não afeta a análise de risco.	< 6 AN	NÃO
`phone`	Nível dos testes realizados com os números de telefones. Pode assumir os seguintes valores:<br/>`LOW` – Baixa importância nos testes realizados com números de telefone.<br/>`NORMAL` – Média importância nos testes realizados com números de telefone.<br/>`HIGH` – Alta importância nos testes realizados com números de telefone.<br/>`OFF` – Testes de números de telefone não afetam a análise de risco.	< 6 AN	NÃO
`velocity`	Nível de importância de frequência de compra do cliente. Pode assumir os seguintes valores:<br/>`LOW` – Baixa importância no número de compras realizadas pelo cliente nos últimos 15 minutos.<br/>`NORMAL` – Média importância no número de compras realizadas pelo cliente nos últimos 15 minutos.<br/>`HIGH` – Alta importância no número de compras realizadas pelo cliente nos últimos 15 minutos.<br/>`OFF` – A frequência de compras realizadas pelo cliente não afeta a análise de fraude.	< 6 AN	NÃO
additional_data.items[].passenger
`email`	E-mail do passageiro.	< 255 AN	NÃO
`legal_document`	Id do passageiro a quem o bilhete foi emitido.	< 32 AN	NÃO
`name`	Nome do passageiro.	< 120 AN	NÃO
`rating`	Classificação do passageiro. Pode assumir os seguintes valores:<br/>`ADULT` – Passageiro adulto.<br/>`CHILD` – Passageiro criança.<br/>`INFANT` – Passageiro infantil.<br/>`YOUTH` – Passageiro adolescente.<br/>`STUDENT` – Passageiro estudante.<br/>`SENIOR_CITIZEN` – Passageiro idoso.<br/>`MILITARY` – Passageiro militar.	< 14 AN	NÃO
`customer_class`	Classificação da empresa aérea. Pode-se usar valores como Gold ou Platina.	< 32 AN	NÃO
additional_data.items[].passenger.phone
`ddi`	Código do país do telefone do passageiro. Para pedidos fora dos E.U.A., é recomendável o envio deste campo.	< 3 N	NÃO
`ddd`	Código da área do telefone do passageiro.	< 3 N	NÃO
`number`	Número de telefone do passageiro.	< 9 N	NÃO
additional_data.extra_param.acquirer_params[]
`key`	Id das informações adicionais a serem enviadas. Maiores detalhes sobre o envio desse campo entrar em contato com a Cielo	< 1024 N	NÃO
`value`	Valor das informações adicionais a serem enviadas.	< 1024 AN	NÃO
additional_data.shipment
`name`	Nome do destinatário da entrega.	< 255 AN	NÃO
`method`	Tipo de serviço de entrega do produto. Pode assumir os seguintes valores:<br/>`SAME_DAY` – Serviço de entrega no mesmo dia.<br/>`ONE_DAY` – Serviço de entrega noturna ou no dia seguinte.<br/>`TWO_DAY` – Serviço de entrega em dois dias.<br/>`THREE_DAY` – Serviço de entrega em três dias.<br/>`LOW_COST` – Serviço de entrega de baixo custo.<br/>`PICKUP` – Produto retirado na loja.<br/>`OTHER` – Outro método de entrega.<br/>`NONE` – Sem serviço de entrega, pois é um serviço ou assinatura.	< 9 AN	NÃO
additional_data.shipment.phones[]
`ddi`	Código do país do telefone do destinatário da entrega. Para pedidos fora dos E.U.A., é recomendável o envio deste campo.	< 3 N	NÃO
`ddd`	Código da área do telefone do destinatário da entrega.	< 3 N	NÃO
`number`	Número de telefone do destinatário da entrega.	< 9 N	NÃO
additional_data.connections[]
`flight_date`	Data, hora e minuto de partida do voo no formato `YYYY-MM-DDTHH:MM:SS`. Ex.: 1991-01-02T08:30:00.	= 19 AN	NÃO
`from`	Código do aeroporto do ponto de origem da viagem. Ex.: CGH.	= 3 AN	NÃO
`to`	Código do aeroporto do ponto de destino da viagem. Ex.: GYN.	= 3 AN	NÃO

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 criação de transações:

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
`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
schedule
`sid`	Identificador da transação de agendamento no Carat.	= 64 AN
`amount`	Valor dos pagamentos agendados especificado pela loja (em centavos) na criação da transação.	< 12 N
`status`	Status do agendamento no Carat. Saiba mais.	= 3 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