Da clic en el icono de cada lenguaje de programación para consultar los ejemplos de las peticiones a nuestra API en el lenguaje de tu preferencia.

Referencia de la API

Error 400

Error 404

ESQUEMA DEL CUERPO DE LA PETICIÓN:

ESQUEMA DE LA RESPUESTA:

Respuesta

Autenticar

Auth

Token caducado o no presente en el header de autorización.

Error 401

Actualizar refresh token

Validar token [del lado del servidor]

Añadir uuid (debe coincidir con el enviado en el payload de la transacción) para obtener recomendaciones personalizadas de nuestro algoritmo de perfil. Cuantos más datos transaccionales recopilemos de cada cliente anónimo, más específicas serán las recomendaciones.

Aplicar filtros a la solicitud para obtener ofertas mejor orientadas. Este parámetro recibe un string o un valor separado por comas si se aplican varios filtros. La pila de filtros está limitada a 3 y se aplican en el orden de envío.

Para el correcto uso del filtro de name, se debe enviar en el mismo parámetro el nombre a buscar.

Para el correcto uso del filtro de offerType, se debe proporcionar el valor recurring o first_time. Se obtendrá un atributo en la respuesta quickType en el que mostrará de qué tipo de oferta se trata.

Esta ordenación se hará por el parámetro de descuento en la oferta.

Este ordenamiento se realizará por la fecha de insertado de las ofertas.

Ordenar la colección resultante en orden ascendente o descendente.

Número de elementos por página que se recuperan con la solicitud. Ver otros parámetros de paginación 'p'. El valor por defecto de 'epp' es de 10 elementos. Hemos incluido los siguientes indicadores de paginación: pages, page, hasNextPage, hasPrevPage, como parte de la respuesta para facilitar la integración con la mayoría de las soluciones de UI de paginación. Si epp=0, devuelve todas las ofertas sin paginar, i.e. todas las ofertas en la misma página.

Número de elementos por página que se recuperan con la solicitud. Ver otros parámetros de paginación 'epp'. El valor por defecto de 'p' es 1.

Error de sintaxis o falta de un filtro en el payload cuando filters es invocado.

No hay resultados que coincidan con sus criterios (filtros).

Directorio de Rewards

401: No autorizada

El estado 403 indica que es posible que no tengas suficientes permisos para ejecutar esta acción. No se trata de un error de autenticación, sino de algo relacionado con los permisos específicos de su cuenta. Si obtienes este error en uno de los endpoints mencionados en esta documentación, ponte en contacto con nuestro equipo de soporte.

403: Prohibida

El servidor no puede encontrar el recurso solicitado.

404: No encontrado

Este error indica que el servidor detectó una circunstancia no prevista que le impide completar la petición. Si recibes este error, por favor, intenta más tarde y si persiste, repórtalo a integrate@reworth.co. con el asunto: "Error 500 recurrente".

500: Error interno del servidor

Esto significa que nuestro servidor no está disponible temporalmente.

503: Servicio no disponible

Errores HTTP generales

Errores

Health

Servicio no disponible: estamos experimentando una breve interrupción y volveremos pronto.

Error 503

ESQUEMA DE RESPUESTA:

Ping check

¿Te resultó útil esta información?

Muestra el directorio de ofertas cashback

Enviar transacciones para procesamiento

Configurar webhooks para recibir cambios de estado

Vista previa de la API

httpBearer

Autenticación

Flujo de Autenticación de la API

¿Cómo generar tus API keys?

Configura tus webhooks

Descarga la especificación de OpenAPI:

REWORTH API (0.12.5)

Que te permiten conocer mejor a tus clientes

Recompensas

cashback

Muestra de petición

Muestra de respuesta

Conoce cómo funciona el procesamiento de transacciones en el siguiente diagrama

El identificador de la solicitud dado al lote

Obtener transacciones por lote

Transactions

Es un identificador de petición, en consecuencia, debe ser diferente por cada envío de transacciones. Su función es distinguir cada lote de transacciones enviado a REWORTH. Recomendación: tener un registro de estos ids para poder realizar posteriores consultas (ver Obtener transacciones por lote).

Arreglo de objetos en el que es posible enviar una transacción o transacciones por lote.

Referencia única del consumidor asignado por la institución financiera el cual se compone de un prefijo de dos letras mayúsculas provisto por REWORTH para cada integración, mas un uuid generado por la institución financiera el cual se compone de 36 caracteres (32 caracteres hexadecimales y 4 guiones). Este puede ser utilizado en su versión 1 o 4.

Valor monetario de la transacción. Los últimos dos dígitos son decimales. Por ejemplo, si el valor de la transacción fue de $1 MXN, el valor a enviar es 100.

Valor monetario de la propina o consumo adicional de la misma transacción

Identificador unico por transacción asignado por la institución financiera.

El código de la moneda en la que se efectúo la transacción con base en el estándar ISO 4217. Para pesos mexicanos el código es 484.

Es la referencia de la transacción al interno de la institución financiera.

Es la paridad usada para convertir el importe de liquidación a la moneda de destino.

Número de autorización que la institución financiera asigna a la transacción.

Type de transacción. El valor debe ser siempre "charge".

Identificador de la terminal punto de venta en la que se efectuó la transacción.

Objeto que contiene la información del comercio donde se efectuó la transacción.

Número de afiliación de la terminal punto de venta o proveedor de pagos con el que se efectuó la transacción.

Merchant Category Code. Número de cuatro dígitos que describe la principal actividad comercial del comercio y que es asignado por las instituciones financieras. El valor por defecto es 0000.

Es posible que falte algún key attribute.

Responses

Procesar transacción(es) de cashback

Configurar el valor como "false" para evitar poblar el objeto "contact" contenido en "data".