Saltar al contenido
/
Obtener pagos

Subscriptions API (2.0)

Información general

  • Versión: 2.0
  • Servidores: https://api.xsolla.com/merchant/v2/

Esta referencia de API describe los extremos para administrar suscripciones, cupones y promociones. Para obtener más información sobre las suscripciones, consulta la página guía del producto y el glosario.

Descargar descripción de OpenAPI
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/es/api/subscriptions/

Token

Operaciones

Planes

Operaciones

Productos

Operaciones

Subscription management

Operaciones

Pagos

Operaciones

Obtener monedas

Solicitud

Muestra todas las monedas de suscripción admitidas.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID de proyecto.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/projects/{project_id}/subscriptions/currencies'

Respuestas

ACEPTAR.

Cuerpoapplication/json
Respuesta
application/json
[
  "AED",
  "ALL",
  "AMD",
  "ARS",
  "AUD",
  "AZN",
  "BAM",
  "BBD",
  "BGN",
  "BHD",
  "BND",
  "BRL",
  "BYN",
  "BZD",
  "CAD",
  "CHF",
  "CLP",
  "CNY",
  "COP",
  "CRC",
  "CZK",
  "DKK",
  "DZD",
  "EGP",
  "EUR",
  "GBP",
  "GEL",
  "GHS",
  "GIP",
  "GTQ",
  "HKD",
  "HRK",
  "HUF",
  "IDR",
  "ILS",
  "INR",
  "IQD",
  "IRR",
  "ISK",
  "JMD",
  "JOD",
  "JPY",
  "KES",
  "KGS",
  "KRW",
  "KWD",
  "KZT",
  "LAK",
  "LBP",
  "LKR",
  "MAD",
  "MDL",
  "MKD",
  "MMK",
  "MNT",
  "MUR",
  "MXN",
  "MYR",
  "NGN",
  "NIO",
  "NOK",
  "NPR",
  "NZD",
  "OMR",
  "PAB",
  "PEN",
  "PHP",
  "PKR",
  "PLN",
  "PYG",
  "QAR",
  "RON",
  "RSD",
  "RUB",
  "SAR",
  "SEK",
  "SGD",
  "SVC",
  "THB",
  "TND",
  "TRY",
  "TWD",
  "UAH",
  "USD",
  "UYU",
  "UZS",
  "VEF",
  "VND",
  "XOF",
  "YER",
  "ZAR"
]

Obtener pagos

Solicitud

Muestra todos los pagos de suscripción.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID de proyecto.

Consulta
offsetinteger

Número del elemento a partir del cual se genera la lista (el conteo empieza desde el 0).

limitintegerrequerido

Límite para el número de elementos presentes en la página.

user_idstring

ID de usuario.

statusstring

Estado de la transacción.

Enumeración ValorDescripción
done

El pago se procesó correctamente.

fail

El pago no se procesó correctamente, o se emitió un reembolso.

datetime_fromstring(datetime)

Inicio del periodo.

datetime_tostring(datetime)

Fin del periodo.

subscription_idinteger

ID de suscripción.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/projects/{project_id}/subscriptions/payments?offset=0&limit=0&user_id=string&status=done&datetime_from=string&datetime_to=string&subscription_id=0'

Respuestas

ACEPTAR.

Cuerpoapplication/json
Respuesta
application/json
[
  {
    "date_payment": "2016-04-05T10:02:01+03:00",
    "id": 67683,
    "id_payment": 203960,
    "status": "fail",
    "subscription": { … }
  },
  {
    "date_payment": "2015-09-21T17:06:47+03:00",
    "id": 1531,
    "id_payment": 168866,
    "status": "done",
    "subscription": { … }
  }
]

Obtener pagos del usuario

Solicitud

Muestra todos los pagos hechos por un usuario específico.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID de proyecto.

user_idstringrequerido

ID de usuario.

Consulta
statusstring

Estado de la transacción.

Enumeración ValorDescripción
done

El pago se procesó correctamente.

fail

El pago no se procesó correctamente, o se emitió un reembolso.

offsetinteger

Número del elemento a partir del cual se genera la lista (el conteo empieza desde el 0).

limitintegerrequerido

Límite para el número de elementos presentes en la página.

datetime_fromstring(datetime)

Fecha de muestra. Úsela para buscar suscripciones creadas tras realizar la solicitud.

datetime_tostring(datetime)

Fecha de muestra. Úsela para buscar suscripciones creadas tras realizar la solicitud.

subscription_idinteger

ID de suscripción.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/payments?status=done&offset=0&limit=0&datetime_from=string&datetime_to=string&subscription_id=0'

Respuestas

ACEPTAR.

Cuerpoapplication/json
Respuesta
application/json
[
  {
    "date_payment": "2016-04-05T10:02:01+03:00",
    "id": 6746083,
    "id_payment": 202789960,
    "status": "fail",
    "subscription": { … }
  }
]

Promociones

Operaciones

Cupones

Operaciones

Subscription management

Operaciones