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

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 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 um tempo limite para sua utilização. Este prazo está configurado no Pagamento Online, 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âmetroDescriçãoFormatoObrigatório
merchant_idCódigo da loja no Pagamento Online. Os códigos de produção e certificação serão diferentes.< 15 ANSIM
merchant_keyChave de autenticação da loja no Pagamento Online. As chaves de produção e certificação serão diferentes.< 80 ANSIM
Content-TypeDeve ser enviado com o valor application/json.= 15 ANSIM

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:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/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:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/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:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/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:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/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:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/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":"Eu defini isso"
}
]
},
"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:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/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"
}
}

Código de Retorno

CódigoDescrição
0Transação OK
1Campo NIT nulo
2Request enviado é nulo
3Campo NIT inválido
4Campo authorizerId nulo
5Campo authorizerId inválido
6Campo autoConfirmation nulo
7Campo autoConfirmation vazio
8Campo cardExpireDate nulo
9Campo cardExpireDate inválido
10Campo cardNumber nulo
11Campo cardNumber inválido
12Campo cardSecurityCode nulo
13Campo cardSecurityCode inválido
14Campo installments nulo
15Campo installments inválido
16Campo installmentType nulo
17Campo installmentType inválido
18Campo customerId nulo
19Campo customerId inválido
20Campo departureTax nulo
21Campo departureTax inválido
22Campo firstInstallment nulo
23Campo firstInstallment inválido
24Campo softDescriptor nulo
25Campo softDescriptor inválido
26Campo merchantKey nulo
27Campo merchantKey inválido
28Campo nsuSitef nulo
29Campo nsuSitef inválido
30Campo merchantId nulo
31Campo merchantId inválido
32Campo amount nulo
33Campo amount inválido
34Campo esitefUSN nulo
35Campo esitefUSN invalid
36Campo merchantUSN nulo
37Campo merchantUSN inválido
38Campo ordered inválido
39Campo parameter inválido
40Campo parameter nulo
41Campo parameterNumber inválido
42Campo jsonXml nulo
43Campo jsonXml inválido
44Método nulo
45Método inválido
46Campo url inválido
47Campo redirect inválido
48Campo card_hash nulo
49Campo card_hash inválido
50Campo financing_type nulo
51Campo financing_type inválido
52Campo sitef_ip inválido
53Campo sitef_port inválido
54Campo sitef_terminal inválido
55Campo sitef_merchant_id inválido
56Campo confirmation_data inválido
57Campo confirmation_type inválido
58Campo inner_transactions vazio ou nulo
59Campo extra_field inválido
60Campo prefixes / key vazio
61Campo prefixes / value vazio
62Campo additional_data inválido
63Campo prefixes inválido
64Campo financing_type com juros não permitido
68Campo dealer_code nulo
69Campo dealer_code inválido
70Campo phone_ddd nulo
71Campo phone_number nulo
72Campo amount_key inválido
73Campos card_number e card_token não podem ser utilizados simultaneamente
74Campo amount não pode ser pré-fixado para recarga
75Campo phone_ddd inválido
76Campo phone_number inválido
77Campo store_card inválido
78Campo store_identification nulo
79Campo recharge_included inválido
80Autorizadora não implementada para mobile
81Operação não permitida
82Transação não encontrada
83Campo store_identification inválido
84Armazenamento não permitido para a autozadora escolhida
85Campo purchase_summary invalido
86Lista de itens vazia
87Campo authenticate inválido
88Cartão inválido. Verifique o número do cartão ou a forma de pagamento escolhida.
89Erro ao recuperar a transação
100Falha ao efetuar transação de pagamento
101Falha ao confirmar transação de pagamento
102Transação já finalizada ou em andamento
103Tipo de transação inválido
104Autorizadora para a transação inválida
105Estilo da transação inválido
106Loja sem permissão para a operação
107Operação não permitida para o status da transação
108Autorizadora inativa ou não habilitada para a loja.
109Parcelas excedem o limite configurado na autorizadora
110Loja inativa
111Tipo de Autorizadora Inválida
112Autorizadora com configuração inválida
113Autorizadora não habilitada ou inativa para a Loja.
114Transação Bloqueada.
115Erro de autenticidade
116Erro na consulta de transação. Por favor tente novamente mais tarde.
131Falha de comunicação com o SiTef
132Request mal formatado
134Erro na consulta de cartão (card query)
135Loja não possui permissão para pagamento Split.
136Falha no rollback
137Operação inválida.
138Falha na escolha de autorizadora
139Não existe autorizadora configurada
140Consulta devolveu muitas autorizadoras, não foi possível identificar unicamente
141A autorizadora passada não é roteada via SiTef
142Erro ao consultar cartão resposta inesperada da autorizadora
143O número de cartão enviado não corresponde à forma de pagamento escolhida.
144Loja sem permissão para Recarga V5 HTML
145Loja sem permissão para Recarga V5 WebService
146Erro na autenticação
147Autenticação Negada
148Autenticação não permitida para esta autorizadora
149Loja sem dados cadastrais de autenticação ISA
150Request inválido
157Campo showTimesInvoice inválido
160Loja sem permissão para transações HTML
161Loja sem permissão para transações de pagamento
162Loja sem permissão para transações IATA
163Cadastro da Autorizadora com erros.
215Venda com cartão tipo Gift não habilitada
216Recarga de cartão tipo Gift não habilitada
217Cancelamento de pagamento via cartão tipo Gift não habilitada
230campo payer neighborhood inválido
231campo payer uf inválido
232campo payer name inválido
233campo payer address_street_name / address_street_number inválido
234campo payer identification_number inválido
235campo payer city inválido
236campo payer zipcode inválido
255Pagamento negado
256Aguardando resposta do cancelamento
257Estorno negado
258Recarga negada
259Transação negada
260Recarga desfeita por falha no pagamento
261Recarga deve ser reenviada
300Erro ao criar transação de refund
301Campo card_number diferente
302Falha de comunicação
304Campo extra_info inválido
305Campo currency inválido
306Campo insurance_amt inválido
307Campo handling_amt inválido
308Campo tax_amount inválido
309Campo inner_transaction order_id inválido
310Campo inner_transaction merchant_id inválido
311Campo inner_transaction merchant_usn inválido
312Campo inner_transaction amount inválido
313campo shipment type inválido
314Campo shipment cost inválido
315Campo shipment discount_amount inválido
316Campo shipment receiver_address_apartment inválido
317Campo shipment receiver_address_floor inválido
318Campo shipment receiver_address_street_name inválido
319Campo shipment receiver_address_street_number inválido
320Campo shipment receiver_address_zip_code inválido
321Campo shipment receiver_address_complement inválido
322Campo shipment receiver_address_district inválido
323Campo shipment receiver_address_city inválido
324Campo shipment receiver_address_state inválido
325Campo shipment receiver_address_country inválido
326Campo shipment receiver_address_name inválido
327Campo shipment receiver_address_phone_area_code inválido
328Campo shipment receiver_address_phone_number inválido
329Campo payment_method installments inválido
330Campo payment_method excluded_payment_method id inválido
331Campo payment_method excluded_payment_method name inválido
332Campo payment_method excluded_payment_method payment_type_id inválido
333Campo payment_method excluded_payment_method thumbnail inválido
334Campo payment_method excluded_payment_method secure_thumbnail inválido
335Campo payment_method excluded_payment_type id inválido
336Campo payment_method excluded_payment_type name inválido
337Campo payer phone_number inválido
338Campo payer phone_area_code inválido
339Campo payer date_created inválido
340Campo payer email inválido
341Campo payer born_date inválido
342Campo payer mother_name inválido
343Campo payer father_name inválido
344Campo payer sex inválido
345Campo payer phone_country_code inválido
346Campo payer phone_extension inválido
347Campo payer phone_extension_type inválido
348Campo payer tax_type inválido
349Campo payer address_type inválido
350Campo item id inválido
351Campo item description inválido
352Campo item category_id inválido
353Campo item picture_url inválido
354Campo item unit_price inválido
355Campo item quantity inválido
356Campo item title inválido
357Campo item weight inválido
358Campo item shipping_cost inválido
359Campo item quantity_itens_sum inválido
360Campo item tax_amount inválido
361Campo item weight_unit inválido
362Campo item length inválido
363Campo item length_unit inválido
364Campo item width inválido
365Campo item width_unit inválido
366Campo item height inválido
367Campo item height_unit inválido
368Campo item url inválido
369Campo item type inválido
370Campo extra_param metadata_item key inválido
371Campo extra_param metadata_item inválido inválido
372Campo extra_param metadata_item group inválido
373Campo extra_param prefix key inválido
374Campo extra_param prefix value inválido
375Campo extra_param acquirer_param key inválido
376Campo extra_param acquirer_param value inválido
400Transação abortada
723Condições enviadas para a adquirentes não suportadas. / Credenciais da adquirente inválidas.
724Campo max_installments inválido
910Transação negada pela e-Rede.
920Transação negada pela Cielo e-Commerce.
930Erro na comunicação com a Visa Checkout.
934Erro na autorizadora Masterpass ao transacionar.
940Transação negada pela GetNet WS.
941Usuário não autenticado na GetNet WS.
942Nome de usuário inválido.
943Senha inválida.
944Id do comerciante inválido.
945Faixa de ID do comerciante.
946ID do terminal.
947Campo de cartão nulo.
948Id de pagamento nulo.
949PARes nulo.
950Transação negada pela Global Payments WS.
951Requisição nula.
952Código de comerciante inválido.
953Terminal inválido.
954Assinatura inválida.
970Transação negada pela SafetyPay.
971Motivo de reembolso nulo.
972Credencial nula.
980Titular do cartão nulo.
981Chave de pedido nula.
989Instituição antifraude inválida para notificar.
990ID de comerciante nulo.
991Código de comerciante nulo.
992Tipo de pagamento inválido para antifraude.
993Autorizadora inválida para antifraude.
994Pagamento Split não permitido para antifraude.
995Transação do tipo recarga não permitida para antifraude.
996Entidade para análise antifraude não cadastrada.
997Loja sem permissão para antifraude.
998Análise antifraude rejeitada, inválida ou em revisão.
999Item id do antifraude nulo.
1000Erro inesperado no Pagamento Online. Entre em contato com o suporte.
1003Erro inesperado no Pagamento Online. Entre em contato com o suporte.
1004Erro inesperado no Pagamento Online. Entre em contato com o suporte.
1010Erro inesperado de acesso à base de dados do Pagamento Online. Entre em contato com o suporte.
1032Nenhum resultado encontrado.
2000Erro inesperado no Pagamento Online. Entre em contato com o suporte.
5555Erro inesperado no Pagamento Online. Entre em contato com o suporte.

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âmetroDescriçãoFormatoObrigatório
merchant_usnNú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 Pagamento Online, é fortemente recomendado que o campo seja formatado e enviado pela aplicação da loja.< 12 NNÃO
order_idCódigo do pedido para ser exibido ao comprador, definido pelo lojista. É aconselhável que seja diferente a cada pedido para que facilite a rastreabilidade.
Se a integração da Loja com as redes adquirentes (Cielo, Redecard, etc) for com Pagamento Online 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 Pagamento Online, no SiTef ele será apenas 123456789012).
< 40 ANNÃO
installmentsNúmero de parcelas. Envie ‘1’ para transações à vista.< 2 NSIM
installment_typeTipo de financiamento do parcelamento:
valor 3 = parcelamento com juros da administradora do cartão.
valor 4 = parcelamento realizado pela loja e sem juros (adotar este valor como padrão/default para transações à vista).
Valor 6 = parcelamento com juros da administradora (IATA).
valor 7 = parcelamento realizado pela loja e sem juros (IATA).
O parcelamento IATA é utilizado somente por empresas do seguimento de transporte aéreo.
< 2 NSIM
authorizer_idCódigo da autorizadora no Pagamento Online. Saiba mais.< 3 NNÃO
amountValor total da compra (em centavos). Exemplo: 1,00 = 100 ou 1.100,00 = 110000 – enviar o valor sem a vírgula e ponto.< 12 NSIM
soft_descriptorTexto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador. Saiba mais< 30 ANNÃO
authorizer_authenticationEste 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/FNÃO
encrypted_cardEste 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.
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/FNÃO
iata Este elemento contém campos específicos de transações IATA.
departure_taxTaxa de embarque em centavos.< 12 NSIM apenas para installment_type = 6 ou 7
first_installmentEntrada em transações IATA em centavos. Funcionalidade disponível apenas para o adquirente Rede.< 12 NNÃO
scheduleO 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.
amountValor em centavos dos pagamentos recorrentes. Caso esse campo não seja enviado, será utilizado o valor do pagamento.< 12 NSIM
initial_dateData 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.
O formato da data a ser seguido é: DD/MM/AAAA
Exemplo: 20/04/2021
= 10 DSIM
number_of_timesNúmero de pagamentos agendados a serem executados. Caso esse campo não seja enviado, agendamento ficará ativo infinitamente.< 3 NNÃO
intervalIntervalo em meses entre cada pagamento agendado. Caso esse campo não seja enviado, assume-se o valor 1 (execuções mensais).< 2 NNÃO
do_payment_nowEnviar esse campo com valor false caso se deseje realizar um agendamento sem pagamento imediato.
No caso deste campo ser ausente ou para qualquer valor diferente de false, será criado um agendamento COM pagamento imediato.
< 5 T/FNÃO
installmentsNúmero de parcelas de cada pagamento agendado. Caso esse campo não seja enviado, assume-se o valor 1.<2 NNÃO
installment_typeTipo de financiamento do parcelamento de cada pagamento agendado:
Valor 3 = parcelamento com juros da administradora do cartão.
Valor 4 = parcelamento realizado pela loja e sem juros. (Adotar este valor como padrão/default para transações à vista).
Caso esse campo não seja enviado, assume-se o valor 4.
< 2 NNÃO
soft_descriptorTexto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador. Saiba mais< 30 ANNÃO
show_times_invoicePara 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/FNÃO
additional_dataElemento para envio de dados adicionais.
postpone_confirmationEsse campo deve ser enviado com valor true caso se deseje um pagamento com confirmação tardia.< 5 T/FNÃO
financing_planCódigo de plano de financiamento. Necessário apenas para pagamentos parcelados com juros roteados pela Via Certa Financiadora via SiTef.< 4 NCOND.
additional_data.payerElemento para envio de dados referentes ao comprador.
identification_numberDocumento de identificação do comprador (CPF/RG).< 20 ANNÃO
store_identificationIdentificaçã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, o Pagamento Online não realizará nenhuma validação.< 20 ANSIM para agendamento
additional_data.merchantElemento para envio de dados referentes ao lojista.
emailEndereço de e-mail do lojista.< 1024 ANNÃO
additional_data. extra_param.prefixesElemento para envio de prefixos do SiTef, como CICLOS, CPLANO e VLRADD. Caso o prefixo enviado não seja suportado pelo cartão enviado, o Pagamento Online invalidará a transação, impedindo que se dê uma falsa impressão do uso de uma determinada funcionalidade.

Exemplo:
{ "key" : "value" } -> { "CICLOS" : "01" }
keyNome do prefixo.< 1024 ANNÃO
valueValor do prefixo.< 1024 ANNÃ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âmetroDescriçãoFormatoObrigatório
additional_data
anti_fraud_institutionInstituição que efetuará a análise de fraude para a loja. Deve ser enviado com o valor ‘AUTHORIZER’.= 10 ANSIM para análise de fraude
anti_fraudHabilita o serviço de análise de fraude. Valores permitidos:
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.
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 ANSIM para análise de fraude
anti_fraud_criteriaCritério de execução da análise de fraude. Valores permitidos:
ON_SUCCESS – só realiza a análise se tiver sucesso na transação.
ALWAYS – sempre realiza a análise.
< 10 ANNÃO
finger_print_idIdentificador utilizado para cruzar informações obtidas pelo Browser do internauta com os dados enviados para análise. Maiores detalhes em http://apidocs.braspag.com.br/#CriandoumavendacomAnalisedeFraude.< 50 ANNÃO
giftIndica se o pedido é para presente ou não.< 5 T/FNÃO
returns_acceptedDefine se devoluções são aceitas para o pedido.< 5 T/FNÃO
journey_typeTipo de viagem. Valores permitidos:
ROUND_TRIP – ida e volta.
OUTWARD – ida.
RETURN – volta.
< 10 ANNÃO
additional_data.payer
nameNome do comprador.
Obs.: a concatenação de nome com o sobrenome não pode ultrapassar 255 caracteres.
< 200 ANNÃO
surnameSobrenome do comprador.
Obs.: a concatenação do nome com o sobrenome não pode ultrapassar 255 caracteres.
< 200 ANNÃO
emailE-mail do comprador.< 255 ANNÃO
born_dateData de nascimento do comprador, no formato YYYY-MM-DDTHH:MM:SS. Ex.: 1991-01-02T08:30:00.= 19 ANNÃO
adress_street_nameEndereço do comprador.< 255 ANNÃO
adress_street_numberNúmero do endereço do comprador.< 15 ANNÃO
adress_street_complementComplemento do endereço do comprador.< 50 ANNÃO
adress_zip_codeCEP do endereço do comprador. Ex.: 21241140.< 9 ANNÃO
cityCidade do endereço do comprador.< 50 ANNÃO
stateEstado do endereço do comprador. Ex.: SP.= 2 ANNÃO
address_countryPaís do endereço do comprador. Ex.: BRA.< 35 ANNÃO
additional_data.shipment.receiver_address
street_nameEndereço de entrega.< 255 ANNÃO
street_numberNúmero do endereço de entrega.< 15 ANNÃO
complementComplemento do endereço de entrega.< 50 ANNÃO
zip_codeCEP do endereço de entrega. Ex.: 21241-140.< 9 ANNÃO
cityCidade do endereço de entrega.< 50 ANNÃO
stateEstado do endereço de entrega.= 2 ANNÃO
countryPaís do endereço de entrega seguindo a AN 3166-1. Ex.: BRA= 3 ANNÃO
additional_data.browser
cookies_acceptedIdentifica se o browser do cliente aceita cookies. Enviar true caso positivo.< 5 T/FNÃO
emailE-mail registrado no browser do comprador.< 100 ANNÃO
host_nameNome do host onde o comprador estava antes de entrar no site da loja.< 60 ANNÃO
ip_addressEndereço IP do comprador. É altamente recomendável o envio deste campo.< 15 ANNÃO
agentNome do browser utilizado pelo comprador. Ex.: Chrome.< 40 ANNÃO
additional_data.items[]
gift_categoryCampo que avaliará os endereços de cobrança e entrega para diferentes cidades, estados ou países. Pode assumir os seguintes valores:
OFF – Ignora a análise de risco para endereços divergentes.
YES – Em caso de divergência entre endereços de cobrança e entrega, marca com risco pequeno.
NO – Em caso de divergência entre endereços de cobrança e entrega, marca com risco alto.
< 3 ANNÃO
riskNível do risco do produto. Pode assumir os seguintes valores:
LOW – O produto tem um histórico de poucos chargebacks.
NORMAL – O produto tem um histórico de chargebacks considerado normal.
HIGH – O produto tem um histórico de chargebacks acima da média.
< 6 ANNÃO
titleNome do produto.< 255 ANNÃO
quantityQuantidade do produto a ser adquirido.< 15 NNÃO
idCódigo comerciante identificador do produto.< 255 ANNÃO
unit_pricePreço unitário do produto em centavos.< 15 NNÃO
category_idTipo 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 ANNÃO
additional_data.items[].hedge
timeNível de importância da hora do dia do pedido do cliente. Pode assumir os seguintes valores:
LOW – Baixa importância no horário do dia em que foi feita a compra, para a análise de risco.
NORMAL – Média importância no horário do dia em que foi feita a compra, para a análise de risco.
HIGH – Alta importância no horário do dia em que foi feita a compra, para a análise de risco.
OFF – O horário da compra não afeta a análise de risco.
< 6 ANNÃO
hostNível de importância do e-mail e endereços IP dos clientes em risco de pontuação. Pode assumir os seguintes valores:
LOW – Baixa importância do e-mail e endereço IP na análise de risco.
NORMAL – Média importância do e-mail e endereço IP na análise de risco.
HIGH – Alta importância do e-mail e endereço IP na análise de risco.
OFF – E-mail e endereço IP não afetam a análise de risco.
< 6 ANNÃO
non_sensicalNível dos testes realizados sobre os dados do comprador com pedidos recebidos sem sentido. Pode assumir os seguintes valores:
LOW – Baixa importância da verificação feita sobre o pedido do comprador, na análise de risco.
NORMAL – Média importância da verificação feita sobre o pedido do comprador, na análise de risco.
HIGH – Alta importância da verificação feita sobre o pedido do comprador, na análise de risco.
OFF – Verificação do pedido do comprador não afeta a análise de risco.
< 6 ANNÃO
obscenitiesNível de obscenidade dos pedidos recebidos. Pode assumir os seguintes valores:
LOW – Baixa importância da verificação sobre obscenidades do pedido do comprador, na análise de risco.
NORMAL – Média importância da verificação sobre obscenidades do pedido do comprador, na análise de risco.
HIGH – Alta importância da verificação sobre obscenidades do pedido do comprador, na análise de risco.
OFF – Verificação de obscenidade no pedido do comprador não afeta a análise de risco.
< 6 ANNÃO
phoneNível dos testes realizados com os números de telefones. Pode assumir os seguintes valores:
LOW – Baixa importância nos testes realizados com números de telefone.
NORMAL – Média importância nos testes realizados com números de telefone.
HIGH – Alta importância nos testes realizados com números de telefone.
OFF – Testes de números de telefone não afetam a análise de risco.
< 6 ANNÃO
velocityNível de importância de frequência de compra do cliente. Pode assumir os seguintes valores:
LOW – Baixa importância no número de compras realizadas pelo cliente nos últimos 15 minutos.
NORMAL – Média importância no número de compras realizadas pelo cliente nos últimos 15 minutos.
HIGH – Alta importância no número de compras realizadas pelo cliente nos últimos 15 minutos.
OFF – A frequência de compras realizadas pelo cliente não afeta a análise de fraude.
< 6 ANNÃO
additional_data.items[].passenger
emailE-mail do passageiro.< 255 ANNÃO
legal_documentId do passageiro a quem o bilhete foi emitido.< 32 ANNÃO
nameNome do passageiro.< 120 ANNÃO
ratingClassificação do passageiro. Pode assumir os seguintes valores:
ADULT – Passageiro adulto.
CHILD – Passageiro criança.
INFANT – Passageiro infantil.
YOUTH – Passageiro adolescente.
STUDENT – Passageiro estudante.
SENIOR_CITIZEN – Passageiro idoso.
MILITARY – Passageiro militar.
< 14 ANNÃO
customer_classClassificação da empresa aérea. Pode-se usar valores como Gold ou Platina.< 32 ANNÃO
additional_data.items[].passenger.phone
ddiCódigo do país do telefone do passageiro. Para pedidos fora dos E.U.A., é recomendável o envio deste campo.< 3 NNÃO
dddCódigo da área do telefone do passageiro.< 3 NNÃO
numberNúmero de telefone do passageiro.< 9 NNÃO
additional_data.extra_param.acquirer_params[]
keyId das informações adicionais a serem enviadas. Maiores detalhes sobre o envio desse campo em https://developercielo.github.io/Webservice-3.0/#merchant-defined-data.< 1024 NNÃO
valueValor das informações adicionais a serem enviadas.< 1024 ANNÃO
additional_data.shipment
nameNome do destinatário da entrega.< 255 ANNÃO
methodTipo de serviço de entrega do produto. Pode assumir os seguintes valores:
SAME_DAY – Serviço de entrega no mesmo dia.
ONE_DAY – Serviço de entrega noturna ou no dia seguinte.
TWO_DAY – Serviço de entrega em dois dias.
THREE_DAY – Serviço de entrega em três dias.
LOW_COST – Serviço de entrega de baixo custo.
PICKUP – Produto retirado na loja.
OTHER – Outro método de entrega.
NONE – Sem serviço de entrega, pois é um serviço ou assinatura.
< 9 ANNÃO
additional_data.shipment.phones[]
ddiCó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 NNÃO
dddCódigo da área do telefone do destinatário da entrega.< 3 NNÃO
numberNúmero de telefone do destinatário da entrega.< 9 NNÃO
additional_data.connections[]
flight_dateData, hora e minuto de partida do voo no formato YYYY-MM-DDTHH:MM:SS. Ex.: 1991-01-02T08:30:00.= 19 ANNÃO
fromCódigo do aeroporto do ponto de origem da viagem. Ex.: CGH.= 3 ANNÃO
toCódigo do aeroporto do ponto de destino da viagem. Ex.: GYN.= 3 ANNÃ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âmetroDescriçãoFormato
codeCódigo de resposta do Pagamento Online. Qualquer código diferente de 0 significa falha. Saiba mais.< 4 N
messageMensagem de resposta do Pagamento Online.< 500 AN
payment
statusStatus da transação de pagamento no Pagamento Online. Saiba mais.= 3 AN
nitIdentificador da transação de pagamento no Pagamento Online.= 64 AN
order_idCódigo de pedido enviado pela loja na criação da transação.< 40 AN
merchant_usnNúmero sequencial único enviado pela loja na criação da transação.< 12 N
amountValor da compra especificado pela loja (em centavos) na criação da transação.< 12 N
schedule
sidIdentificador da transação de agendamento no Pagamento Online.= 64 AN
amountValor dos pagamentos agendados especificado pela loja (em centavos) na criação da transação.< 12 N
statusStatus do agendamento no Pagamento Online. Saiba mais.= 3 AN
order_idCódigo de pedido enviado pela loja na criação da transação.< 40 AN
merchant_usnNúmero sequencial único enviado pela loja na criação da transação.< 12 N