Placetopay Docs

POST/autopay/session

Crear o actualizar sesión de AutoPago

El flujo de creación y actualización de un autopago comienza con esta solicitud que genera una sessión. Este proceso permite configurar pagos programados y/o recurrentes de forma automatizada, proporcionando enlace para dirigirse a la interfaz gráfica para que el tarjeta habiente autorice el inicio o actualización del autopago y seleccione el medio de pago.

Flujo

Solicitud inicial: Al realizar la petición de creación o edición, el sistema genera una sessión de AutoPago y retorna una URL de redirección.
Interfaz de AutoPago: La URL dirige al usuario a una interfaz gráfica donde debe:

Aceptar los términos y condiciones del autopago
Seleccionar su medio de pago preferido
Completar el proceso de suscripción del medio de pago
Pasar las validaciones de seguridad necesarias

Activación: Una vez completado el proceso, recibirá una notificación mediante webhook indicando la creación o actualización del autopago. Alternativamente, puede consultar el estado usando el endpoint de consulta de sesión para verificar si el autopago ya está actualizado.

Esta API funciona como un passthrough hacia la URL de Checkout, actuando únicamente como un puente entre el comercio y Checkout, sin modificar la información enviada.

Para mayor información sobre el comportamiento, validaciones y contratos aplicables, consulta la documentación oficial de Checkout en: Crear sesión en Checkout.

Solicitud

Información para crear una sesión.

Name
auth
Type
Autenticación
is Required
REQUIRED
Description
Estructura que contiene la información de autenticación del sitio generada de acuerdo al WSSE UsernameToken Profile 1.1. Ver más en Autenticación.
Name
type
Type
string
is Required
REQUIRED
Description
Parámetro usado para sesiones de tipos adicionales Usar autopay para generar una sesión de Autopago.
Valores permitidos:autopay
Ejemplo:autopay
Name
autopay
Type
AutopayRequest
is Required
REQUIRED
Description
[BETA] Detalle del autopago a generar. El usuario debe registrar un medio de pago para que se realicen cobros automáticos sobre ese medio de pago segun las condiciones pactadas. Es requerido cuando type es autopay.
Name
buyer
Type
Person
is optional
Description
Datos del usuario buyer, se refiere al usuario que está comprando un producto o servicio.
Name
payer
Type
Person
is optional
Description
Datos del usuario payer, se refiere al dueño del medio de pago o usuario que pagó el monto solicitado.
Name
fields
Type
array[NameValuePair]
is optional
Description
Estructura para relacionar información adicional en el proceso. Ver más en Campos Adicionales
Name
paymentMethod
Type
string
is optional
Description
Se usa para restringir los medios de pago disponibles en el checkout. Se pueden enviar múltiples códigos separados por comas.
Ejemplo:visa
Name
cancelUrl
Type
string
is optional
Description
URL de cancelación, el usuario es redirigido a esta url cuando decide no continuar con el proceso.
Ejemplo:https://commerce.test/cancel
Name
skipResult
Type
boolean
is optional
Description
Si se envía true, cuando el usuario finalice el proceso no se mostrará la página de resultado de la sesión, en su lugar será redirigido a la returnUrl.
Valor por defecto:false
Name
noBuyerFill
Type
boolean
is optional
Description
Por defecto, los datos enviados como buyer son pre-llenados en la interfaz de Checkout para agilizar el proceso de pago, si este parámetro se envía como true entonces no se realizará este pre-llenado.
Valor por defecto:false
Name
ipAddress
Type
string
is Required
REQUIRED
Description
Dirección IP del usuario que realizará el proceso.
Ej: 134.10.163.36
Ejemplo:134.10.163.36
Name
userAgent
Type
string
is Required
REQUIRED
Description
User Agent del navegador del usuario que realizará el proceso.
Ejemplo:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36
Name
returnUrl
Type
string
is Required
REQUIRED
Description
URL de retorno, a esta url se redirige al usuario una vez termina la sesión. Ocurre cuando el usuario da click en Volver al comercio.
Ejemplo:https://commerce.test/return
Formato:uri
Name
locale
Type
string
is optional
Description
Idioma en el que se tratará la petición y la sesión. Ver más en Localización
Ejemplo:en_US
Formato:regex
Patrón:^\w{2}\_[A-Z]{2}

Solicitud

POST

/autopay/session

curl -X "POST" {{baseURl}}/autopay/session \
  -H "Content-Type: application/json" \
  -d '{
    "auth": {
      "login": "aabbccdd1234567890aabbccdd123456",
      "tranKey": "ABC123example456trankey+789abc012def3456ABC=",
      "nonce": "NjE0OWVkODgwYjNhNw==",
      "seed": "2021-09-21T09:34:48-05:00"
    },
    "type": "autopay",
    "autopay": {
      "action": "CREATE",
      "reference": "12345",
      "description": "Inscripción autopago monto fijo",
      "dueDay": 15,
      "recurring": {
        "type": "FIXED",
        "periodicity": "M",
        "interval": "1",
        "maxPeriods": 12,
        "startDate": "2026-11-26",
        "nextPayment": "2026-12-05",
        "dueDate": "2027-11-26",
        "notificationUrl": "https://merchant.test/notification",
      },
      "amount": {
        "currency": "USD",
        "total": 100
      }
    },
    "returnUrl": "https://merchant.test/return",
    "ipAddress": "127.0.0.1",
    "userAgent": "PlacetoPay Sandbox",
  }'

Respuesta

Solicitud exitosa

Name
status
Type
Status
is Required
REQUIRED
Description
Estructura para definir estados de respuestas
Name
requestId
Type
string|number|integer
is optional
Description
Id de la petición
Ejemplo:1
Name
processUrl
Type
string
is optional
Description
URL a la cual se debe enviar al cliente para continuar el proceso, está es proporcionada por el servicio
Formato:uri
Longitud máxima:250

Respuesta

{
  "status": {
    "status": "OK",
    "reason": "00",
    "message": "La petición se ha procesado correctamente",
    "date": "2021-11-30T15:08:27-05:00"
  },
  "requestId": 1,
  "processUrl": "https://checkout-co.placetopay.com/session/1/cc9b8690b1f7228c78b759ce27d7e80a",
}