ID de vendedor.
Subscriptions API (2.0)
- 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
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/es/api/subscriptions/
Solicitud
Puede crear un token con parámetros de usuario arbitrarios. Envíe estos parámetros al obtener el token y recíbalos después de un pago exitoso. Un token solo puede contener parámetros descritos en este documento o predefinidos por usted.
Si algún parámetro se envía en el formato incorrecto o tiene el tipo incorrecto, no se emitirá ningún token. Recibirá un código HTTP 422 con la descripción del error en el cuerpo JSON. En extended_message recibirá información sobre qué parámetros exactos se enviaron incorrectamente.
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
Puedes transmitir parámetros adicionales en el token en el objeto custom_parameters para configurar los filtros antifraude. Los parámetros recomendados aparecen en la lista desplegable. Ver documentación de Pay Station.
Fecha de última visita conforme a la norma ISO 8601.
Si el jugador usa o no procedimientos de verificación de cuenta.
Fecha del último cambio de contraseña conforme a la norma ISO 8601.
Si el jugador añadió o no información adicional a su perfil.
Fecha de creación de la cuenta conforme a la norma ISO 8601.
Duración media de sesión conforme a la norma ISO 8601.
Si el jugador ha conectado o no perfiles de redes sociales.
Número de eventos internos del juego en los que participó el jugador.
Número de regalos internos del juego que el jugador ha enviado/recibido.
Valor total del inventario (moneda del juego).
Objeto que contiene los detalles de la compra.
Ejemplo: {"checkout":{"amount":10,"currency":"USD"},"subscription":{"gift":{"email":"recipient_email@email.com","recipient":"test_recipient_v1"}}}
Objeto que contiene los detalles del pago.
Ejemplo: {"amount":10,"currency":"USD"}
Moneda de la compra. Código de moneda de tres letras de conformidad con la norma ISO 4217.
Ejemplo: "USD"
Datos de la suscripción.
Ejemplo: {"gift":{"email":"recipient_email@email.com","recipient":"test_recipient_v1"}}
Planes de suscripción que deben aparecer en la interfaz de pago.
Moneda del plan de suscripción que debe usarse en todos los cálculos.
Detalles de la suscripción regalada.
Ejemplo: {"email":"recipient_email@email.com","recipient":"test_recipient_v1"}
Si se oculta o no el nombre de la persona que hace el regalo. Si es true, el nombre del remitente se oculta en la notificación por correo electrónico. Por defecto es false.
Correo electrónico del destinatario.
Ejemplo: "recipient_email@email.com"
ID del destinatario.
Ejemplo: "test_recipient_v1"
Introduzca aquí un enlace a una página con información adicional sobre la suscripción regalada o a la página de creación de la cuenta. El destinatario del regalo puede acceder a esta página desde la notificación por correo electrónico del regalo de suscripción.
El tipo de operación aplicado al plan de suscripción del usuario. Para cambiar el plan de suscripción, transmite el valor change_plan. Debes especificar el ID del nuevo plan en el parámetro purchase.subscription.plan_id.
ID externo del plan de suscripción. Puede encontrarse en la sección Suscripciones > Planes de suscripción de la Cuenta del editor.
Ajustes del proyecto personalizados.
Ejemplo: {"currency":"USD","language":"en","project_id":16184,"ui":{"components":{"virtual_currency":{"custom_amount":true}},"desktop":{"virtual_item_list":{"button_with_price":true,"layout":"list"}},"size":"medium"}}
Moneda preferida para la compra. Código de moneda de tres letras de conformidad con la norma ISO 4217.
Ejemplo: "USD"
ID de la transacción dentro del juego. Debe ser único para cada pago del usuario.
Idioma de la interfaz. Código de idioma de dos letras minúsculas.
Ejemplo: "en"
Establécelo en sandbox para probar el proceso de pago. En este caso, usa https://sandbox-secure.xsolla.com para acceder a la interfaz de pago de prueba.
Widget de pago. Puede ser paybycash o giftcard. Si se establece el parámetro, al usuario se le redirige al widget "Pagar en efectivo" o "Tarjetas regalo", respectivamente.
Enumeración"paybycash""giftcard"
ID en Xsolla del juego. Se puede encontrar en Cuenta del editor.
Ejemplo: 16184
Ajustes de las directivas de redireccionamiento.
Si redirige automáticamente o no desde la página de estado.
Retraso (en segundos) tras el cual a un usuario se le redirige automáticamente a la URL de retorno.
Comportamiento de Pay Station que se desencadena cuando el usuario pulsa el botón cerrar o el botón Volver al juego. Puede ser redirect (por defecto) y postmessage. Si se establece como redirect, al usuario se le redirige a la URL transmitida en el token o especificada en la Cuenta del editor. Si se establece como postmessage, al usuario no se le redirige a otras páginas. Al pulsar en el icono de cerrar, se inicia el envío del evento close, y al pulsar en el botón Volver al juego, se inicia el evento return.
Enumeración"redirect""postmessage"
Texto del botón para el redireccionamiento manual.
Estado del pago por el que se redirige a un usuario a la URL de retorno. Puede ser none, successful, "successful_or_canсeled" o any.
Enumeración"none""successful""successful_or_canceled""any"
Página a la que se redirige al usuario tras el pago. Los parámetros user_id, foreigninvoice, invoice_id y status se añadirán automáticamente al enlace.
Ajustes de la interfaz.
Ejemplo: {"components":{"virtual_currency":{"custom_amount":true}},"desktop":{"virtual_item_list":{"button_with_price":true,"layout":"list"}},"size":"medium"}
Ajustes del menú.
Ejemplo: {"virtual_currency":{"custom_amount":true}}
Ajustes del submenú de planes de suscripción.
Ajustes del submenú de moneda virtual.
Ejemplo: {"custom_amount":true}
Si el usuario puede ingresar o no una cantidad arbitraria de moneda virtual en la interfaz de pago.
Ejemplo: true
settings.ui.components.virtual_currency.hiddenboolean
Si se muestra o no el submenú.
Ajustes del submenú de artículos virtuales.
settings.ui.components.virtual_items.hiddenboolean
Si se muestra o no el submenú.
Grupo que se mostrará tras abrir la pestaña de artículos virtuales.
Ajustes de la interfaz para la versión de escritorio.
Ejemplo: {"virtual_item_list":{"button_with_price":true,"layout":"list"}}
Ajustes del encabezado.
Si se muestra o no un botón "Cerrar" en el escritorio de Pay Station. El botón cierra Pay Station y redirige al usuario a la URL definida en el parámetro settings.return_url. Por defecto es false.
Si se muestra o no el encabezado en la interfaz de pago.
Cómo mostrar el encabezado. Puede ser compact (oculta el nombre del proyecto y el ID del usuario) o normal (por defecto).
Enumeración"compact""normal"
Si es true, el encabezado mostrará tu logotipo (primero facilita la imagen a tu Gestor de éxito del cliente).
Si se muestra o no el nombre del proyecto en el encabezado.
Configuración de la lista de planes de suscripción.
Cualquier texto que se muestre encima de la lista de planes de suscripción disponibles en la interfaz de pago.
Si es true, y si la moneda local del usuario difiere de la establecida para el plan de suscripción, el usuario podrá ver ambos precios: uno en la moneda local y otro en la moneda básica.
Configuración de la lista de monedas virtuales.
Si es true, el precio aparecerá en el botón. Si es false, el precio aparecerá a la izquierda del botón. Por defecto es false.
Configuración de la lista de artículos virtuales.
Ejemplo: {"button_with_price":true,"layout":"list"}
Si es true, el precio aparecerá en el botón. Si es false, el precio aparecerá a la izquierda del botón. Por defecto es false.
Ejemplo: true
Plantilla de lista. Puede ser list (por defecto) o grid.
Enumeración"list""grid"
Ejemplo: "list"
Si se deshabilita o no el redireccionamiento de enlaces a un recurso externo. true por defecto. Al pulsar en un enlace externo, el evento external-link-open se envía mediante el mecanismo postMessage. La dirección del enlace redirigido se transmite en el parámetro url.
Modo de interfaz en Pay Station. Solo puede ser user_account. El encabezado sólo contiene el menú de navegación de la cuenta, y el usuario no puede seleccionar un producto ni hacer un pago. Este modo únicamente está disponible en la versión de escritorio.
Tamaño de la interfaz de pago. Puede ser:
- pequeño: el menor tamaño posible de la interfaz de pago. Utiliza este valor cuando el tamaño de la ventana esté muy limitado (dimensiones: 620 x 630)
- mediano: tamaño recomendado. Utiliza este valor para mostrar la interfaz de pago en una caja de luz (dimensiones: 740 x 760)
- grande: el tamaño óptimo para mostrar la interfaz de pago en una nueva ventana o pestaña (dimensiones: 820 x 840)
Enumeración"small""medium""large"
Ejemplo: "medium"
Tema de la interfaz de pago. Puede ser default o default_dark.
Enumeración"default""default_dark"
Datos de la cuenta del usuario.
Submenú de Historial .
Página Mi cuenta.
Submenú Mis cuentas de pago.
Datos del usuario.
Ejemplo: {"age":19,"country":{"allow_modify":true,"value":"US"},"email":{"value":"john.smith@mail.com"},"id":{"value":"user_2"},"name":{"value":"John Smith"}}
Atributos de usuario para filtrar la lista de artículos, representados como un conjunto JSON válido de pares clave-valor.
Ejemplo: {"allow_modify":true,"value":"US"}
Si el usuario puede cambiar o no el país en la interfaz de pago. Si se transmite country.value en el token, el valor es false por defecto.
Ejemplo: true
Código de país de dos letras mayúsculas de conformidad con la norma ISO 3166-1 alpha-2.
Ejemplo: "US"
El objeto user.email es un componente fundamental del desarrollo de los modelos antifraude y contribuye a aumentar los índices de aceptación. Es un requisito para Xsolla y para los sistemas de pago. Si no se transmite el parámetro, el campo obligatorio para introducir el correo electrónico aparece en la página de pago. Un usuario recibe un recibo de compra en su correo electrónico transmitido en el parámetro o insertado en la página de pago.
Ejemplo: {"value":"john.smith@mail.com"}
Correo electrónico del usuario. Debe ser válido conforme al protocolo RFC 822.
Ejemplo: "john.smith@mail.com"
Ejemplo: {"value":"user_2"}
Objeto con datos de la entidad jurídica.
País de constitución. Código de país de dos letras mayúsculas de conformidad con la norma ISO 3166-1 alpha-2.
Ejemplo: {"value":"John Smith"}
Atributos de tráfico.
Canal de tráfico (anuncios contextuales, anuncios en medios de comunicación, listas de correo electrónico, etc.).
Palabras clave de la campaña. Si están establecidas, las estadísticas dependerán de las palabras clave utilizadas para la segmentación de los anuncios, en vez de en consultas de búsqueda específicas. En Google Analytics, el utm_term especificado forma parte del informe de términos de búsqueda general.
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/token
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/subscriptions/merchants/{merchant_id}/token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/es/api/subscriptions/merchants/{merchant_id}/token' \
-H 'Content-Type: application/json' \
-d '{
"purchase": {
"checkout": {
"amount": 10,
"currency": "USD"
},
"subscription": {
"gift": {
"email": "recipient_email@email.com",
"recipient": "test_recipient_v1"
}
}
},
"settings": {
"currency": "USD",
"language": "en",
"project_id": 16184,
"ui": {
"components": {
"virtual_currency": {
"custom_amount": true
}
},
"desktop": {
"virtual_item_list": {
"button_with_price": true,
"layout": "list"
}
},
"size": "medium"
}
},
"user": {
"age": 19,
"country": {
"allow_modify": true,
"value": "US"
},
"email": {
"value": "john.smith@mail.com"
},
"id": {
"value": "user_2"
},
"name": {
"value": "John Smith"
}
}
}'Respuesta
application/json
{ "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT" }