Saltar al contenido
/
Obtener cuentas guardadas

Pay Station API (2.0)

Descripción general

  • Versión: 2.0.0
  • Servidores:
    • https://api.xsolla.com/api

Con Pay Station, los socios podrán monetizar sus productos ofreciendo a los usuarios una cómoda interfaz para pagar las compras dentro del juego en la tienda del juego. Para establecer la apertura de la interfaz de pago, consulte estas instrucciones.

Pay Station API proporciona los siguientes grupos de llamadas:

  • El token incluye la llamada API que permite generar un token con parámetros de usuario arbitrarios para procesar posteriormente los pagos a través de la interfaz de pago.
  • Tokenización: incluye las llamadas API para procesar pagos de forma segura sin abrir la interfaz de pago ni implicar al usuario.
  • Informes: incluye las llamadas API para devolver datos sobre las transacciones de los usuarios, generar informes, así como obtener el desglose de las retribuciones por moneda.
  • Reembolso: incluye las llamadas API para solicitar reembolsos totales y parciales.
  • Pruebas: incluye la llamada API que permite probar el proceso de contracargo.

En el documento Guía de integración de la solución Payments encontrará información detallada sobre la configuración de la interfaz de pago.

Nota

También puede consultar la sección de la Xsolla Base API de la Colección Postman para probar las llamadas API empleadas para la integración.

Descargar descripción de OpenAPI
index.json
index.yaml
Idiomas
Servidores
https://api.xsolla.com/merchant/v2/
Mock server
https://xsolla.redocly.app/_mock/es/api/pay-station/

Token

Operaciones

Tokenización

Operaciones

Obtener cuentas guardadas

Solicitud

Muestra las cuentas de pago guardadas de un usuario determinado.

Nota

En modo aislador de proceso (sandbox), esta llamada API funciona solamente con tarjetas de prueba que no tienen función 3-D Secure.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID del proyecto.

user_idstringrequerido

ID único de usuario en el juego que está almacenado en su lado. Asegúrese de transmitir el ID de usuario existente. Si se produce un error, consulte las respuestas a las Preguntas frecuentes.

Consulta
modestring

Establecer en entorno de pruebas (sandbox) para probar el proceso de pago. Elimina el parámetro para realizar pagos reales.

curl -i -X GET \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/payment_accounts?mode=string'

Respuestas

OK.

Cuerpoapplication/json
Respuesta
application/json
[
  {
    "id": 4612345,
    "name": "PP_saved_account",
    "payment_system": { … },
    "type": "paypal"
  }
]

Eliminar cuenta guardada

Solicitud

Elimina una cuenta de pago guardada.

Nota

En modo aislador de proceso (sandbox), esta llamada API funciona solamente con tarjetas de prueba que no tienen función 3-D Secure.

Nota

Puedes solicitar este método API en el modo de entorno de pruebas (sandbox). Para ello, transmite los datos de la cuenta de pago de prueba en la solicitud. Consulta las instrucciones para obtener más información sobre el acceso en el modo de entorno de pruebas (sandbox) y las pruebas.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID del proyecto.

user_idstringrequerido

ID único de usuario en el juego que está almacenado en su lado. Asegúrese de transmitir el ID de usuario existente. Si se produce un error, consulte las respuestas a las Preguntas frecuentes.

typestringrequerido

Tipo de cuenta de pago.

Enumeración ValorDescripción
alipayplus_boost

Boost.

alipayplus_cn

Alipay.

alipayplus_dana

DANA.

alipayplus_gcash

GCash.

alipayplus_hk

Alipay (Hong Kong).

alipayplus_kplus

K PLUS.

alipayplus_maya

Maya.

alipayplus_rabbitlinepay

Rabbit LINE Pay

alipayplus_tng

Touch 'n Go.

alipayplus_truemoney

Monedero TrueMoney.

account_idintegerrequerido

ID de la cuenta guardada en la base de datos de Xsolla.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/payment_accounts/{type}/{account_id}'

Respuestas

No Content.

Cobrar con cuenta guardada

Solicitud

Cobra a un usuario a través de una cuenta de pago guardada.

Nota

En modo aislador de proceso (sandbox), esta llamada API funciona solamente con tarjetas de prueba que no tienen función 3-D Secure.

Aviso

Para que la llamada API funcione correctamente, establezca un tiempo de espera de 2 minutos.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID del proyecto.

user_idstringrequerido

ID único de usuario en el juego que está almacenado en su lado. Asegúrese de transmitir el ID de usuario existente. Si se produce un error, consulte las respuestas a las Preguntas frecuentes.

typestringrequerido

Tipo de cuenta de pago.

Enumeración ValorDescripción
alipayplus_boost

Boost.

alipayplus_cn

Alipay.

alipayplus_dana

DANA.

alipayplus_gcash

GCash.

alipayplus_hk

Alipay (Hong Kong).

alipayplus_kplus

K PLUS.

alipayplus_maya

Maya.

alipayplus_rabbitlinepay

Rabbit LINE Pay

alipayplus_tng

Touch 'n Go.

alipayplus_truemoney

Monedero TrueMoney.

account_idintegerrequerido

ID de la cuenta guardada en la base de datos de Xsolla.

Cuerpoapplication/jsonrequerido
custom_parametersobject(custom_parameters)

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.

custom_parameters.​active_datestring

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

custom_parameters.​additional_verificationboolean

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

custom_parameters.​character_customizedboolean

Si el jugador ha personalizado o no su personaje.

custom_parameters.​chat_activityboolean

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

custom_parameters.​completed_tasksinteger

Número de tareas/objetivos realizados/alcanzados.

custom_parameters.​forum_activityboolean

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

custom_parameters.​items_usedboolean

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

custom_parameters.​karma_pointsinteger

Karma del jugador.

custom_parameters.​last_change_password_datestring

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

custom_parameters.​non_premium_currencynumber(float)

Importe de la moneda no prémium.

custom_parameters.​notifications_enabledboolean

Si el jugador habilitó o no las notificaciones.

custom_parameters.​profile_completedboolean

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

custom_parameters.​profile_image_addedboolean

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

custom_parameters.​pvp_activityboolean

Si el jugador participa en batallas PvP (jugadores contra jugadores).

custom_parameters.​registration_datestring

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

custom_parameters.​session_timestring

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

custom_parameters.​social_networks_addedboolean

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

custom_parameters.​total_bansinteger

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

custom_parameters.​total_charactersinteger

Número de personajes dentro del juego.

custom_parameters.​total_clansinteger

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

custom_parameters.​total_friendsinteger

Número de amigas/os.

custom_parameters.​total_game_eventsinteger

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

custom_parameters.​total_giftsinteger

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

custom_parameters.​total_hoursinteger

Número total de horas dentro del juego.

custom_parameters.​total_inventory_valuenumber(float)

Valor total del inventario (moneda del juego).

custom_parameters.​total_sumnumber(float)

Importe total de los pagos.

custom_parameters.​tutorial_completedboolean

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

custom_parameters.​unlocked_achievementsinteger

Número de logros desbloqueados.

custom_parameters.​user_levelinteger

Nivel, reputación o rango del jugador.

custom_parameters.​win_rateinteger

Índice de victorias.

purchaseobject

Objeto con los detalles de la compra.

purchase.​checkoutobject

Objeto con los detalles del pago.

purchase.​checkout.​amountnumber(float)

Importe de la compra.

purchase.​checkout.​currencystring

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

purchase.​descriptionobject
purchase.​description.​valuestring<= 4000 characters
purchase.​virtual_currencyobject

Objeto con los detalles de la moneda virtual.

purchase.​virtual_currency.​quantitynumber(float)

Importe de la compra en la moneda virtual.

settingsobject

Objeto con la configuración de la compra.

settings.​currencystring(currency)

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

settings.​external_idstring(external_id)

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

settings.​mock_codeinteger(mock_code)

Un código de error que se debe reproducir al probar el proceso de pago a través de PayPal en modo de entorno de pruebas (sandbox). Solo funciona correctamente si se transmite el parámetro "mode":"sandbox".

Enumeración1002101510391046105710891201120318011803
settings.​modestring

Establecer en entorno de pruebas (sandbox) para probar el proceso de pago. Elimina el parámetro para pagos reales.

userobject

Datos del usuario.

user.​ipstringrequerido

Dirección IP del usuario.

user.​legalobject(legal)

Objeto con datos de la entidad jurídica.

user.​legal.​addressstring

Dirección legal completa.

user.​legal.​countrystring

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.

user.​legal.​namestring

Nombre legal completo.

user.​legal.​vat_idstring

Identificador del contribuyente individual.

user.​namestring

Nombre de usuario.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/payments/{type}/{account_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "purchase": {
      "description": {
        "value": "currency purchase"
      },
      "virtual_currency": {
        "quantity": 100
      }
    },
    "settings": {
      "currency": "USD",
      "external_id": "ext123",
      "mode": "sandbox"
    },
    "user": {
      "ip": "111.11.11.11",
      "legal": {
        "address": "17 Crown Street London SW2 0JW United Kingdom",
        "country": "GB",
        "name": "My Awesome Company",
        "vat_id": "GB111111111"
      },
      "name": "John Smith"
    }
  }'

Respuestas

Created.

Cuerpoapplication/json
transaction_idinteger
Respuesta
application/json
{
  "transaction_id": 123458390
}

Informes

Operaciones

Reembolso

Operaciones

Pruebas

Operaciones