Saltar al contenido
/
Obtener los sistemas de p...

Subscriptions API (2.0)

Información general

  • Versión: 2.0
  • Servidores: https://api.xsolla.com/merchant/v2/

Esta referencia de API describe los extremos para administrar suscripciones, cupones y promociones. Para obtener más información sobre las suscripciones, consulta la página guía del producto y el glosario.

Descargar descripción de OpenAPI
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/es/api/subscriptions/

Token

Operaciones

Planes

Operaciones

Productos

Operaciones

Subscription management

Operaciones

Pagos

Operaciones

Promociones

Operaciones

Actualizar promoción

Solicitud

Actualiza una promoción. Si la promoción es de solo lectura (read_only = true), no se le permite cambiar el parámetro project_id.

Aviso

Esta llamada API no contiene el parámetro de ruta project_id, por lo que tiene que usar la clave de API que sea válida en todos los proyectos de la empresa para establecer la autorización.

Seguridad
basicAuth
Ruta
merchant_idintegerrequerido

ID de vendedor.

promotion_idintegerrequerido

ID de promoción.

Cuerpoapplication/jsonrequerido
descriptionobject

Matriz de descripciones de promociones localizadas.

description.​arstring

Árabe.

description.​bgstring

Búlgaro.

description.​cnstring

Chino (simplificado).

description.​csstring

Checo.

description.​destring

Alemán.

description.​enstring

Inglés.

description.​esstring

Español.

description.​frstring

Francés.

description.​hestring

Hebreo.

description.​itstring

Italiano.

description.​jastring

Japonés.

description.​kostring

Coreano.

description.​plstring

Polaco.

description.​ptstring

Portugués.

description.​rostring

Rumano.

description.​rustring

Ruso.

description.​thstring

Tailandés.

description.​trstring

Turco.

description.​twstring

Chino (tradicional).

description.​vistring

Vietnamita.

labelobject

Matriz de etiquetas localizadas que se mostrarán en la interfaz de pago.

label.​arstring

Árabe.

label.​bgstring

Búlgaro.

label.​cnstring

Chino (simplificado).

label.​csstring

Checo.

label.​destring

Alemán.

label.​enstring

Inglés.

label.​esstring

Español.

label.​frstring

Francés.

label.​hestring

Hebreo.

label.​itstring

Italiano.

label.​jastring

Japonés.

label.​kostring

Coreano.

label.​plstring

Polaco.

label.​ptstring

Portugués.

label.​rostring

Rumano.

label.​rustring

Ruso.

label.​thstring

Tailandés.

label.​trstring

Turco.

label.​twstring

Chino (tradicional).

label.​vistring

Vietnamita.

nameobject

Matriz de nombres de promociones localizados.

name.​arstring

Árabe.

name.​bgstring

Búlgaro.

name.​cnstring

Chino (simplificado).

name.​csstring

Checo.

name.​destring

Alemán.

name.​enstring

Inglés.

name.​esstring

Español.

name.​frstring

Francés.

name.​hestring

Hebreo.

name.​itstring

Italiano.

name.​jastring

Japonés.

name.​kostring

Coreano.

name.​plstring

Polaco.

name.​ptstring

Portugués.

name.​rostring

Rumano.

name.​rustring

Ruso.

name.​thstring

Tailandés.

name.​trstring

Turco.

name.​twstring

Chino (tradicional).

name.​vistring

Vietnamita.

project_idintegerrequerido

ID de proyecto.

technical_namestringrequerido

Nombre técnico de la promoción.

enabledboolean
idinteger
read_onlyboolean
show_bannerboolean
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": {
      "en": "Promotion with 5% discount",
      "ru": "Акция со скидкой 5%"
    },
    "label": {
      "en": "5%",
      "ru": "5%"
    },
    "name": {
      "en": "5% discount",
      "ru": "скидка 5%"
    },
    "project_id": 40544,
    "technical_name": "Sale promotion"
  }'

Respuestas

No content (Sin contenido).

Obtener los sistemas de pago

Solicitud

Obtiene los sistemas de pago admitidos para una promoción. Si la lista está vacía, la promoción se aplicará a todos los sistemas de pago.

Aviso

Esta llamada API no contiene el parámetro de ruta project_id, por lo que tiene que usar la clave de API que sea válida en todos los proyectos de la empresa para establecer la autorización.

Seguridad
basicAuth
Ruta
merchant_idintegerrequerido

ID de vendedor.

promotion_idintegerrequerido

ID de promoción.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/payment_systems'

Respuestas

ACEPTAR.

Cuerpoapplication/json
idinteger
payment_systemsArray of objects

Sistemas de pago.

payment_systems[].​idinteger

ID del sistema de pago.

payment_systems[].​namestring

Nombre del sistema de pago.

Respuesta
application/json
{
  "id": 17840,
  "payment_systems": [
    { … }
  ]
}

Establecer sistemas de pago

Solicitud

Establece los sistemas de pago admitidos para una promoción. Si la lista está vacía, la promoción se aplicará a todos los sistemas de pago. Si la promoción es de solo lectura (read_only = true), no puede llamar a este método.

Aviso

Esta llamada API no contiene el parámetro de ruta project_id, por lo que tiene que usar la clave de API que sea válida en todos los proyectos de la empresa para establecer la autorización.

Seguridad
basicAuth
Ruta
merchant_idintegerrequerido

ID de vendedor.

promotion_idintegerrequerido

ID de promoción.

Cuerpoapplication/jsonrequerido
payment_systemsArray of objects

Sistemas de pago.

payment_systems[].​idinteger

ID del sistema de pago.

payment_systems[].​namestring

Nombre del sistema de pago.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/payment_systems' \
  -H 'Content-Type: application/json' \
  -d '{
    "payment_systems": [
      {
        "id": 24,
        "name": "PayPal"
      }
    ]
  }'

Respuestas

No content (Sin contenido).

Cupones

Operaciones

Subscription management

Operaciones