Xsolla-logo

Crear pedido con un artículo gratuito especificadoClient-side

post/v2/project/{project_id}/free/item/{item_sku}

Crea un pedido con un artículo gratuito especificado. El pedido creado obtendrá el estado de pedido done.

SecurityXsollaLoginUserJWT
Request
path Parameters
project_id
required
integer

ID del proyecto. Encontrará este parámetro en su cuenta Publisher junto al nombre del proyecto.

Example: 44056
item_sku
required
string

Item SKU.

Example: booster_mega_1
Request Body schema: application/json
currency
string

Divisa del precio del pedido. Código de moneda de tres letras según ISO 4217. Consulte la documentación para obtener información detallada sobre monedas soportadas por Xsolla.

custom_parameters
object [ 1 .. 200 ] properties

Parámetros específicos del proyecto.

locale
string

Idioma de respuesta.

promo_code
string

Canjea un código de una promoción de códigos promocionales con pago.

quantity
integer >= 1
Default: 1

Cantidad del artículo.

sandbox
boolean
Default: false

Crea un pedido en el modo aislador de proceso (sandbox). La opción está disponible para los usuarios especificados en la lista de usuarios de la empresa.

object

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

payment_method
integer >= 1

ID del método de pago.

object
delay
integer

Retraso tras el cual el usuario será redirigido automáticamente a la URL de retorno.

redirect_button_caption
string

Subtítulos localizados de los botones de redireccionamiento.

redirect_conditions
string

Estado del pago que activa el redireccionamiento del usuario a la URL de retorno.

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

Estado del pago que desencadena la visualización de la pulsación de un botón que redirige al usuario a la URL de retorno.

Enum: "none" "vc" "successful" "successful_or_canceled" "any"
return_url
string <uri> <= 1000 characters

Página a la que se redirige al usuario tras el pago. Los parámetros user_id, foreigninvoice, invoice_id y status se agregarán automáticamente al enlace.

object

Ajustes de la interfaz.

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
Default: false

Si se muestra o no un botón Close en la interfaz de pago de escritorio. El botón cierra la interfaz de pago y redirige al usuario a la URL especificada en el parámetro settings.return_url. false por defecto.

is_visible
boolean

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

type
string
Default: "normal"

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 true, el logotipo aparece en la cabecera. Para cargar la imagen, abra su proyecto en Cuenta de editor y vaya a la sección Pay Station > Configuración.

visible_name
boolean

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

visible_purchase
boolean
Default: true

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

object
visible_virtual_currency_balance
boolean
Default: true

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

is_cart_open_by_default
boolean
Default: false

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
Default: false

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

is_payment_methods_list_mode
boolean
Default: false

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
Default: false

Si se deshabilita o no el redireccionamiento de enlaces a un recurso externo. 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
Default: true

Si se muestra una advertencia 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á la advertencia.

is_three_ds_independent_windows
boolean
Default: false

Si se abre o no la verificación de 3-D Secure en una nueva ventana del navegador. 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
Default: false

Si se muestra o no un botón Close en la interfaz de pago móvil. El botón cierra la interfaz de pago y redirige al usuario a la URL especificada en el parámetro settings.return_url.

mode
string

Modo de interfaz en la interfaz de pago. Solo puede ser user_account. El encabezado solo 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.

Value: "user_account"
theme
string
Default: "63295a9a2e47fab76f7708e1"

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
required
boolean
Default: false

Si se muestra o no el submenú. false por defecto.

order
required
integer >= 1

Posición del submenú en el menú.

object

Submenú Mis cuentas de pago.

enable
required
boolean
Default: false

Si se muestra o no el submenú. false por defecto.

object

Submenú Gestionar suscripciones.

enable
required
boolean
Default: false

Si se muestra o no el submenú. false por defecto.

order
required
integer >= 1

Posición del submenú en el menú.

Responses
200

El pedido gratuito se creó correctamente.

422

Artículo no válido. Compruebe que el artículo existe, no esté desactivado, eliminado ni sea gratuito.

Request samples
application/json
{
  • "custom_parameters": {
    },
  • "promo_code": "discount_code",
  • "quantity": 5,
  • "sandbox": true,
  • "settings": {
    }
}
Response samples
application/json
{
  • "order_id": 641
}