Saltar al contenido principal

Crear un método de pago

API operation: Open the endpoint in Scalar

Usa POST /paymethods para crear una definición de método de pago a nivel de proyecto. La operación descrita aquí es Paymethod.register.

El esquema documentado requiere name y un gateway único; los campos opcionales incluyen enabled, allow_with_zero_balance y data_template.

La operación documentada requiere acceso de superadministrador. Crear una definición no implementa por sí solo una integración de pago funcional ni asocia el método de pago con un negocio. Las bibliotecas de pasarela, las credenciales de negocio, la compatibilidad del producto y los flujos de pago son aspectos independientes.

Consulta el modelo de método de pago y el modelo de credenciales de método de pago de negocio para conocer la diferencia entre la definición y sus credenciales.

Referencia de OpenAPI​

Operación: POST /paymethods

Campos del cuerpo de la solicitud

NombreTipoObligatorio
allow_with_zero_balancebooleanNo
data_templatearray | nullNo
enabledbooleanNo
gatewayanySí
nameanySí

Respuestas

CódigoDescripción
200Respuesta exitosa. El contenido de result varía según la operación y se devuelve como JSON.
400Respuesta de error (error=true). Los errores de validación y de negocio comparten este código.
401Respuesta de error: sesión ausente, inválida, o nivel de usuario fuera de los permitidos. Respuesta de error: el proyecto no existe o no tiene una suscripción activa.
404Respuesta vacía: la versión de API solicitada no está admitida.
429Envelope de error: se excedió un límite de consumo del proyecto (o el sujeto está baneado). Lleva Retry-After y X-RateLimit-Limit/Remaining/Reset/Scope/Key.
500Respuesta de error: falló la búsqueda o inicialización del proyecto.
503Envelope de error: la aplicación está temporalmente en mantenimiento. Envelope de error: el proyecto está temporalmente en mantenimiento, o los límites de consumo no se pudieron evaluar y el límite aplicable está configurado con on_error = closed (cabecera Retry-After: 1).
Abrir esta operación en la Referencia de la API