Serviço de confirmação de recarga

Detalhes da chamada

• Recurso: /v3/recharge/{nit}
• Método HTTP: PUT
• Formato da requisição: JSON
• Formato da resposta: JSON
• Parâmetros de cabeçalho:

Parâmetro	Descrição	Formato	Obrigatório
Content-Type	Deve ser enviado com o valor application/json.	= 15 AN	SIM
Authorization	Assinatura de autenticidade no formato Bearer {assinatura}. Saiba mais. Exemplo: Bearer hh39458f73hf45324765ft349h5f73t4h95f34. Este campo é obrigatório caso a transação tenha sido criada pelo processo de assinatura.	< 2000 AN	COND.

Exemplos

Abaixo está um exemplo de chamada do serviço de confirmação de recarga utilizando a ferramenta cURL.

Requisição:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

curl

--request PUT "https://{{url}}/e-sitef/v3/recharge/asdfghjk12345678asdfghjk12345678asdfghjk12345678asdfghjk12345678"

--header "Content-Type: application/json"

--data-binary

{

"confirm_recharge_request":{

"confirm":"true",

"merchant_key":"AOSDJF210349H3R0374H874H3T7AHG90SF"

}

}

--verbose

Resposta:

{

"confirm_recharge_response":{

"esitef":{

"message":"OK",

"code":"0"

},

"status":"CON",

"payment":{

"status":"CON"

}

}

}

Parâmetros de requisição

Na tabela abaixo está a descrição dos parâmetros de requisição do serviço de confirmação de recarga:

Parâmetro	Descrição	Formato	Obrigatório
confirm	Deve receber o valor true caso se deseje confirmar a recarga e o pagamento atrelado (caso exista). Deve receber o valor false para o desfazimento da recarga e do pagamento atrelado (caso exista).	< 5 AN	SIM
merchant_key	Chave da loja no Carat utilizada na recarga.	< 80 AN	SIM
used_payment_methods[]	Formas de pagamento utilizadas. O envio deste campo deve seguir as mesmas regras descritas no capítulo correspondente da efetivação de recarga. No caso de recarga TIM, é obrigatório enviar esse campo caso não deseje que seja assumido o tipo de pagamento “Outras formas” (código 99).		COND.

Parâmetros de resposta

Em caso de sucesso, o código de resposta HTTP será 200. 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 confirmação de recarga:

Parâmetro	Descrição	Formato
status	Status da transação de recarga no Carat. Saiba mais.	= 3 AN
esitef
code	Código de resposta do Carat. Qualquer código diferente de 0(zero) significa falha. Saiba mais.	< 4 N
message	Mensagem de resposta do Carat.	< 500 AN
payment
status	Status da transação de pagamento no Carat, caso exista. Saiba mais.	= 3 AN