Servicio de creación de recarga
POST Autenticidad X firma#
Portal Carat tiene dos formas de autenticación de tienda en la interfaz de recarga REST: autenticidad POST o firma.
En el método POST de autenticidad, Portal Carat enviará los datos de la transacción de recarga recién creada a la URL de autenticidad registrada de la tienda.
En el método de firma, la tienda debe tener una clave pública de encriptación RSA registrada en Portal Carat y debe crear una firma JWT (JSON Web Tokens) para ser enviada en el encabezado Authorization. En este caso, la información de la transacción de recarga se devolverá directamente en la respuesta del servicio. [Más información] (autenticacao-assinatura.md)
Detalles de la llamada#
- Recurso:
/v3/recharge - Método HTTP:
POST - 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 | YES |
Authorization | La firma de autenticación de la tienda debe enviarse en el formato Bearer {assinatura}. Ejemplo: Bearer JHVGytfdgauygdauiw78264284527852897hagdg. | < 2000 AN | NO |
Ejemplos#
Abajo, se muestran algunos ejemplos de llamadas al servicio de creación de recargas mediante la herramienta cURL.
Creación de una recarga enviando todos los parámetros#
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respuesta:
POST Autenticidad:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Creación de una recarga con parámetros mínimos#
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respuesta:
Creación de recarga con envío de firma#
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respuesta:
Parámetros de solicitud#
En la tabla abajo se muestra la descripción de los parámetros de solicitud del servicio de creación de recargas:
| Parámetro | Descripción | Formato | Obligatorio |
|---|---|---|---|
merchant_key | Clave de la tienda registrada con el Portal Carat | < 80 A | SÍ |
merchant_usn | Número secuencial único generado por la tienda | < 12 N | NO |
order_id | Código de identificación del pedido generado por la tienda | < 20 AN | NO |
general_hash | Código de identificación de la versión de la tabla que contiene los datos de recarga (operadores, sucursales, escalones de valores, validaciones de crédito, entre otros). Si la tienda no no ha realizado una recarga previamente o no ha guardado un valor de general_hash recibido previamente de Portal Carat, se puede pasar el valor: 0000000000000000 se puede pasar a Portal Carat. Este campo permite al comerciante saber si ha habido un cambio en la recarga datos. Esto se debe a que si hubiera algún cambio en la tabla, el general_hash devuelto será diferente del general_hash que tiene el comerciante. En este caso, es recomendable que el propietario de la tienda realice las consultas y actualice los valores de los operadores de recarga en su aplicación. | ||
| = 16 A | NO | ||
recharge_type | Tipo de recarga a realizar. Valores:
normal | = 6 A | NO |
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 creación de recargas:
| Parámetro | Descripción | Formato |
|---|---|---|
nit | Identificación de la transacción de recarga de Portal Carat Portal | = 64 AN |
merchant_id | Código de identificación de la tienda de Portal Carat | < 15 AN |
order_id | Código de identificación del pedido generado por la tienda | < 20 AN |
merchant_usn | Número secuencial único generado por la tienda | < 12 N |
general_hash | Código de identificación de tabla con datos relacionados con recargas (operadores, sucursales, escalones de valores, validaciones de crédito, entre otros). | = 16 AN |
| esitef | Elemento que describe la respuesta de Portal Carat. | |
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 |
Parámetros de POST Autenticidad#
En la siguiente tabla, hay una descripción de los parámetros enviados por Portal Carat en el POST de autenticidad:
| Parámetro | Descripción | Formato |
|---|---|---|
nit | Identificación de la transacción de recarga de Portal Carat | = 64 AN |
merchantId | Código de identificación de la tienda de Portal Carat | < 15 AN |
orderId | Código de identificación del pedido generado por la tienda | < 20 AN |
merchantUSN | Número secuencial único generado por la tienda | < 12 N |
generalHash | Código de identificación de tabla con datos relacionados con recargas (operadores, sucursales, escalones de valores, validaciones de crédito, entre otros). | = 16 AN |
Pago Online también puede enviar nuevos parámetros sin previo aviso, lo que significa que la aplicación de la tienda debe estar preparada para recibir campos adicionales y simplemente ignorarlos.
Parámetros enviados por Portal Carat en HTTPS POST#
Importante:
Portal Carat utiliza el tipo de medio
x-www-form-urlencoded, para enviar POST HTTPS. Por lo tanto, el servidor debe aceptar este tipo de medios en la URL que está registrada para recibir el POST HTTPS.
| Parámetro
| Descripción | Formato |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | :------------: |
| nit | Identificación de la transacción de recarga de Portal Carat | = 64 AN |
| merchantId | Código de identificación de la tienda de Portal Carat | < 15 AN |
| orderId | Código de identificación del pedido generado por la tienda | < 20 AN |
| merchantUSN | Número secuencial único generado por la tienda | < 12 N |
| generalHash | Código de identificación de tabla con datos relacionados con recargas (operadores, sucursales, escalones de valores, validaciones de crédito, entre otros). | = 16 AN |