Xsolla-logo

Crear token

post/merchants/{merchant_id}/token

Puede generar un token con parámetros de usuario arbitrarios. Envía dichos parámetros al obtener el token y los recupera tras realizarse un pago. Un token solo puede incluir los parámetros mencionados en este documento o que haya definido previamente.

Si se envía algún parámetro con un formato o de tipo incorrecto, no se generará ningún token. Aparecerá el código HTTP 422 junto con la descripción del error en el cuerpo JSON. En extended_message encontrará los detalles exactos de los parámetros que se han enviado incorrectamente.

Aviso

El token que obtiene tras solicitar este método API solo se puede utilizar para autorizar otras solicitudes. Puede utilizar este token para abrir la interfaz de pago si tiene integrado el producto Subscriptions.

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.

SecuritybasicAuth
Request
path Parameters
merchant_id
required
integer

ID de vendedor.

Request Body schema: application/json
object

Este objeto contiene parámetros destinados a configurar los filtros antifraude. La lista de parámetros se muestra a continuación. Para agregar parámetros personalizados, contacte con su gestor del éxito del cliente o envíe un correo electrónico a csm@xsolla.com.

active_date
string

Fecha de última visita conforme a la norma ISO 8601.

additional_verification
boolean

Si el jugador usa o no procedimientos de verificación de cuenta.

character_customized
boolean

Si el jugador ha personalizado o no su personaje.

chat_activity
boolean

Si el jugador emplea o no la función de chat.

completed_tasks
integer

Número de tareas/objetivos realizados/alcanzados.

forum_activity
boolean

Si el jugador emplea o no la función del foro.

items_used
boolean

Si el jugador usa o no artículos comprados en el juego.

karma_points
integer

Karma del jugador.

last_change_password_date
string

Fecha del último cambio de contraseña conforme a la norma ISO 8601.

non_premium_currency
number <float>

Importe de la moneda no prémium.

notifications_enabled
boolean

Si el jugador habilitó o no las notificaciones.

profile_completed
boolean

Si el jugador añadió o no información adicional a su perfil.

profile_image_added
boolean

Si el jugador ha subido o no una imagen de perfil.

pvp_activity
boolean

Si el jugador participa o no en combates JvJ.

registration_date
string

Fecha de creación de la cuenta conforme a la norma ISO 8601.

session_time
string

Duración media de sesión conforme a la norma ISO 8601.

social_networks_added
boolean

Si el jugador ha conectado o no perfiles de redes sociales.

total_bans
integer

Número de veces que el jugador fue expulsado del chat/foro.

total_characters
integer

Número de personajes dentro del juego.

total_clans
integer

Número de clanes a los que pertenece el jugador.

total_friends
integer

Número de amigas/os.

total_game_events
integer

Número de eventos internos del juego en los que participó el jugador.

total_gifts
integer

Número de regalos internos del juego que el jugador ha enviado/recibido.

total_hours
integer

Número total de horas dentro del juego.

total_inventory_value
number <float>

Valor total del inventario (moneda del juego).

total_sum
number <float>

Importe total de los pagos.

tutorial_completed
boolean

Si el jugador ha finalizado o no el tutorial del juego.

unlocked_achievements
integer

Número de logros desbloqueados.

user_level
integer

Nivel, reputación o rango del jugador.

win_rate
integer

Índice de victorias.

object

Objeto con los detalles de la compra.

object

Datos de la suscripción.

available_plans
Array of strings

Planes de suscripción que deben aparecer en la interfaz de pago.

currency
string

Moneda del plan de suscripción que debe usarse en todos los cálculos.

operation
string

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.

plan_id
string

ID externo del plan de suscripción. Puede encontrarse en la sección Suscripciones > Planes de suscripción de la Cuenta del editor.

product_id
string

ID del producto.

trial_days
integer

Periodo de prueba en días.

object

Configuración del proceso de pago y de la interfaz de pago para un usuario.

project_id
required
integer

ID en Xsolla del juego. Se puede encontrar en Cuenta del editor.

currency
string

Moneda preferida para la compra. Código de moneda de tres letras de conformidad con la norma ISO 4217.

external_id
string

ID de transacción en el juego. Debe ser distinto para cada pago de usuario. Consulta la documentación para obtener información detallada.

language
string

Idioma de la interfaz. Código de idioma de dos letras minúsculas.

mode
string

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.

payment_method
integer

ID del método de pago.

payment_widget
string

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.

Enum: "paybycash" "giftcard"
object

Ajustes de las directivas de redireccionamiento.

delay
integer

Retraso (en segundos) tras el cual a un usuario se le redirige automáticamente a la URL de retorno.

manual_redirection_action
string

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.

Enum: "redirect" "postmessage"
redirect_button_caption
string

Texto del botón para el redireccionamiento manual.

redirect_conditions
string

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.

Enum: "none" "successful" "successful_or_canceled" "any"
status_for_manual_redirection
string

Se muestra el 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.

Enum: "none" "successful" "successful_or_canceled" "any"
return_url
string

URL de la página a la que se redirige al usuario tras el pago. Consulta la documentación para obtener información detallada sobre la configuración de redirecciones.

object

Ajustes de la interfaz.

object

Ajustes del menú.

object

Ajustes del submenú de planes de suscripción.

hidden
boolean

Si se muestra o no el submenú.

order
integer

Posición del submenú en el menú.

object

Ajustes del submenú de moneda virtual.

custom_amount
boolean

Si el usuario puede ingresar o no una cantidad arbitraria de moneda virtual en la interfaz de pago.

hidden
boolean

Si se muestra o no el submenú.

order
integer

Posición del submenú en el menú.

object

Ajustes del submenú de artículos virtuales.

hidden
boolean

Si se muestra o no el submenú.

order
integer

Posición del submenú en el menú.

selected_group
string

Grupo que se mostrará tras abrir la pestaña de artículos virtuales.

selected_item
string

Artículo que se mostrará tras abrir la pestaña de artículos virtuales (código de artículo —SKU—).

currency_format
string

Establecer en code para mostrar un código de moneda ISO 4217 de tres letras en la interfaz de pago. Por defecto, se muestra el símbolo de moneda en lugar del código de moneda de tres letras.

object

Ajustes de la interfaz para la versión de escritorio.

object

Ajustes del encabezado.

close_button
boolean

Mostrar o no el botón Cerrar en la interfaz de pago. El botón cierra la interfaz de pago y redirige al usuario a la URL especificada en el parámetro settings.return_url. Por defecto es false.

is_visible
boolean

Si se muestra o no el encabezado en la interfaz de pago.

type
string

Cómo mostrar el encabezado. Puede ser compact (oculta el nombre del proyecto y el ID del usuario) o normal (por defecto).

Enum: "compact" "normal"
visible_logo
boolean

Si es true, el encabezado mostrará tu logotipo (primero facilita la imagen a tu Gestor de éxito del cliente).

visible_name
boolean

Si se muestra o no el nombre del proyecto en el encabezado.

visible_purchase
boolean

Si se muestra o no la descripción de la compra (purchase.description.value) en el encabezado. Por defecto es true.

object

Configuración de la lista de planes de suscripción.

description
string

Cualquier texto que se muestre encima de la lista de planes de suscripción disponibles en la interfaz de pago.

display_local_price
boolean

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.

object
visible_virtual_currency_balance
boolean

Si este elemento puede ocultarse o no en la interfaz de pago. true por defecto.

is_cart_open_by_default
boolean

La visualización de la lista de artículos en la cesta cuando se abre la versión móvil de la interfaz de pago. Si es true, la lista se muestra en una vista ampliada. Si es false (por defecto) o no se transmiten los parámetros, la lista se muestra en una vista contraída.

is_independent_windows
boolean

Si se redirige a los usuarios desde el navegador del lanzador incrustado (WebView) a su navegador predeterminado para realizar una compra. false por defecto.

is_payment_methods_list_mode
boolean

Si se muestra la lista de métodos de pago disponibles en el país del usuario al abrir la interfaz de pago. Si es false (opción por defecto), se muestra el método de pago transmitido en el parámetro settings.payment_method o el método seleccionado por el algoritmo de PayRank.

is_prevent_external_link_open
boolean

Si se desactiva o no la redirección de enlaces a un recurso externo. false por defecto. Al hacer clic en un enlace externo, se envía el evento external-link-open a través del mecanismo postMessage. La dirección del enlace redirigido se transmite en el parámetro url.

is_show_close_widget_warning
boolean

Si se muestra un aviso sobre el procesamiento de la transacción al pasar el ratón por encima del icono × antes de cerrar la página de pago. Si se transmite false o no se transmite el parámetro, no se mostrará el aviso. true por defecto.

is_three_ds_independent_windows
boolean

Si se abre o no la verificación de 3D Secure en una nueva ventana del navegador. Por defecto es false. Transmita true si utiliza la Política de seguridad de contenidos (CSP).

layout
string

Ubicación de los principales elementos de la interfaz de pago. Puedes abrir la interfaz de pago dentro de tu juego o intercambiar las columnas con información sobre un pedido y los métodos de pago. Consulta las instrucciones de personalización para obtener información detallada.

Enum: "embed" "column_reverse" "embed_column_reverse"
object
object
close_button
boolean

Si se muestra o no un botón "Cerrar" en la versión móvil 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.

mode
string

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.

theme
string

Tema de interfaz de pago. Puede ser 63295a9a2e47fab76f7708e1 para el tema claro (por defecto) o 63295aab2e47fab76f7708e3 para el tema oscuro. También puede crear un tema personalizado y transmitir el ID del tema en este parámetro.

Enum: "63295a9a2e47fab76f7708e1" "63295aab2e47fab76f7708e3"
object

Datos de la cuenta del usuario.

object

Página Mi cuenta.

enable
boolean

Si se muestra la sección. false por defecto.

order
integer

Posición de la sección en la lista desplegable.

object

Sección Métodos guardados.

enable
boolean

Especifica si se muestra el icono del lápiz en la interfaz de usuario de pago que va a la página de edición del método de pago. true por defecto.

object

Sección Gestionar suscripciones.

enable
boolean

Si se muestra la sección. false por defecto.

order
integer

Posición de la sección en la lista desplegable.

object

Datos del usuario.

required
object
value
required
string

ID del usuario.

age
integer

Edad del usuario.

attributes
object

Atributos de usuario para filtrar la lista de artículos, representados como un conjunto JSON válido de pares clave-valor.

object
allow_modify
boolean

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.

value
string

Código de país de dos letras mayúsculas de conformidad con la norma ISO 3166-1 alpha-2.

object <= 100 characters

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 el correo electrónico transmitido en el parámetro o introducido en la página de pago.

value
required
string

Correo electrónico del usuario. Debe ser válido conforme al protocolo RFC 822.

allow_modify
boolean

Si un usuario puede introducir su correo electrónico en la interfaz de pago. Si el parámetro user.email.value se transmite en el token, el valor es false por defecto.

is_legal
boolean

Si el usuario es una entidad jurídica.

object

Objeto con datos de la entidad jurídica. El objeto y todos sus parámetros son obligatorios si user.is_legal es true.

address
string

Dirección legal completa.

country
string

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.

name
string

Nombre legal completo.

vat_id
string

Identificador del contribuyente individual.

object
allow_modify
boolean

Si un usuario puede introducir su nombre en la interfaz de pago. Si el parámetro user.name.value se transmite en el token, el valor es false por defecto.

value
string

Nombre de pantalla del usuario.

object
value
string

Número de teléfono del usuario.

object
value
string

Parámetro que identifica de forma unívoca al usuario y que este conoce (correo electrónico, nombre de usuario, etc.). Permite al usuario hacer compras fuera de la tienda del juego (p. ej., a través de quioscos de efectivo).

object
value
string

ID de Steam.

object
value
string = 32 characters

ID único de usuario: se utiliza en campañas de marketing. Puede contener dígitos y caracteres latinos.

object

Atributos de tráfico.

utm_campaign
string

Título de la campaña, transliterado o traducido al inglés.

utm_content
string

Contenido de campaña.

utm_medium
string

Canal de tráfico (anuncios contextuales, anuncios en medios de comunicación, listas de correo electrónico, etc.).

utm_source
string

Fuente de tráfico.

utm_term
string

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.

Responses
200

Created.

422

Unprocessable Entity.

Request samples
application/json
{
  • "settings": {
    },
  • "user": {
    }
}
Response samples
application/json
{
  • "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT"
}