Serviço de efetivação de pagamento

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 Pagamento Online 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â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 efetivação de pagamento utilizando a ferramenta cURL.

Pagamento com captura automática#

Requisição:

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

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

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

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

Requisição:

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

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

Pagamento split para roteamentos BIN e Sipag via SiTef#

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/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"
},
"acquirer":{
"submerchant_split":[
{
"submerchant_code":"empresa01",
"submerchant_amount":"10"
},
{
"submerchant_code":"empresa02",
"submerchant_amount":"20"
},
{
"submerchant_code":"empresa03",
"submerchant_amount":"20"
},
{
"submerchant_code":"empresa04",
"submerchant_amount":"30"
},
{
"submerchant_code":"empresa05",
"submerchant_amount":"30"
}
]
}
}
--verbose

Resposta:

{
"code": "0",
"message": "OK. Transaction successful.",
"payment": {
"authorizer_code": "000",
"authorizer_message": "APROVADA",
"status": "CON",
"nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
"authorizer_id": "1",
"acquirer_id": "229",
"acquirer_name": "Bin",
"authorizer_date": "29/03/2019T13:26",
"authorization_number": "000058",
"merchant_usn": "20180809",
"esitef_usn": "190329026585100",
"sitef_usn": "000058",
"host_usn": "003000058 ",
"amount": "13000",
"payment_type": "C",
"issuer": "1",
"authorizer_merchant_id": "000000000000000",
"payment_date": "29/03/2019T13:26"
}
}

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 efetivação de pagamento:

ParâmetroDescriçãoFormatoObrigatório
authorizer_idCódigo da autorizadora no Pagamento Online. Saiba mais.
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 NCOND.
customer_postal_codeCó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 NCOND.
mccO MCC (Merchant Category Code) é um código que classifica um negócio pelo tipo de bens ou produtos fornecidos.< 4 NNÃO
subacquirer_merchant_idIdentificação da loja na subadquirente.< 22 NNÃO
cardDados do cartão.
numberNúmero do cartão do comprador (PAN).< 19 NSIM
expiry_dateData de vencimento do cartão no formato MMAA. Sua obrigatoriedade depende do adquirente escolhido. Na maioria dos casos, esse campo é obrigatório.= 4 NCOND.
security_codeCó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.
Importante: um pagamento com agendamento implica no armazenamento dos dados do cartão do comprador no ambiente do Pagamento Online. 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 NCOND.
holderNome do portador do cartão. Obrigatório apenas para pagamentos com e-Rede, GetNet WS e VR (SmartNet).< 30 ANCOND.
tokenHASH de um cartão armazenado no Pagamento Online. 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 ANNÃO
wallet_transaction_idID 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.
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 ANNÃO
initial_wallet_transaction_idInforma 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/FNÃO
external_authenticationEste elemento recebe campos de resultados de autenticação MPI.
eciEletronic Commerce Indicator – indica o nível de segurança da transação com autenticação do dono do cartão< 3 NNÃO
xidIdentificador da transação de autenticação do dono do cartão, feita em serviço externo ao Pagamento Online< 40 NNÃO
cavvCardholder Authentication Verification Value - Código que indica o resultado da autenticação do dono do cartão.< 40 NNÃO
acquirerDados específicos necessários dependendo da adquirente/roteamento.
financing_planCódigo de plano de financiamento. Necessário apenas para pagamentos parcelados com juros roteados pela Via Certa Financiadora via SiTef.< 4 NNÃO
special_codeCódigo de uso geral da Conductor/Renner.< 6 NNÃO
recurrencyFlag 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.
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/FNÃO
recurrency_tidTID 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 ANNÃO
is_first_recurringFlag usada apenas para roteamento StoneWS. Indica que a transação é a primeira de uma série de transações recorrentes.< 5 T/FCOND.
is_subsequent_recurringFlag 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/FCOND.
product_codeCódigo de produto.
É obrigatório em roteamento via Marisa.
< 6 NCOND.
terminalTerminal SiTef que se deseja usar. Se não for enviado, o Pagamento Online gerará um terminal aleatório.= 14 NNÃO
company_codeCódigo de empresa SiTef que se deseja usar. Se não for enviado, o Pagamento Online enviará o código de empresa cadastrado na loja.= 8 NNÃO
authorization_numberCódigo de autorização. Obrigatório para autorizadora Bradescard Voucher.< 6 ANCOND.
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.
Exemplo:
Não se quer aceitar Vouchers: Cultura, Combustível, Benefício. Deve enviar:
"vouchers_filter": [ "03", "04", "05" ]
acquirer.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
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.
O máximo de itens permitido neste array é de 5 itens. Cada item é composto pelos campos submechant_code e submerchant_amount.
submerchant_codecódigo de estabelecimento BIN/Sipag< 51 ANNÃO
submerchant_amountvalor de transação referente ao estabelecimento< 12 NNÃ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 e-SiTef 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â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
authorizer_codeCódigo de resposta do autorizador.< 10 AN
authorizer_messageMensagem de resposta do autorizador.< 500 AN
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
sitef_usnNúmero sequencial único da transação de pagamento no SiTef.= 6 N
esitef_usnNúmero sequencial único da transação de pagamento no Pagamento Online.= 15 N
customer_receiptCupom (via cliente).< 4000 AN
merchant_receiptCupom (via estabelecimento).< 4000 AN
authorizer_idCódigo da autorizadora utilizada na transação.< 4 N
acquirer_idCódigo do adquirente utilizado na transação.< 4 N
acquirer_nameNome do adquirente utilizado na transação.< 100 AN
authorizer_dateData de efetivação do pagamento retornada pelo autorizador no formato DD/MM/AAAA'T'HH:mm. Exemplo: 13/07/2017T16:03= 16 D
authorization_numberNúmero de autorização.< 6 AN
host_usnNSU da autorizadora.< 15 AN
tidID da transação no adquirente. Este campo só é retornado em transações com adquirentes externos ao SiTef.< 40 AN
eciEletronic Commerce Indicator (indicador do nível de segurança da transação do pagamento via Cielo e-Commerce).< 3 AN
payment_dateData de efetivação do pagamento no Pagamento Online no formato DD/MM/AAAA'T'HH:mm. Exemplo: 13/07/2017T16:03= 16 D
issuerCódigo da bandeira retornado pelo autorizador.< 5 AN
authorizer_merchant_idCódigo de afiliação do lojista na autorizadora.< 100 AN
xidCampo XID retornado em autenticações 3DS ou certos adquirentes.< 40 AN
authentication_urlURL de autenticação retornada em fluxos de pagamento com autenticação. Disponível apenas para Cielo e-Commerce.< 56 AN
balanceSaldo disponível após pagamentos com cartões tipo Gift.< 12 N
recurrency_tidId 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.analysis
codeCódigo de resposta da operação de análise de fraude.< 4 N
messageMensagem de resposta da operação de análise de fraude.< 200 AN
statusStatus da transação de análise de fraude do Pagamento Online. Este campo pode assumir os seguintes valores:
NOV – Nova.
EXP – Expirada.
ACC – Aceita
REJ – Rejeitada
REV – Em revisão
INV – Inválida
= 3 AN
schedule
statusStatus do agendamento no Pagamento Online. Saiba mais.= 3 AN
sidIdentificador da transação de agendamento no Pagamento Online.= 64 AN
schedule_usnNúmero sequencial único do agendamento no Pagamento Online.= 15 N
authorizer_idCódigo da autorizadora a ser utilizada nos pagamentos agendados.= 4 N
amountValor dos pagamentos agendados especificado pela loja (em centavos) na criação da transação.< 12 N
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
initial_dateData de execução do primeiro pagamento agendado no formato DD/MM/AAAA.= 10 D
next_dateData de execução do próximo pagamento agendado no formato DD/MM/AAAA.= 10 D
number_of_timesNúmero total de pagamentos agendados.< 3 N
installmentsNúmero de parcelas a ser utilizado nos pagamentos agendados.< 2 N
installment_typeTipo de financiamento a ser utilizado nos pagamentos agendados.< 2 N
soft_descriptorTexto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador.< 30 AN
show_times_invoicePara 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_idCódigo do terminal utilizada na transação< 8 AN
recurrency_tidId 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