Home

Descripción general

Servicio de confirmación de recarga

Detalles de la llamada#

  • Recurso: / v3 / recharge / {nit}
  • Método HTTP: PUT
  • Formato de solicitud: JSON
  • Formato de respuesta: JSON
  • Parámetros de encabezado:

| Parámetro | Descripción | Formato | Obligatorio | | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | ----------- | | Content-Type | Debe enviarse con el valor application/json. | = 15 AN | SÍ | | Authorization | Firma de autenticidad en formato Bearer {firma}. Sepa mas.

Ejemplo: Bearer hh39458f73hf45324765ft349h5f73t4h95f34.

Este campo es obligatorio si la transacción fue creada por el proceso de firma. | < 2000 AN | COND. |

Ejemplos#

Abajo se muestra un ejemplo de una llamada de servicio de confirmación de recarga utilizando la herramienta cURL.

Solicitud:

Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br

curl
--request PUT "https://esitef-homologacao.softwareexpress.com.br/e-sitef/v3/recharge/asdfghjk12345678asdfghjk12345678asdfghjk12345678asdfghjk12345678"
--header "Content-Type: application/json"
--data-binary
{
"confirm_recharge_request":{
"confirm":"true",
"merchant_key":"AOSDJF210349H3R0374H874H3T7AHG90SF"
}
}
--verbose

Respuesta:

{
"confirm_recharge_response":{
"esitef":{
"message":"OK",
"code":"0"
},
"status":"CON",
"payment":{
"status":"CON"
}
}
}

##Parámetros de solicitud

En la tabla abajo, hay una descripción de los parámetros de solicitud para el servicio de confirmación de recarga:

| Parámetro | Descripción | Formato | Obligatorio| | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------: | :---------: | | confirm | Debe recibir el valor true si desea confirmar la recarga y el pago vinculado (si lo hay).
Debe recibir el valor false para la anulación de la recarga y el pago vinculado (si lo hay). | < 5 AN | SÍ| | merchant_key | Clave de la tienda de Portal Carat utilizada en la recarga. | < 80 AN | SÍ | | used_payment_methods[] | Métodos de pago utilizados. El envío de este campo debe seguir las mismas reglas que se describen en el [capítulo correspondiente de la ejecución de la recarga] (recarga-rest-doRecharge.md#envio-do-campo-used_payment_methods). En el caso de recarga TIM, es obligatorio enviar este campo si no desea que se utilice el tipo de pago “Otras formas” (código 99). | | COND. |

Parámetros de respuesta#

Si tiene éxito, el código de respuesta HTTP será 200. Cualquier otro código debe interpretarse como un error. En la tabla abajo se muestra la descripción de los parámetros de respuesta del servicio de confirmación de recarga:

| Parámetro | Descripción | Formato | | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------: | | status | Status de la transacción de recarga de Portal Carat. Sepa mas. | = 3 AN | | esitef | | code | Código de respuesta de Portal Carat. Cualquier código que no sea 0 (cero) significa falla. Sepa mas. | < 4 N | | message | Mensaje de respuesta de Portal Carat. | < 500 AN | | payment
| | status | Status de la transacción de Portal Carat, si corresponde. Sepa mas. | = 3 AN |