Objetivo
Niveles de Servicio y alcance
Diagrama de Flujo
Mecanismos de seguridad
Servicios Web
Consulta de Referencia
Autorización de Pago
Cancelación de Pago
Autenticación Consulta Reembolso
Consulta de Reembolso
Especificaciones
Complementos
Este documento describe como crear una conexión con La Plataforma Tecnológica de CLUBPAGO que permita procesar en línea tus pagos recibidos en los puntos de venta afiliados a CLUBPAGO.
Definiciones y abreviaciones utilizadas
| Abreviación | Descripción |
| JSON | (acrónimo de JavaScript Object Notation, «notación de objeto de JavaScript») es un formato de texto sencillo para el intercambio de datos |
| Mensajería | Modelo de comunicación, Mensaje es la información dirigida de un emisor a un receptor. Donde ambos conocen la estructura y los conceptos de la información |
| PDV | Punto de Venta |
| Timeout | El tiempo estipulado de espera máxima para la respuesta entre emisor y receptor |
| EMISOR | Es el proveedor de servicio que requiere el pago |
| Cliente | Es el cliente final o usuario del servicio del Emisor. Es el que acude al PDV y realiza el pago |
| Referencia | Identificador de pago que presenta el Cliente al realizar su pago |
| URL | Uniform Resource Locator, es la dirección específica que se asigna a cada uno de los recursos disponibles en la red con la finalidad de que estos puedan ser localizados o identificados. |
| HTTPS | Protocolo de conectividad seguro utilizado para la Mensajería |
| SPEI | Sistema de Pagos Electrónicos Interbancarios para pagos entre cuentas de bancos en México. |
NIVELES DE SERVICIO
| Disponibilidad de servicio Plataforma CLUBPAGO |
99% |
| Tiempo de respuesta máxima de conector CLUBPAGO |
5 segundos |
| Tiempo compromiso de procesamiento de un pago, desde la captura de referencia, hasta concluir con recepción de pago | 40 segundos |
Alcance
Al desarrollar este conector en línea con CLUBPAGO te permitirá, validar al momento que tu cliente realiza el pago, si su Referencia es válida y vigente. Además, si así se requiere; podrás enviar al punto de venta que lo recibe, el monto exacto a pagar o en su defecto aceptar pagos con montos parciales.
Con este conector también recibirá notificaciones de pagos recibidos por SPEI (Transferencias electrónicas). Previamente utilizando nuestra herramienta tecnológica Generador de Referencias, tu plataforma deberá solicitar una CLABE ÚNICA para identificar tu cliente o pago. Al solicitarla se te entrega REFERENCIA CLUBPAGO Y CLABE ÚNICA, las cuales deben ser almacenadas en tu base de datos en el registro de tus clientes.
Al recibir un SPEI se te notificará el pago utilizando la Referencia CLUBPAGO que tu plataforma tiene almacenado en tu base de datos para identificar a tu cliente o pago. Esta notificación del pago, la podrás validar con la Referencia CLUBPAGO: la vigencia y monto, pudiendo aceptar o rechazar el pago. Si lo rechazas no se aceptará la transferencia bancaria (SPEI) de tu cliente y en el estado de cuenta de su banco recibirá la cancelación de su transferencia SPEI en el momento.
CLUBPAGO reportará pagos recibidos por tarjeta de crédito o débito en tiempo real al conector del Emisor
DIAGRAMAS DE FLUJO PARA RECIBIR PAGOS EN LÍNEA DEL EMISOR
1.- Pagos en Efectivo en PDV de Cadenas
1.- El cliente acude a un PDV de la Red de Distribución de CLUBPAGO y solicita el pago, con identificación de Referencia. El PDV envía transacción para validar a CLUBPAGO y esta verifica si es una referencia válida e identifica deque EMISOR corresponde.
2.- Si el EMISOR tiene conexión en línea, CLUBPAGO manda llamar a la Consulta de Referencia en el conector del EMISOR para validar referencia.
3.- El conector del EMISOR envía a CLUBPAGO respuesta con autorización o rechazo del pago de acuerdo a la Referencia. Si autoriza podrá mandar monto actualizado y si acepta pago parcial.
4.- CLUBPAGO envía al PDV, si la referencia es válida, monto a pagar y si acepta pagos parciales.
5.- El PDV solicitará al cliente, la confirmación de su pago y monto a pagar el cual captura. Si el cliente acepta y paga, el PDV enviará solicitud de confirmación de pago.
6.- CLUBPAGO llama al conector del EMISOR la autorización del pago, enviando datos de monto pagado.
7.- EMISOR responde a CLUBPAGO la solicitud de autorización de pago, enviando mensaje de error o emite número de autorización de pago.
8.- CLUBPAGO entrega autorización de pago y texto de ticket al PDV. PDV emiteticket y entrega a cliente.
Si CLUBPAGO no recibe confirmación de que recibió el pago el PDV, se solicitará al EMISOR la cancelación del pago.
2.- Pagos por transferencia interbancaria SPEI
1.- El cliente utilizando su app (celular o PC) de Banco realiza una transferencia SPEI a la CLABE ÚNICA/Banca que le proporciono el Emisor para pagar con Transferencia electrónica bancaria. CLUBPAGO recibe transferencia y válida que la CLABE sea válida e identifica a que Emisor pertenece y obtiene la Referencia CLUBPAGO que identifica a que cliente del EMISOR corresponde.
2.- Si el EMISOR tiene conexión en línea, CLUBPAGO manda llamar a la Consulta de Referencia en el conector del EMISOR para validar Referencia CLUBPAGO.
3.- El conector del EMISOR envía a CLUBPAGO respuesta que autoriza o rechazael pago de acuerdo a la Referencia CLUBPAGO.
4.- CLUBPAGO confirma aceptación o rechazo de SPEI al Banco de acuerdo a respuesta del
EMISOR.
El monto no se puede controlar en una operación de pago, si la cantidad enviada por SPEI por parte de su cliente no es la correcta, es responsabilidad del Emisor recibirla como pago parcial o rechazarla. Esto es en función de las reglas de negocio del EMISOR.
3.- Pagos por tarjeta crédito/débito
1.- El cliente utiliza la web CLUBPAGO para hacer su pago con tarjeta o la web diseñada por el Emisor que mande llamar la URL de pago con tarjeta,entregada en herramienta de GENERADOR DE REFERENCIA. La liga de pago con tarjeta (URL) ya tiene documentado: Referencia CLUBPAGO, Descripcióny monto a pagar. Si el Emisor no genera liga de pago, CLUBPAGO valida que la Referencia CLUBPAGO capturada por el cliente sea válida e identifica a que Emisor pertenece.
2.- El cliente utiliza la liga de pago (Servicio Getnet Santander) y documenta su tarjeta y realiza proceso de autenticación del banco, para que su pago sea aprobado.
3.- CLUBPAGO recibe y registra en su Plataforma el resultado de la operación de pago con tarjeta el cual puede ser EXITOSA o FALLIDA de acuerdo a la respuesta de la Institución financiera a la que pertenece la tarjeta.
4.- Si el EMISOR tiene conexión en línea, CLUBPAGO reporta pago con tarjeta a su conexión.
El monto no se puede controlar en una operación de pago por tarjeta si no se generó previamente la liga de pago con tarjeta, si la cantidad enviada en pago con tarjeta por parte de su cliente no es la correcta, es responsabilidad del Emisor recibirla como pago parcial o pago a revisión con el cliente.
4.- Proceso de cancelación
1.- El PDV presenta un problema al recibir el pago y CLUBPAGO debe solicitar la cancelación del pago al EMISOR.
2.- Si el EMISOR tiene conexión en línea, CLUBPAGO manda llamar el servicio de cancelación de pago al EMISOR.
3.- El EMISOR debe confirmar que el servicio de pago, ha sido cancelado.
CLUBPAGO implementará un proceso cancelación, sin embargo, la solicitud de cancelación se podrá enviar dentro del mismo día donde se autorizó el pago de parte del EMISOR
a. Datos Dinámicos. CLUBPAGO permite al Emisor conformar su Referencia CLUBPAGO de acuerdo a sus necesidades; a continuación, se describen cada uno de los datos que podrá incluir o no, en la formación de su código.
b. Identificador: Debe ser un dato numérico único que identifica plenamente a su cliente.
I. El Emisor puede decidir el número de dígitos para identificar a su cliente o pago, la longitud es variable.
II. Monto: Este dato si se incluye permitirá que La Plataforma Tecnológica de CLUBPAGO obligue que, para completar exitosamente el proceso de pago, el monto pagado debe ser igual a este valor contenido en su Referencia. Esta opción la deberán utilizar si el Emisor requiere recibir un monto exacto, como pudiera ser el caso de compras por internet donde al contener en el código de barras el monto exacto a pagar; hará que el cliente realice un pago con la cantidad exacta requerida y evitar problemas con su cliente.
Desde luego el Monto debe ser numérico con el número de decimales que así convenga al Emisor. Se sugiere 8 dígitos con 2 decimales.
Ahora si su necesidad no requiere restringir a un monto especifico a pagar, simplemente no incluirlo en el código.
III. Fecha vigencia: De igual forma si el pago del Emisor tiene una fecha límite. Y una vez se rebase esta fecha el pago no puede ser aceptado, es conveniente incluirlo en la Referencia. Si, aunque se tenga una fecha límite de pago, se pueden aceptar pagos vencidos, la recomendación seria no incluir fecha en la Referencia.
IV. Para el caso en que el Emisor usa el API de CLUBPAGO , no será necesario incluir monto y/o fecha vigencia, ya que al recibir el pago V. el conector del Emisor se le pide validar la referencia antes de recibir pago.
c. Dígito Verificador (DV). El DV es de un solo 1 digito y busca ser un código de control que evite capturas incorrectas cuando por cualquier razón no se utiliza un lector de código de barras si no que se teclea. Gracias a este DV se pueden detectar errores del cajero en el tecleo. La generación del dígito verificador deberá ser en Mod10. *La generación del dígito verificador deberá ser en Mod10 Aquí su algoritmo de generación.
d. Ejemplos:
1. “LA EMPRESA” requiere una referencia para identificar el cliente y/o pago. Su id de identificación de su cliente o orden de pago es de 6 dígitos
MECANISMOS DE SEGURIDAD PARA EL CONECTOR DEL EMISOR
El EMISOR debe definir la ubicación su conector, para que la Plataforma CLUBPAGO realice las solicitudes de servicio al EMISOR.
El EMISOR debe definir la ubicación su conector, para que la Plataforma CLUBPAGO realice las solicitudes de servicio al EMISOR.
https://[BASE_URL]/
Donde [BASE_URL] es la URL del EMISOR
Se requiere que para un ambiente de producción es obligatorio que la URL del servicio solo pueda ser accesada mediante HTTPS: es decir un Protocolo seguro de Transferencia que contiene un certificado de seguridad para el manejo encriptado de datos.
AUTENTICACIÓN PARA EL EMISOR
Se definirá un TOKEN que funcionará como identificador Único para el EMISOR.
Este TOKEN es de longitud variable y se forma de letras y números.
Las solicitudes de SERVICIO incluyen un HEADER que contiene la identificación del EMISOR con lo siguiente
| KEY | VALUE | DESCRIPTION |
| X-Origin | TOKEN EMISOR base64 | Método de autenticación de Emisor |
| User-Agent | CPAPI_AGNT_V1 | Identificador de la aplicación |
Estos valores podrán ser CAMBIADOS, en periodos de tiempo como medida de SEGURIDAD, CLUBPAGO enviará nuevos valores de IDENTIFICACION y se coordinará con el EMISOR para su actualización.
Estos valores de IDENTIFICACIÓN DEL EMISOR son enviados y validados en cada servicio que solicite CLUBPAGO al EMISOR. Si en dicha validación SE PRESENTAN problemas se contestará con los siguientes números de mensaje Si el TOKEN no corresponde se contesta HTTP 401 con el mensaje:
“Token Inválido” Si el User-Agent no corresponde se contesta HTTP 403 con el mensaje: “Origen Desconocido”
Ejemplo de Solicitud :
La autenticación de CLUBPAGO entregará un TOKEN que funcionará como identificador Único para el EMISOR. Este TOKEN es de longitud variable y se forma de letras y números. Entrega un JSON con la siguiente estructura:
| Nombre del Campo | Tipo del Valor | Descripción |
| Message | Alfanumérico | Mensaje (Exito, Error, etc) |
| Token | Alfanumérico | Serie de caracteres que contiene la información para la autenticación. |
| Expiration | Fecha | Fecha de vigencia del Token |
Ejemplo TOKEN INVÁLIDO
Ejemplo de User-Agent Desconocido
SERVICIOS WEB A IMPLEMENTAR POR EL EMISOR
La Plataforma CLUBPAGO podrá solicitar los siguientes SERVICIOS WEB, los cuales serán llamados por HTTPS
1.- Servicio de Consulta de Referencia
2.- Servicio de Autorización de Pago
3.- Servicio de Cancelación de Pago
Nota Importante: Para pagos por SPEI, CLUBPAGO recibe la CLABE ÚNICA, con esta identifica Emisor/cliente y obtiene Referencia y esta es la que usa para reportar pago. De igual forma los pagos con tarjeta también se reportan con la
Referencia CLUBPAGO Es decir, no abra diferencia para el conector del Emisor a si es un pago en Efectivo desde PDV Cadena, un pago por SPEI o pago con tarjeta.
SERVICIO DE CONSULTA DE REFERENCIA
El servicio de autorización será llamado por CLUBPAGO cuando un Cliente solicite pagar una Referencia. Esta acción realizará una validación de la Referencia por el EMISOR y en su respuesta deberá contener un código indicando el resultado de la Consulta y el monto a pagar actualizado, en caso ser exitosa. Si la Consulta de la Referencia es fallida enviar una descripción de Error.
Timeout Consulta: La plataforma CLUBPAGO espera 10 segundos la respuesta a la consulta Emisor controla si acepta más de un pago por Referencia El EMISOR puede controlar solo recibir un pago por Referencia. Dado que en este servicio se consulta la Referencia, si el EMISOR ya recibió el pago y NO PUEDE RECIBIR MÁS PAGOS CON ESTA REFERENCIA, enviará en la consulta de pago el código 13 Referencia sin adeudo.
Si en cambio el EMISOR define una referencia para un cliente donde puede hacer pagos parciales o en si realizar a través del tiempo varios pagos con una misma Referencia deberá mandar el parámetro de parcial igual a 1, de esta manera CLUBPAGO aceptará más de un pago para una Referencia.
Petición enviada por CLUBPAGO CLUBPAGO llamará a este servicio mediante un método HTTP GET, utilizando las reglas de Autenticación para el EMISOR. El cuerpo de la petición se enviará vacío.
La estructura de la solicitud será la siguiente
https://[BASE_URL]/Service/ConsultaReferencia/?r=[REFERENCIA]
Usando el parámetro “r” en la URL el cual va a contener la Referencia a consultar En el ambiente de producción es obligatorio que la URL del servicio solo pueda ser accesada mediante HTTPS.
Respuesta del servicio
El servicio espera una respuesta HTTP 200 OK, con un cuerpo de tipo application/json con los siguientes campos:
| Nombre | Tipo | Longitud Máxima | Descripción |
| Código | Numérico | 2 | El código de respuesta indicando el resultado del Servicio. |
| Mensaje | Alfanumérico | 1 – 255 | Una descripción del resultado del servicio. Esto solo es usado por CLUBPAGO para revisión de posibles errores. |
| Monto | Numérico | 16 | Monto a pagar multiplicado por 100 Ej. 150 debe enviarse como 15000. Los 2 últimos dígitos son decimales. |
| Referencia | Alfanumérico | Max | Referencia a pagar, con finalidad de cotejar que sea idéntica a la solicitada. |
| Transacción | Numérico | 16 | Identificador consecutivo de la operación. |
| Parcial | Booleano | 1 | Determina si el pago acepta parcialidades 1 Si acepta, 0 si no acepta y el monto es fijo. |
Códigos de Respuesta
El servicio autorizador debe de regresar un código indicando el resultado de la autorización:
| Código | Mensaje | Descripción |
| 0 | Operación Exitosa | Transacción autorizada. El pago en la tienda será aceptado. |
| 1 | Token Onválido | El Token no coincide. Se debe dar aviso de inmediato por parte del emisor a CLUBPAGO. |
| 2 | Origen Desconocido | Header no presente o no configurado. Se debe dar aviso de inmediato por parte del emisor hacia CLUBPAGO. |
| 12 | Referencia especial | La referencia presenta un caso especial, una excepción de lógica de negocio por parte del proveedor. En este paso se debe acudir con el emisor para efectuar el pago. |
| 13 | Referencia sin adeudo | La referencia ya fue previamente pagada o se intenta pagarnuevamente. |
| 14 | Referencia fuera de vigencia | La referencia ya no está en el periodo de la vigencia, aplica solo si el servicio maneja vigencia en sus pagos. |
| 15 | Referencia con error de formato | El formato de la referencia es incorrecto. |
| 40 | Adquiriente Inválido | El Emisor no reconoce la referencia. |
| 50 | Error de sistema | Ocurrió un error en el servicio, Son excepciones de la plataforma del Emisor. |
Ejemplo de Consulta Referencia Exitosa:
Ejemplo Consulta Referencia Inválida o Desconocida :
Ejemplo Consulta Referencia Monto Inválido:
SERVICIO DE AUTORIZACIÓN DE PAGO
El servicio de autorización será llamado por CLUBPAGO cuando un Cliente confirme pagar una Referencia válida. El EMISOR en su respuesta deberá contener un código indicando el resultado de la Autorización de Pago, junto con un Número de Autorización en caso de que fue exitosa. Si la Autorización de Pago es fallida, enviar una descripción de Error.
Si un cliente intenta pagar una remisión con un formato no válido, se rechazará sin llamar al Servicio de Autorización de Pagos, es decir, seguirá siendo una consulta de remisión fallida El EMISOR deberá validar siempre que la solicitud de pago pueda ser exitosa antes de autorizar el pago. Una vez que el EMISOR responde como pago exitoso y entrega un folio de autorización, este asume toda responsabilidad de reconocer el pago hacia CLUBPAGO y su cliente.
En algunas situaciones se puede presentar, por inconvenientes en telecomunicaciones, perdida de conectividad, exclusión mutua y otras tantas, que la solicitud de consulta previa a la autorización de pago no sea recibida por el EMISOR, es por esto que él tiene que asegurar que pueda procesar la operación con o sin consulta previa de la referencia a pagar.
Petición enviada por CLUBPAGO CLUBPAGO llamará a este servicio mediante un método HTTP POST, utilizando las reglas de autenticación del EMISOR. El contenido de la petición será de tipo application/json, codificado en UTF-8
La estructura de la solicitud será la siguiente: https://[BASE_URL]/Service/PagoReferencia/
El cuerpo de la petición contendrá un objeto JSON con las siguientes propiedades:
| Nombre | Tipo | Longitud Máxima | Descripción |
| Referencia | Alfanumérico | Max | La Referencia que se está autorizando. |
| Fecha | fecha | 25 | La fecha y hora del pago efectuado. |
| Monto | Numérico | 16 | Monto a pagar multiplicado por 100 Ej. 150 debe enviarse como 15000. Los 2 últimos dígitos son decimales. |
| Transacción | Numérico | 16 | Id de la transacción registrada en CLUBPAGO. |
| Método de pago | Alfanumérico | 2 | Identificaión del método de pago: EF”(Efectivo), “SP”(SPEI), “TD”(Tarjeta Crédito/Débito) |
En el ambiente de Producción es obligatorio que la URL del servicio solo pueda ser accesada mediante HTTPS.
Respusta del Servicio
El servicio espera una respuesta HTTP 200 OK, con un cuerpo de tipo application/json con los siguientes campos:
| Nombre | Tipo | Longitud Máxima | Descripción |
| Código | Numérico | 2 | El código de respuesta indicando el resultado de la autorización. |
| Autorización | Numérico | 8 | Un número que identifique el pago, en caso de una autorización exitosa. |
| Mensaje | Alfanumérico | 255 | Una descripción del error, en caso de una autorización fallida. Esto solo es usado por CLUBPAGO para revisión de posibles errores. |
| Transacción | Numérico | 16 | Id de la transacción registrada en CLUBPAGO. |
| Fecha | Fecha | 25 | La fecha y hora del pago autorizado. Formato sugerido (yyyy-MM-ddTHH:mm:ssZ) |
| Notificación SMS |
Numérico | 10 | Número telefónico para notificar al cliente por SMS para confirmar que su pago fue exitoso. |
| Mensaje SMS |
Alfanumérico | 160 | Mensaje para notificación SMS en caso de ser un pago exitoso. |
Códigos de respuesta
El servicio autorizador debe de regresar un código indicando el resultado de la autorización:
| Código | Mensaje | Descripción |
| 0 | Operación Exitosa | Transacción autorizada. El pago en la tienda será aceptado. |
| 1 | Token Onválido | El Token no coincide. Se debe dar aviso de inmediato por parte del emisor a CLUBPAGO. |
| 2 | Origen Desconocido | Header no presente o no configurado. Se debe dar aviso de inmediato por parte del emisor hacia CLUBPAGO. |
| 12 | Referencia especial | La referencia presenta un caso especial, una excepción de lógica de negocio por parte del proveedor. En este paso se debe acudir con el emisor para efectuar el pago. |
| 13 | Referencia sin adeudo | La referencia ya fue previamente pagada o se intenta pagarnuevamente. |
| 14 | Referencia fuera de vigencia | La referencia ya no está en el periodo de la vigencia, aplica solo si el servicio maneja vigencia en sus pagos. |
| 15 | Referencia con error de formato | El formato de la referencia es incorrecto. |
| 40 | Adquiriente Inválido | El Emisor no reconoce la referencia. |
| 50 | Error de sistema | Ocurrió un error en el servicio, Son excepciones de la plataforma del Emisor. |
Ejemplo de Autorización de Pago Exitoso
SERVICIO DE CANCELACIÓN DE PAGO
El servicio de cancelación será llamado por CLUBPAGO cuando el PDV requiera cancelar un pago, usualmente en caso de que tuviera un error al momento de registrar su transacción.
Este servicio se podrá llamar dentro del mismo día en que se dio la Autorización de Pago.
El método de cancelación solo debe deshacer un único pago de la referencia. Una vez cancelado el pago se debe tomar en cuenta que el cliente puede volver a intentar pagar la referencia de nuevo.**
** Si el emisor solo acepta un solo pago por Referencia, cuando se cancele el pago debe ser capaz de aceptar un nuevo pago para esa Referencia Petición enviada por CLUBPAGO La petición enviada por CLUBPAGO será de tipo HTTP DELETE, con los valores de la transacción a cancelar en la URL del servicio.
La estructura de la solicitud será la siguiente:
El cuerpo de la petición contendrá un objeto JSON con las siguientes propiedades:
| Nombre | Tipo | Longitud Máxima | Descripción |
| Código | Numérico | 2 | El código de respuesta indicando el resultado de la autorización. |
| Mensaje | Alfanumérico | 255 | Una descripción del error, en caso de una autorización fallida. Esto solo es usado por CLUBPAGO para revisión de posibles errores. |
Códigos de respuesta:
El servicio autorizador debe de regresar un código indicando el resultado de la autorización:
| Código | Descripción | Causa |
| 0 | Cancelación Exitosa | Transacción cancelada. Si la cancelación ya había sido previamente cancelada también se tiene que responder con código 0. |
| 1 | Token Inválido | El Token no coincide. Se debe dar aviso de inmediato por parte del emisor a CLUBPAGO. |
| 2 | Origen Desconocido | Header no presente o no configurado. Se debe dar aviso de inmediato por parte del emisor hacia CLUBPAGO. |
| 60 | Cancelación fuera de período | La cancelación se intentó después de la fecha permitida(Después del día del pago). |
| 61 | Cancelación fallida | La cancelación no puede ser procesada por el EMISOR. |
Ejemplo Cancelación de Pago:
AUTENTICACIÓN SERVICIO DE CONSULTA REEMBOLSO
Para utilizar los servicios de Consulta de Reembolso CLUBPAGO entregará un TOKEN que funcionará como identificador único para el EMISOR. Este TOKEN es de longitud variable y se forma de letras y números.
Parámetros
| Nombre | Tipo | Descripción | Obligatorio |
| User | Alfanumérico | Nombre de Usuario | SI |
| PSW | Alfanumérico | Contraseña | SI |
El cuerpo de la petición contendrá un objeto JSON con las siguientes propiedades:
https://qa.clubpago.site/plat/apiConsulta/token
Ejemplo de Solicitud :
var options = new RestClientOptions("")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("https://qa.clubpago.site/plat/apiConsulta/token", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@" ""User"": ""Emisorcppruebas"",
" + "\n" +
@" ""Pswd"": ""Emisorcppruebas""
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://qa.clubpago.site/plat/apiConsulta/token")
.header("Content-Type", "application/json")
.body("{\r\n\t\"User\": \"Emisorcppruebas\",\r\n\t\"Pswd\": \"Emisorcppruebas\"\r\n}")
.asString();
<?php$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://qa.clubpago.site/plat/apiConsulta/token',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"User": "Emisorcppruebas",
"Pswd": "Emisorcppruebas"
}',CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
curl --location 'https://qa.clubpago.site/plat/apiConsulta/token' \ --header 'Content-Type: application/json' \ --data '{ "User": "Emisorcppruebas", "Pswd": "Emisorcppruebas" }'
Respuesta
{
” Message “: “Token generado exitosamente”,
” Token “:” eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiNjM3OWZj Ni01NDNlLTRhZmMtOWZhYy01NjgxNGY1MzdkZmIiLCJVc2VySWQiOiIyNDQiLCJFbWlzb3JJZCI6IjYyOCIsIlVzZXJOYW1lIjoiRW1pOTUwSEIiLCJuYmYiOjE3NzAxMzczMDEsImV4cCI6MTc3MDI0MTcwMSwiaXNzIjoiY2x1YnBhZ28ubXgiLCJhdWQiOiJjbHVicGFnby5teCJ9.GXm1avm0tMKcaV1V3h7FP5nZRNzsFS4iQrJfAES2RypsLBXLZE”,
“Expiration”: “00260103012505307001”,
}
SERVICIO DE CONSULTA REEMBOLSO
El servicio de consulta de Reembolso será llamado por el EMISOR cuando requiera consultar reembolsos pendientes de pago, este servicio se podrá llamar y mostrará reembolsos pendientes en fecha mayor a la fecha en que se realiza la consulta.
Ejemplo
https://qa.clubpago.site/plat/apiConsulta/consultareembolso
Parametros
No Requiere
[
{
“QtyTrx”: 7,
“Importe”: 1820.0000,
“FechaPago”: ” 2026-02-06T00:00:00″
}
]
ESPECIFICACIONES A CONSIDERAR
Tiempo de comunicación entre CLUBPAGO y el Servicio
Comunicación HTTPS
Errores en el servicio autorizador
-
- En el caso del servicio de autorización, se considerará la transacción como rechazada
y no se aceptará el pago. - En el caso de cancelación, CLUBPAGO solo registrará el evento y continuará con la
operación de cancelación. Es decir, realizará reintentos cada 15 minutos, hasta que
obtenga una RESPUESTA EXITOSA DEL EMISOR
- En el caso del servicio de autorización, se considerará la transacción como rechazada
Tiempo de cancelación
Una vez autorizada una transacción, ésta podría ser cancelada de manera automática
dentro de los 10 minutos siguientes, por lo que su aplicación debe tomar esto en cuenta e implementar funciones para cubrir esta posibilidad.
Para pagos por transferencia Bancaria y pago con tarjeta la cancelación no aplica, ya que se confirma como exitosa o fallida.
Recomendación para desarrollo de la aplicación del EMISOR
Una vez instalado POSTMAN, es necesario abrirlo e instalar el plugin Jetpack de Postman para poder crear las pruebas y lanzarlas conjuntamente.
En el Anexo A de este documento encontrará una guía de cómo utilizar POSTMAN para construir su aplicación que interactúe con CLUBPAGO
Contacto para dudas
| Nivel | Nombre | Correo | Teléfono |
| Nivel 1 | Ángel Maldonado Chagoya | amaldonado@clubpago.mx | 871 478 0520 |
| Nivel 2 | Marco Galván Torres | it@rpmmx.net | 871 478 0520 |
ANEXO A
GUIA EMULADOR CLUBPAGO API CON POSTMAN
https://www.postman.com/downloads/
Tenemos disponible un Emulador de Emisor que contiene la estructura básica, de ejemplo, que tienes que programar para poder implementar CLUBPAGO API y una colección de solicitudes para importar en POSTMAN.
https://github.com/clubpago/ClubPagoAP
Complementos a esta funcionalidad
CLUBPAGO cuenta con un Sandbox (Ambiente de pruebas) que te ayudará a probar tu INTEGRACION DE PROVEEDORES O EMISORES DE PAGO. Solicita tus accesos y el Documento de Guía de uso del Sanbox de la Plataforma Tecnológica de CLUBPAGO.
