Postman
Colección de Postman con todos los endpoints de la API ya configurados, listos para probar.
La API pública de Vexorpay es compatible con cualquier cliente HTTP (curl, Node.js, PHP, etc.), pero si querés probar los endpoints de forma visual e interactiva, te dejamos una colección de Postman lista para usar.
¿Qué incluye la colección?
Todos los endpoints de la API v1 ya configurados, organizados por grupo:
- General:
GET /healthpara verificar que la API esté arriba. - Payment Links: crear links de pago único y recurrente, listar, obtener, actualizar y cancelar links, y generar un checkout por compra.
- Subscriptions: listar y obtener suscripciones, cancelarlas y abrir el portal de facturación del cliente.
- Charges: listar cobros (con filtros), ver un cobro y descargar el comprobante en PDF.
- Balance: saldo disponible y pendiente.
- Payouts: histórico de retiros.
- Acreditaciones: cobros que van quedando disponibles en la cuenta.
- Events: historial de eventos para reconciliar (
payment.completed,payment.failed, etc.).
Cada request ya trae la autenticación heredada de la colección (Authorization: Bearer ...), las rutas completas, los filtros documentados (incluido sandbox) y ejemplos de JSON en los POST/PATCH. Solo tenés que poner tu API key y, en algunos casos, completar IDs en las variables.
Cómo empezar
- Descargá la colección con el botón de abajo.
- Abrí Postman (aplicación de escritorio o la versión web).
- Importá el archivo: botón
Import→ elegívexorpay-api.postman_collection.json(o arrastralo a la ventana). - En las variables de la colección, completá
apiKeycon tu clave real (vxp_u_...). Las claves se crean en el dashboard → Desarrolladores → API keys. La variablebaseUrlya apunta a producción (https://api.vexorpay.com/api/v1). - Ejecutá cualquier request. Los valores de
linkId,chargeId,subscriptionId,payoutIdyeventIdse llenan solo con las respuestas de los requests anteriores (variables).
Un tip sobre idempotencia
Los POST idempotentes (POST /payment-links y POST /payment-links/{id}/checkout) aceptan el header Idempotency-Key. Si lo repetís con la misma clave, no se crean duplicados. Lo tenés adhoc en esos requests, listo para completar.
¿Necesitás ayuda?
- Referencia de API — todos los endpoints, parámetros y respuestas.
- Verificación de webhooks — para validar la firma
Vexorpay-Signature. - Primeros pasos — configurá tu primera clave en minutos.