# Pay Station API # 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](/es/doc/pay-station/how-to/how-to-open-payment-ui/). 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](/es/doc/pay-station/features/tokenization/): 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](/es/solutions/payments/integration-guide/integration-flow/) 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.

Version: 2.0 ## Servers ``` https://api.xsolla.com/merchant/v2 ``` ## Security ### basicAuth La API de Xsolla utiliza autenticación de acceso básica. Todas las solicitudes a la API deben contener el encabezado `Authorization: Basic `, en el cual `` es el par de `merchant_id:api_key` codificado según el estándar Base64. Acceda a [Cuenta del editor](https://publisher.xsolla.com/) para encontrar estos parámetros:
Para obtener más información sobre cómo trabajar con claves de API, consulta la [Referencia de la API](https://developers.xsolla.com/es/api/getting-started/#api_keys_overview). Type: http Scheme: basic ## Download OpenAPI description [Pay Station API](https://developers.xsolla.com/_bundle/@l10n/es/api/pay-station/index.yaml) ## Token ### Crear token - [POST /merchants/{merchant_id}/token](https://developers.xsolla.com/es/api/pay-station/token/create-token.md): 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. Por defecto, el ciclo de vida del token es de 24 horas. Si quiere cambiar este valor, contacte con su gestor del éxito del cliente o envíe un correo electrónico a csm@xsolla.com. El nuevo valor se habilitará para todos los proyectos de su empresa creados en Cuenta del editor. AvisoEl 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.Para abrir la interfaz de pago en una nueva ventana, utilice el siguiente enlace: https://secure.xsolla.com/paystation4/?token={token}, en el cual {token} es el token recibido. Para realizar pruebas, utilice esta URL: https://sandbox-secure.xsolla.com/paystation4/?token={token}. AvisoEsta 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. ## Tokenización ### Obtener cuentas guardadas - [GET /projects/{project_id}/users/{user_id}/payment_accounts](https://developers.xsolla.com/es/api/pay-station/tokenization/get-saved-accounts.md): Muestra las cuentas de pago guardadas de un usuario determinado. NotaEn modo aislador de proceso (sandbox), esta llamada API funciona solamente con tarjetas de prueba que no tienen función 3-D Secure. ### Eliminar cuenta guardada - [DELETE /projects/{project_id}/users/{user_id}/payment_accounts/{type}/{account_id}](https://developers.xsolla.com/es/api/pay-station/tokenization/delete-saved-account.md): Elimina una cuenta de pago guardada. NotaEn modo aislador de proceso (sandbox), esta llamada API funciona solamente con tarjetas de prueba que no tienen función 3-D Secure. NotaPuedes 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. ### Cobrar con cuenta guardada - [POST /projects/{project_id}/users/{user_id}/payments/{type}/{account_id}](https://developers.xsolla.com/es/api/pay-station/tokenization/charge-with-saved-account.md): Cobra a un usuario a través de una cuenta de pago guardada. NotaEn modo aislador de proceso (sandbox), esta llamada API funciona solamente con tarjetas de prueba que no tienen función 3-D Secure. AvisoPara que la llamada API funcione correctamente, establezca un tiempo de espera de 2 minutos. ## Informes ### Obtener informes - [GET /merchants/{merchant_id}/reports](https://developers.xsolla.com/es/api/pay-station/reports/get-reports.md): Obtiene la lista de informes financieros durante un periodo especificado. AvisoEsta 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. ### Obtener transacciones - [GET /merchants/{merchant_id}/reports/transactions/registry.{format}](https://developers.xsolla.com/es/api/pay-station/reports/get-transactions.md): Devuelve la lista de detalles sobre las transacciones realizadas y canceladas durante un periodo especificado. Como respuesta, recibe información sobre los pagos, incluyendo datos sobre tasas, impuestos, así como sobre el pedido y el usuario. Puede obtener la lista en formato JSON o CSV. Puede usar esta llamada API para realizar conciliaciones financieras. AvisoEsta 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. ### Buscar transacciones - [GET /merchants/{merchant_id}/reports/transactions/search.{format}](https://developers.xsolla.com/es/api/pay-station/reports/find-transactions.md): Devuelve una lista de transacciones basada en parámetros de búsqueda específicos. Como respuesta, recibirá datos sobre todos los pagos hechos en su juego, incluso si no fueron aceptados. Puede especificar no solo el periodo de la transacción, sino también otros parámetros, como p. ej., para buscar transacciones realizadas por un usuario concreto o en un estado de pago específico. Puede obtener la lista en formato JSON o CSV. AvisoEsta 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. ### Buscar transacciones (búsqueda rápida) - [GET /merchants/{merchant_id}/reports/transactions/simple_search](https://developers.xsolla.com/es/api/pay-station/reports/find-transactions-fast.md): Obtiene una lista de transacciones basada en parámetros de búsqueda específicos en unos segundos. Es una alternativa a la llamada API Find transactions que devuelve los datos en formato JSON, CSV o XLS. AvisoEsta 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. ### Obtener el desglose de los desembolsos en la moneda - [GET /merchants/{merchant_id}/reports/transactions/summary/transfer](https://developers.xsolla.com/es/api/pay-station/reports/get-payouts-breakdown.md): Obtiene el desglose de los desembolsos en la moneda. AvisoEsta 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. ### Obtener transacción - [GET /merchants/{merchant_id}/reports/transactions/{transaction_id}/details](https://developers.xsolla.com/es/api/pay-station/reports/get-transaction.md): Obtiene la información completa de la transacción por ID. AvisoEsta 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. ### Obtener desembolsos - [GET /merchants/{merchant_id}/reports/transfers](https://developers.xsolla.com/es/api/pay-station/reports/get-payouts.md): Muestra todos los pagos de un periodo. AvisoEsta 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. ## Reembolso ### Solicitar reembolso parcial - [PUT /merchants/{merchant_id}/reports/transactions/{transaction_id}/partial_refund](https://developers.xsolla.com/es/api/pay-station/refund/request-partial-refund.md): 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. NotaPuedes 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. AvisoEsta 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. ### Solicitar reembolso - [PUT /merchants/{merchant_id}/reports/transactions/{transaction_id}/refund](https://developers.xsolla.com/es/api/pay-station/refund/request-refund.md): 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. NotaPuedes 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. AvisoEsta 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. ## Pruebas ### Solicitar contracargo - [POST /merchants/{merchant_id}/projects/{project_id}/payments/{transaction_id}/chargeback](https://developers.xsolla.com/es/api/pay-station/testing/request-chargeback.md): Solicita el contracargo en el modo de entorno de pruebas (sandbox): - Para acceder al modo de entorno de pruebas (sandbox), transmite "mode":"sandbox" al obtener el token. - El pago de prueba debe realizarse en el modo de entorno de pruebas (sandbox) en el mismo proyecto que utilices para hacer pruebas. - El estado de la transacción debe ser distinto de refunded, cancelled. - Tu rol en la Cuenta del editor tiene que ser como mínimo Gerente financiero. (Lo encontrarás en la sección Configuración de la empresa > Usuarios.) - Consulta las instrucciones para obtener más información sobre estas pruebas. NotaConsulta la documentación para obtener más información sobre otras pruebas.