POST /api/v2/server-side-api/purchase/set/transaction/

Establecer transacción

Crea una nueva transacción para un usuario final de tu aplicación en Adapty y proporciona un nivel de acceso. La transacción creada por este método aparecerá en tus análisis y en el Event Feed, y se enviará a todas las integraciones.

Actualizar una suscripción existente: Para actualizar billing_issue_detected_at o renew_status_changed_at sin generar un nuevo evento subscription_renewed, reutiliza el store_transaction_id existente (bajo el mismo store_original_transaction_id). Enviar cualquier nuevo store_transaction_id se trata como una nueva transacción y dispara un evento subscription_renewed.

Header parameters

adapty-customer-user-idstring

El ID único del cliente en tu sistema. Se requiere adapty-customer-user-id o adapty-profile-id.

adapty-profile-idstring

El ID único del perfil en tu sistema. Es la mejor opción si trabajas con perfiles anónimos. Se requiere adapty-customer-user-id o adapty-profile-id.

Request body

Option 1 — object

Datos de transacción para una compra única

purchase_typestringrequired

Tipo de compra

One of: "one_time_purchase"

storestringrequired

Store donde se realizó la compra. Los valores más comunes son app_store, play_store, stripe, paddle o cualquier identificador de store personalizado

environmentstring

Entorno en el que se realizó la compra

One of: "Production", "Sandbox"

store_product_idstringrequired

ID del producto en el store

store_transaction_idstringrequired

ID de la transacción en el store. Máximo 50 caracteres. Los IDs de transacción de PayPal y algunos stores personalizados pueden superar este límite — recorta o aplica hash al valor antes de enviarlo, de lo contrario la solicitud fallará.

store_original_transaction_idstringrequired

ID de la transacción original en el store

is_family_sharedboolean

Indica si la compra está compartida en familia

priceobjectrequired

countrystringrequired

Código de país en formato ISO 3166-1 alfa-2, por ejemplo US

currencystringrequired

Código de moneda en formato ISO 4217, por ejemplo USD

valuenumberrequired

Valor del precio

purchased_atstringrequired

Fecha y hora en que se realizó la compra

variation_idstring

ID de variante para pruebas A/B

offerobject

categorystringrequired

Categoría de la oferta

One of: "introductory", "promotional", "offer_code", "win_back"

typestringrequired

Tipo de oferta

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

ID de la oferta

refunded_atstring

Fecha y hora en que se reembolsó la compra

cancellation_reasonstring

Motivo de la cancelación

One of: "billing_error", "cancelled_by_developer", "new_subscription_replace", "price_increase", "product_was_not_available", "refund", "unknown", "upgraded", "voluntarily_cancelled", "adapty_revoked"

Option 2 — object

Datos de transacción para una compra de suscripción

purchase_typestringrequired

Tipo de compra

One of: "subscription"

storestringrequired

Store donde se realizó la compra. Los valores comunes incluyen app_store, play_store, stripe, paddle o cualquier identificador de store personalizado

environmentstring

Entorno donde se realizó la compra

One of: "Production", "Sandbox"

store_product_idstringrequired

ID del producto en el store

store_transaction_idstringrequired

ID de transacción en el store. Máximo 50 caracteres. Los IDs de transacción de PayPal y algunos stores personalizados pueden superar este límite — recorte o aplique hash al valor antes de enviarlo, de lo contrario la solicitud fallará.

store_original_transaction_idstringrequired

ID de transacción original en el store

is_family_sharedboolean

Si la compra es compartida en familia

priceobjectrequired

countrystringrequired

Código de país en formato ISO 3166-1 alfa-2, por ejemplo US

currencystringrequired

Código de moneda en formato ISO 4217, por ejemplo USD

valuenumberrequired

Valor del precio

purchased_atstringrequired

Cuándo se realizó la compra

variation_idstring

ID de variante para pruebas A/B

offerobject

categorystringrequired

Categoría de la oferta

One of: "introductory", "promotional", "offer_code", "win_back"

typestringrequired

Tipo de oferta

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

ID de la oferta

refunded_atstring

Cuándo se reembolsó la compra

cancellation_reasonstring

Motivo de la cancelación

originally_purchased_atstringrequired

Cuándo se compró la suscripción originalmente

expires_atstringrequired

Cuándo expira la suscripción

renew_statusbooleanrequired

Si la suscripción se renovará

renew_status_changed_atstring

Cuándo cambió el estado de renovación

billing_issue_detected_atstring

Cuándo se detectó el problema de facturación

grace_period_expires_atstring

Cuándo expira el período de gracia

Responses

Transacción registrada correctamente

Schema

dataobjectrequired

app_idstringrequired

El ID interno de tu aplicación

profile_idstringrequired

ID de perfil de Adapty

customer_user_idstringrequired

El ID de tu usuario en tu sistema

total_revenue_usdnumberrequired

Un valor de tipo float que representa los ingresos totales en USD obtenidos en el perfil

segment_hashstringrequired

Parámetro interno

timestampintegerrequired

Tiempo de respuesta en milisegundos, necesario para resolver una condición de carrera

custom_attributesarray of objectrequired

Se permite establecer un máximo de 30 atributos personalizados en el perfil

keystringrequired

La clave debe ser una cadena de no más de 30 caracteres. Solo se permiten letras, números, guiones, puntos y guiones bajos

valuestring | numberrequired

El valor del atributo no debe superar los 50 caracteres. Solo se permiten cadenas y números en coma flotante como valores

access_levelsarray of objectrequired

Array de objetos de nivel de acceso. Array vacío si el cliente no tiene niveles de acceso

access_level_idstring

Identificador del nivel de acceso

storestring

Store donde se adquirió el nivel de acceso

store_product_idstring

ID del producto en el store

store_base_plan_idstring

ID del plan base en el store

store_transaction_idstring

ID de la transacción en el store

store_original_transaction_idstring

ID de la transacción original en el store

offerallOf

Detalles de la oferta, si se aplicó una oferta promocional o introductoria

categorystring

Categoría de la oferta

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

Tipo de oferta

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

ID de la oferta

starts_atstring

Cuándo comienza el nivel de acceso

purchased_atstring

Cuándo se adquirió el nivel de acceso

originally_purchased_atstring

Cuándo se adquirió el nivel de acceso originalmente

expires_atstring

Cuándo expira el nivel de acceso

renewal_cancelled_atstring

Cuándo se canceló la renovación

billing_issue_detected_atstring

Cuándo se detectó el problema de facturación

is_in_grace_periodboolean

Si el nivel de acceso está en período de gracia

cancellation_reasonstring

Motivo de la cancelación

subscriptionsarray of objectrequired

Array de objetos de suscripción. Array vacío si el cliente no tiene suscripciones

storestring

Store donde se realizó la compra de la suscripción

store_product_idstring

ID del producto en el store

store_base_plan_idstring

ID del plan base en el store

store_transaction_idstring

ID de la transacción en el store

store_original_transaction_idstring

ID de la transacción original en el store

offerallOf

Detalles de la oferta, si se aplicó una oferta promocional o introductoria

categorystring

Categoría de la oferta

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

Tipo de oferta

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

ID de la oferta

environmentstring

Entorno (Sandbox, Production)

purchased_atstring

Fecha en que se compró la suscripción

originally_purchased_atstring

Fecha en que se compró originalmente la suscripción

expires_atstring

Fecha en que expira la suscripción

renewal_cancelled_atstring

Fecha en que se canceló la renovación

billing_issue_detected_atstring

Fecha en que se detectó un problema de facturación

is_in_grace_periodboolean

Si la suscripción está en período de gracia

cancellation_reasonstring

Motivo de la cancelación

non_subscriptionsarray of objectrequired

Array de objetos de compra única. Array vacío si el cliente no tiene compras

purchase_idstring

Identificador único de la compra

storestring

Store donde se realizó la compra

store_product_idstring

ID del producto en el store

store_base_plan_idstring

ID del plan base en el store

store_transaction_idstring

ID de la transacción en el store

store_original_transaction_idstring

ID de la transacción original en el store

purchased_atstring

Fecha y hora en que se realizó la compra

environmentstring

Entorno (Sandbox, Production)

is_refundboolean

Indica si se trata de un reembolso

is_consumableboolean

Indica si se trata de una compra consumible

Solicitud incorrecta

Schema

errorsarray of objectrequired

sourcestring

Fuente del error

errorsarray of string

Array de mensajes de error

error_codestringrequired

Nombre corto del error

status_codeintegerrequired

Código de estado HTTP

No autorizado

Schema

errorsarray of objectrequired

sourcestring

Fuente del error

errorsarray of string

Array de mensajes de error

error_codestringrequired

Nombre corto del error

status_codeintegerrequired

Código de estado HTTP

Perfil no encontrado

Schema

errorsarray of objectrequired

sourcestring

Fuente del error

errorsarray of string

Array de mensajes de error

error_codestringrequired

Nombre corto del error

status_codeintegerrequired

Código de estado HTTP

Error interno del servidor

Try it

Authorization

Header parameters

adapty-customer-user-id

adapty-profile-id

Body

curl --request POST \
  --url 'https://api.adapty.io/api/v2/server-side-api/purchase/set/transaction/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "purchase_type": "one_time_purchase",
    "store": "app_store",
    "environment": "Production",
    "store_product_id": "premium_lifetime",
    "store_transaction_id": "1000000123456789",
    "store_original_transaction_id": "1000000123456789",
    "is_family_shared": false,
    "price": {
      "country": "US",
      "currency": "USD",
      "value": 9.99
    },
    "purchased_at": "2024-01-15T10:30:00Z",
    "variation_id": "variation_123",
    "offer": null,
    "refunded_at": null,
    "cancellation_reason": null
  }'

const response = await fetch('https://api.adapty.io/api/v2/server-side-api/purchase/set/transaction/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "purchase_type": "one_time_purchase",
    "store": "app_store",
    "environment": "Production",
    "store_product_id": "premium_lifetime",
    "store_transaction_id": "1000000123456789",
    "store_original_transaction_id": "1000000123456789",
    "is_family_shared": false,
    "price": {
      "country": "US",
      "currency": "USD",
      "value": 9.99
    },
    "purchased_at": "2024-01-15T10:30:00Z",
    "variation_id": "variation_123",
    "offer": null,
    "refunded_at": null,
    "cancellation_reason": null
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api.adapty.io/api/v2/server-side-api/purchase/set/transaction/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "purchase_type": "one_time_purchase",
      "store": "app_store",
      "environment": "Production",
      "store_product_id": "premium_lifetime",
      "store_transaction_id": "1000000123456789",
      "store_original_transaction_id": "1000000123456789",
      "is_family_shared": False,
      "price": {
        "country": "US",
        "currency": "USD",
        "value": 9.99
      },
      "purchased_at": "2024-01-15T10:30:00Z",
      "variation_id": "variation_123",
      "offer": None,
      "refunded_at": None,
      "cancellation_reason": None
    })
data = response.json()