Referencia API AutoPay

Bienvenido a la referencia técnica de AutoPay. Nuestra API está construida bajo principios RESTful, utiliza JSON para el intercambio de datos y códigos de respuesta HTTP estándar.

Entornos y base URL

Todas las solicitudes deben enviarse a las siguientes URL base, dependiendo del entorno en el que te encuentres:

Entorno	Base URL	Descripción
Sandbox	`https://api-test.placetopay.com`	Utilizado para desarrollo y pruebas. No procesa dinero real.
Producción	`https://api.placetopay.com`	Entorno transaccional real.

Cabeceras (headers)

Todas las peticiones a la API deben incluir las siguientes cabeceras HTTP para asegurar que el contenido se interprete correctamente:

    Content-Type: application/json
    Accept: application/json
    User-Agent: TuApp/1.0 (Recomendado para identificar tu tráfico)

Estructura de respuesta estándar

Independientemente del endpoint, todas las respuestas de la API siguen una estructura común. Siempre recibirás un objeto status que te indicará el resultado técnico de la operación.

    {
        "status": {
            "status": "OK",
            "reason": "00",
            "message": "La petición se ha procesado correctamente",
            "date": "2023-06-21T09:56:06-05:00"
        },
        ...,
    }

status: Indica el éxito (OK) o fallo (FAILED) de la solicitud técnica.
reason: Código interno para manejo de errores programático.
message: Descripción legible del resultado.
* : Contiene la información solicitada (ej. detalles de la sesión, lista de transacciones).

Servicios disponibles

Explora los endpoints disponibles para gestionar el ciclo de vida de autopagos:

Sesiones: El punto de entrada. Permite crear un nuevo autopago o editar uno existente.
Búsqueda: Consulta el estado y detalles de tus autopagos.
Transacciones: Obtén el historial de cobros realizados sobre un autopago específico.
Cancelación: Detén un autopago para evitar futuros cobros.