Saltar al contenido principal

Productos, enlaces administrados y suscripciones

Estos son recursos comerciales propiedad de la cuenta. Se requiere acceso de portador de clave API o socio y las capacidades habilitadas correspondientes. Una clave no activa una ruta de pago. Consulte autenticación.

Para lecturas y eliminaciones, env es un filtro de consulta. Para creación y actualizaciones de productos/enlaces, envíe env en el cuerpo JSON. La propiedad del socio proviene de la credencial; no envíe otro socio_id. Los campos de precio de recursos pueden tener tipos enteros específicos del punto final: el monto de la transacción API sigue siendo una cadena entera exacta.

Productos​

GET /api/v1/products?env=prod&limit=10
GET /api/v1/products/{id}?env=prod
POST /api/v1/products
PUT /api/v1/products/{id}
DELETE /api/v1/products/{id}?env=prod

La creación de un producto define su encabezado, texto, precio, cantidad y moneda. Un producto no es un pago. Las respuestas de lista utilizan datos/total; Los detalles del producto y las respuestas de creación utilizan datos. El precio mostrado es 1 USDT en decimales=6.

{
  "env": "prod",
  "header": "Example item",
  "text": "Example item",
  "price": 1000000,
  "qty": "1",
  "currency": "USDT"
}

Enlaces de pago administrados​

GET /api/v1/links?env=prod&limit=10
POST /api/v1/links
PUT /api/v1/links/{id}
DELETE /api/v1/links/{id}?env=prod

Los enlaces son recursos de servidor separados con configuraciones de montos, configuración de pagos y productos opcionales. Utilice el recurso devuelto URL/información del formulario, no un URL inventado. Un enlace de recepción Heth generado en la aplicación es un objeto diferente. Eliminar un enlace no reembolsa un pago ya realizado.

Suscripciones de comerciantes​

GET /api/v1/recurrents?env=prod&limit=10
GET /api/v1/recurrents/{id}?env=prod
POST /api/v1/recurrents
PUT /api/v1/recurrents/{id}
POST /api/v1/recurrents/{id}/pause
POST /api/v1/recurrents/{id}/resume
POST /api/v1/recurrents/{id}/cancel

Se crea una suscripción a partir de un pago inicial exitoso perteneciente a la cuenta. POST /recurrents utiliza id_pago y un objeto recurrente; El intervalo acepta diario, semanal, mensual o anual, y el período especifica el número de intervalos. El medio ambiente se hereda del pago inicial. El pagador deberá autorizar el método de pago y las condiciones de débito recurrente. Crear una suscripción no es prueba de que exista un permiso de débito utilizable.

Las acciones del ciclo de vida utilizan POST /recurrents/{id}/pause, /resume y /cancel. Leer el estado devuelto; cancelar cargos futuros no reembolsa los anteriores. Un pagador Heth administra sus propios mandatos de suscripción criptográfica con su sesión de billetera en Configuración → Mandatos de suscripción, donde la función está habilitada. Esto es independiente de la gestión de suscripciones comerciales.

Última actualización en