Introducción Última actualización 2023-03-31

Parámetros

Firma del mensaje

Todas las solicitudes a la API de pago deben firmarse utilizando la clave secreta del comercio con el algoritmo HMAC SHA256. La firma debe calcularse utilizando la carga útil de la solicitud, ordenada en orden ascendente y agregando este resultado en un encabezado de solicitud con el nombre X-Pg-Sig.

Obtener token

Respuesta 200 OK - Content-Type: application/json

{
  "token": "dce5b070ba65626dccd4ad700fdf3c1d219105a1"
}
							

Realizar un pago

Respuesta 200 OK - Content-Type: application/json

{
  "data": {
    "service_id": "SERVICE_ID",
    "transaction_id": "b023a79c-222f-454f-9ce9-dcf9c5712f4c",
    "status": "created",
    "payment_method": "webpay",
    "amount": "3500.00",
    "currency": "CLP",
    "payment_method_url": "https://gateway.payretailers.cl/pay-direct/b023a79c-222f-454f-9ce9-dcf9c5712f4c",
    "custom": "Pago cuenta VIP",
    "customer": {
      "first_name": "Roberto",
      "last_name": "Fernandez",
      "email": "roberto@gmail.com",
      "phone": "",
      "personal_id": "",
      "country": "CL"
    },
    "redirect_urls": {
      "success_url": "http://www.mi-sitio.com/pago-ok",
      "cancel_url": "http://www.mi-sitio.com/pago-cancelado"
    }
  }
}

Consultar un pago

Respuesta 200 OK - Content-Type: application/json

{
  "payment": {
    "service_id": "SERVICE_ID",
    "transaction_id": "b023a79c-222f-454f-9ce9-dcf9c5712f4c",
    "status": "completed",
    "payment_method": "webpay",
    "amount": "3500.00",
    "currency": "CLP",
    "created_at": "2021-01-02 23:11:00",
    "completed": "2021-01-02 23:13:00",
    "custom": "Pago cuenta VIP",
    "customer": {
      "first_name": "Roberto",
      "last_name": "Fernandez",
      "email": "roberto@gmail.com",
      "phone": "",
      "personal_id": "",
      "country": "CL"
    }
  }
}

Firmar una petición

Para garantizar la autenticidad y la integridad de los datos de las solicitudes entrantes, PayRetailers requiere que estas solicitudes estén firmadas. Esta firma se basa en un Código de autenticación de mensajes basado en hash calculado (Hash-based Message Authentication Code (HMAC)) utilizando la carga útil de una solicitud, ordenada de forma ascendente y una clave secreta, que solo usted y PayRetailers conocen.

Antes de enviar una solicitud a PayRetailers, debes calcular la firma y agregarla en la cabecera x-pg-sig. Al recibir una solicitud, PayRetailers calcula la misma firma en función de los parámetros recibidos y la clave secreta almacenada. Al verificar que ambas firmas sean iguales, PayRetailers se asegura de que la solicitud no sea manipulada.

Inscribir una tarjeta

Permite la inscripción de la tarjeta del cliente para su uso posterior en el comercio.

Respuesta 200 OK - Content-Type: application/json

{
    "pg_token": "97462c4c-b807-4245-9716-d1b33acd2a5e",
    "redirect_url": "https://gatewayint.paygol.com/oneclick/session/97462c4c-b807-4245-9716-d1b33acd2a5e"
}
							

Confirmar la inscripción de una tarjeta

Al finalizar el proceso de inscripción por parte del cliente, este será redirigido a la URL entregada por el comercio (pg_return_url) adjuntando el parámetro pg_token. Para completar el proceso de inscripción, el comercio deberá realizar una llamada de confirmación enviando los parámetros pg_serviceid y pg_token.

Respuesta 200 OK - Content-Type: application/json

{
    "pg_oneclick_card": "f81812f9-0e1b-4998-8dab-8c4084163eba",
    "pg_card_type": "visa",
    "pg_card_number": "XXXXXXXXXXXX9658"
}

Autorizar una transacción

Una vez realizada la inscripción, el comercio puede usar el parámetro pg_card recibido en la inscripción para realizar transacciones.

El proceso de pago utilizando una tarjeta previamente inscrita, es similar al proceso de pago regular utilizado en una integración API, con la única diferencia de que, para pagos OneClick, se debe además enviar el parámetro pg_oneclick_card.

Respuesta 200 OK - Content-Type: application/json

{
  "data": {
    "amount": 5000,
    "currency": "CLP",
    "customer": {
      "first_name": "Roberto",
      "last_name": "Fernandez",
      "email": "user@site.cl",
      "country": "CL"
    },
    "payment_method": "oneclick",
    "status": "completed",
    "transaction_id": "2418fa18-3e38-4adf-9a4a-ba943956bd59",
  }
}

Eliminar una tarjeta inscrita

Permite eliminar una tarjeta inscrita

Respuesta 200 OK - Content-Type: application/json

{
    "status": "OK"
}

Listar tarjetas inscritas

Obtener las tarjetas inscritas para un cliente.

Respuesta 200 OK - Content-Type: application/json

{
    "status": "OK"
}

Confirmación

Si su script de notificaciones ejecuta una lógica muy compleja o realiza llamadas a la red, es posible que el tiempo de espera se agote antes de que PayRetailers reciba la confirmación de recepción. Idealmente, su código que maneja la recepción de notificaciones (acusando recibo con código de estado 2xx) sea independiente de cualquier otra lógica.

Manejo de notificaciones duplicadas

Los endpoints de notificaciones pueden recibir en ocasiones la misma notificación más de una vez. Es por eso que recomendamos que evite recibos de notificaciones duplicados haciendo que su procesamiento de eventos sea idempotente.

Notificación pago completado

{
    "country": "CL",
    "completed_at": "2020-11-26T16:22:32-03:00",
    "currency": "CLP",
    "created_at": "2020-11-26T16:19:27-03:00",
    "custom": "Pago cuenta VIP",
    "method": "webpay",
    "price": "7500.00",
    "service_id": "SERVICE_ID",
    "status": "completed",
    "transaction_id": "ZISS-A7Q8-RE2Z-S73W",
}
	

Internacional

Argentina

Brasil

Chile

Colombia

México

Perú