Servicio de consulta de recarga
Esta llamada le permite a la tienda ver el estado de una transacción de recarga y un pago vinculado (si corresponde) en Portal Carat, en cualquier momento dentro del flujo, después de crear una recarga.
Aviso:
La consulta del estado de la transacción en Portal Carat NO consulta el estado de la transacción del adquirente / autorizador. Este servicio devuelve el estado de la transacción en la base de datos de Portal Carat.
Ejemplo: Si se confirma una transacción de pago en Portal Carat, pero se revierte por teléfono directamente al adquirente / autorizador, esta anulación no se reflejará necesariamente en el servicio de consulta del estado de la transacción de Portal Carat.
Detalles de la llamada#
- Recurso:
/v3/recharge/{nit} - Método HTTP:
GET - Formato de la solicitud:
query string - Formato de la respuesta:
JSON - Parámetros de encabezado:
| Parámetro | Descripción | Formato | Obligatorio |
|---|---|---|---|
Authorization | Firma de autenticidad en formato Bearer {assinatura}. [Más información.] (autenticacao-assinatura.md)Ejemplo: Bearer hh39458f73hf45324765ft349h5f73t4h95f34. Este campo es obligatorio si la transacción se creó mediante el proceso de firma. | < 2000 AN | COND. |
Ejemplos#
A continuación se muestra un ejemplo de cómo llamar al servicio de consulta de recarga mediante la herramienta cURL.
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 siguiente tabla se muestra la descripción de los parámetros de solicitud del servicio de consulta de recarga:
| Parámetro | Descripción | Formato | Requerido |
|---|---|---|---|
nit | Identificación de la transacción de recarga en Portal Carat | = 64 AN | SI |
merchantkey | Clave de la tienda de Portal Carat utilizada en la recarga. | < 80 AN | SI |
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 siguiente tabla se muestra la descripción de los parámetros de respuesta del servicio de consulta de recarga:
| Parámetro | Descripción | Formato |
|---|---|---|
status | Status de la transacción de recarga en Portal Carat. [Más información.] (codigos-da-api.md#status-de-transacões-do-e-sitef) | = 3 AN |
order_id | Código de pedido generado por la tienda. | < 20 AN |
merchant_usn | Transacción generada por la tienda NSU. | < 12 N |
send_payment_methods | Flag que indica que los métodos de pago utilizados se pueden enviar en la próxima transacción. Tendrá el valor true en caso afirmativo. | < 5 N |
| esitef | ||
code | Código de respuesta de Portal Carat. Cualquier código que no sea0 (cero) significa falla. Más información. | < 4 N |
message | Mensaje de respuesta de Portal Carat. | < 500 AN |
usn | NSU de la transacción de recarga en el Portal Carat | = 15 N |
| authorizers[] | Este campo agrega una lista de elementos. | |
name | Nombre del autor | < 16 AN |
code | Código de respuesta devuelto por el autorizador | < 4 AN |
message | Mensaje devuelto por el autorizador | < 64 AN |
| acquirer | ||
branch_code | Código de sucursal de recarga, responsable de recargar el conjunto de operadora DDD +. | < 5 N |
merchant_code | Código de la tienda registrada con el adquirente | < 15 N |
| authorization | ||
confirm_data | código de confirmación | < 128 AN |
authorizer_date | Fecha de la autorización en la autorizadora en el formato MMDD | = 4 N |
authorizer_time | Horário de la autorización en la autorizadora en el formato HHmmSS | = 6 N |
host_usn | NSU del Host | < 20 N |
sitef_usn | NSU del SiTef | < 10 N |
number | Número de la autorización en la autorizadora | < 6 N |
| customer | ||
total_copies | Número de copias del recibo del cliente | < 2 N |
receipt | Cupón de cliente | < 4000 AN |
| merchant | ||
total_copies | Número de copias del bono del establecimiento | < 2 N |
receipt | Prueba de establecimiento | < 4000 AN |
| payment_methods | ||
max | Número máximo de métodos de pago | < 2 N |
| payment_methods.available[] | Este campo agrega una lista de métodos de pago disponibles. | |
name | Nombre del método de pago disponible. [Más información.] (recarga-rest-listBranchData.md#retorno-do-campo-payment_methodsavailable) | < 200 AN |
| payment | Este elemento solo se devuelve si se ha enviado un pago vinculado a la recarga. | |
status | Estado de la transacción de pago en Portal Carat. [Más información.] (codigos-da-api.md#status-de-transacões-do-e-sitef) | = 3 AN |
amount | Importe del pago, el mismo que se envió cuando se creó la transacción de pago. | < 12 AN |
type | Tipo de pago del autorizador elegido:
| = 1A |
authorizer_id | Identificación del autorizador en Portal Carat donde se realizó el pago | < 5 N |
adquiriente | Tipo de pago | < 50 AN |
| pago.esitef | ||
usn | NSU de Portal Carat | < 15 AN |
date | Fecha de pago en formato DD / MM / AAAA hh: mm en Portal Carat. | < 19A |
| pago.sitiof | ||
code | Código de respuesta devuelto por SiTef | = 3 AN |
| payment.customer | ||
receipt | Comprobante de pago (a través del cliente) | < 4000 AN |
| payment.merchant | ||
receipt | Comprobante de pago (a través del establecimiento) | < 4000 AN |
| payment.authorization | ||
number | Número de autorización de pago | < 6 AN |
sitef_usn | SiTef NSU | < 15 AN |
host_usn | Autorizador NSU | < 15 AN |
tid | ID de transacción en el autorizador, devuelto para algunos tipos de pago. | < 40 AN |
eci | Eletronic commerce indicator devuelto por algunos tipos de pago. | < 3 AN |
sitef_date | Fecha de pago en formato DD / MM / AAAA hh: mm en SiTef. | < 19 AN |
| payment.analysis | ||
status | Status de la transacción en la institución de revisión. | = 3 AN |
code | Código de respuesta al análisis de riesgos. | < 4 AN |
message | Mensaje de respuesta al análisis de riesgos. | < 100 AN |
| payment.extra_param[] | ||
key | Clave de parámetro adicional | N / A |
value | Valor de parámetro adicional | N / A |
| hashes | Hashes que indican el estado de los cambios en las tablas de recarga | |
general | Hash general de tablas de recarga. Este hash se cambiará si se cambia alguno de los hash de una red específica. | = 16 AN |
wallet | Hash las tablas de recarga para una red específica. Si las tablas de la red de recarga cambian, el hash devuelto en este campo también cambiará. Los datos devueltos en este campo tienen el siguiente formato: <Rede>:<Hash>:<Serviço 1>,< Serviço 2>, <Serviço N> Onde:
Ejemplo de datos devueltos en este campo: 106:0D0C4FCB0D0C4FCB:F1-1,F1-3 | < 100 AN |
Consultar transacciones en un grupo de tiendas#
Portal Carat requiere que las credenciales (mercantil clave) sean las mismas que se utilizaron en la transacción que se va a consultar. Sin embargo, si el comerciante lo necesita, Portal Carat puede permitir consultas con credenciales de otras tiendas del mismo grupo. Para hacer esto, solo solicite a nuestros equipos de soporte y producción que realicen este lanzamiento.