Saltar al contenido

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
Mock server
https://xsolla.redocly.app/_mock/es/api/pay-station/
https://api.xsolla.com/merchant/v2/

Token

Operaciones

Tokenización

Operaciones

Informes

Operaciones

Reembolso

Operaciones

Solicitar reembolso parcial

Solicitud

Envía una solicitud de reembolso parcial a un usuario. Consulta nuestra documentación para obtener información detallada sobre el proceso de reembolso y los métodos de pago que permiten reembolsos parciales.

Nota

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

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.

transaction_idintegerrequerido

ID de la transacción.

Cuerpoapplication/jsonrequerido
descriptionstring<= 4000 charactersrequerido

Motivo del reembolso.

refund_amountnumber(float)requerido

El importe del reembolso en una moneda de compra.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/pay-station/merchants/{merchant_id}/reports/transactions/{transaction_id}/partial_refund' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "test refund request",
    "refund_amount": 1.5
  }'

Respuestas

Solicitud de reembolso aceptada

Respuesta
Sin contenido

Solicitar reembolso

Solicitud

Envía una solicitud de reembolso para devolver un pago a un usuario. Consulta la Función de reembolso para obtener más información sobre el proceso.

Nota

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

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.

transaction_idintegerrequerido

ID de la transacción.

Cuerpoapplication/jsonrequerido
descriptionstring<= 4000 charactersrequerido

Motivo del reembolso.

emailstring<= 100 characters

Correo del usuario.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/pay-station/merchants/{merchant_id}/reports/transactions/{transaction_id}/refund' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "test refund request"
  }'

Respuestas

OK (sin error).

Cuerpoapplication/json
messagestring

Puede devolver uno de los siguientes mensajes:

  • No content.
  • The request for a refund has been accepted. Xsolla CS will manually complete the refund. It may take up to two business days.
  • The request for a refund has been accepted. Xsolla CS will automatically send the customer an email with alternative refund options as the user's method does not support direct refunds.
Respuesta
application/json
{
  "message": "The request for a refund has been accepted. Xsolla CS will automatically send the customer an email with alternative refund options as the user's method does not support direct refunds."
}

Pruebas

Operaciones