POST /api/v2/server-side-api/purchase/paddle/token/validate/

Xác thực giao dịch mua Paddle

Xác thực giao dịch mua bằng token Paddle được cung cấp, sử dụng thông tin xác thực Paddle trong Cài đặt ứng dụng của bạn trên Adapty Dashboard. Nếu giao dịch mua hợp lệ, lịch sử giao dịch sẽ được nhập từ Paddle vào hồ sơ người dùng trong Adapty với customer_user_id được chỉ định. Nếu trước đó chưa có hồ sơ người dùng nào với customer_user_id này — hồ sơ người dùng đó sẽ được tạo mới.

Request body

customer_user_idstringrequired

ID của người dùng trong hệ thống của bạn

paddle_tokenstringrequired

Token của một đối tượng Paddle đại diện cho một giao dịch mua hàng duy nhất. Có thể là transaction id (txn_...) hoặc subscription id (sub_...)

Responses

Giao dịch mua đã được xác thực thành công

Schema

dataobjectrequired

app_idstringrequired

ID nội bộ của ứng dụng của bạn

profile_idstringrequired

ID hồ sơ người dùng Adapty

customer_user_idstringrequired

ID của người dùng trong hệ thống của bạn

total_revenue_usdnumberrequired

Giá trị số thực đại diện cho tổng doanh thu tính bằng USD thu được trong hồ sơ người dùng

segment_hashstringrequired

Tham số nội bộ

timestampintegerrequired

Thời gian phản hồi tính bằng mili giây, dùng để giải quyết race condition

custom_attributesarray of objectrequired

Tối đa 30 thuộc tính tùy chỉnh được phép thiết lập cho hồ sơ người dùng

keystringrequired

Khóa phải là một chuỗi không quá 30 ký tự. Chỉ cho phép các chữ cái, số, dấu gạch ngang, dấu chấm và dấu gạch dưới

valuestring | numberrequired

Giá trị thuộc tính không được vượt quá 50 ký tự. Chỉ cho phép chuỗi và số thực (float) làm giá trị

access_levelsarray of objectrequired

Mảng các đối tượng mức độ truy cập. Mảng rỗng nếu khách hàng không có mức độ truy cập nào

access_level_idstring

Mã định danh mức độ truy cập

storestring

Cửa hàng nơi mức độ truy cập được mua

store_product_idstring

ID sản phẩm trong cửa hàng

store_base_plan_idstring

ID gói cơ bản trong cửa hàng

store_transaction_idstring

ID giao dịch trong cửa hàng

store_original_transaction_idstring

ID giao dịch gốc trong cửa hàng

offerallOf

Chi tiết ưu đãi, nếu có ưu đãi hoặc ưu đãi giới thiệu được áp dụng

categorystring

Danh mục ưu đãi

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

typestring

Loại ưu đãi

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

idstring

ID ưu đãi

starts_atstring

Thời điểm mức độ truy cập bắt đầu

purchased_atstring

Thời điểm mức độ truy cập được mua

originally_purchased_atstring

Thời điểm mức độ truy cập được mua lần đầu

expires_atstring

Thời điểm mức độ truy cập hết hạn

renewal_cancelled_atstring

Thời điểm gia hạn bị hủy

billing_issue_detected_atstring

Thời điểm phát hiện sự cố thanh toán

is_in_grace_periodboolean

Mức độ truy cập có đang trong thời gian ân hạn hay không

cancellation_reasonstring

Lý do hủy

subscriptionsarray of objectrequired

Mảng các đối tượng gói đăng ký. Mảng rỗng nếu khách hàng không có gói đăng ký nào

storestring

Cửa hàng nơi gói đăng ký được mua

store_product_idstring

ID sản phẩm trong cửa hàng

store_base_plan_idstring

ID gói cơ bản trong cửa hàng

store_transaction_idstring

ID giao dịch trong cửa hàng

store_original_transaction_idstring

ID giao dịch gốc trong cửa hàng

offerallOf

Chi tiết ưu đãi, nếu có ưu đãi hoặc ưu đãi giới thiệu được áp dụng

categorystring

Danh mục ưu đãi

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

typestring

Loại ưu đãi

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

idstring

ID ưu đãi

environmentstring

Môi trường (Sandbox, Production)

purchased_atstring

Thời điểm gói đăng ký được mua

originally_purchased_atstring

Thời điểm gói đăng ký được mua lần đầu

expires_atstring

Thời điểm gói đăng ký hết hạn

renewal_cancelled_atstring

Thời điểm hủy gia hạn

billing_issue_detected_atstring

Thời điểm phát hiện sự cố thanh toán

is_in_grace_periodboolean

Gói đăng ký có đang trong thời gian ân hạn hay không

cancellation_reasonstring

Lý do hủy

non_subscriptionsarray of objectrequired

Mảng các đối tượng sản phẩm mua một lần. Mảng rỗng nếu khách hàng chưa thực hiện giao dịch mua nào

purchase_idstring

Mã định danh mua hàng duy nhất

storestring

Cửa hàng nơi thực hiện giao dịch mua

store_product_idstring

ID sản phẩm trong cửa hàng

store_base_plan_idstring

ID gói cơ bản trong cửa hàng

store_transaction_idstring

ID giao dịch trong cửa hàng

store_original_transaction_idstring

ID giao dịch gốc trong cửa hàng

purchased_atstring

Thời điểm thực hiện giao dịch mua

environmentstring

Môi trường (Sandbox, Production)

is_refundboolean

Liệu đây có phải là giao dịch hoàn tiền hay không

is_consumableboolean

Liệu đây có phải là giao dịch mua consumable hay không

Example

{
  "data": {
    "app_id": "14c3d623-2f3a-455a-aa86-ef83dff6913b",
    "profile_id": "3286abd3-48b0-4e9c-a5f6-ac0a006804a6",
    "customer_user_id": "Jane.doe@example.com",
    "total_revenue_usd": 0,
    "segment_hash": "8f45947bad31ab0c",
    "timestamp": 1736436751469,
    "custom_attributes": [
      {
        "key": "favourite_sport",
        "value": "yoga"
      }
    ],
    "access_levels": [],
    "subscriptions": [
      {
        "purchase_id": "5a7ab471-2299-45f7-ad69-1d395c1256e3",
        "store": "app_store",
        "store_product_id": "1year.premium",
        "store_base_plan_id": null,
        "store_transaction_id": "30002109551456",
        "store_original_transaction_id": "30002109551456",
        "purchased_at": "2022-10-12T09:42:50+00:00",
        "environment": "Production",
        "is_refund": false,
        "is_consumable": false
      }
    ],
    "non_subscriptions": []
  }
}

Yêu cầu không hợp lệ

Schema

errorsarray of objectrequired

sourcestring

Nguồn gốc của lỗi

errorsarray of string

Mảng các thông báo lỗi

error_codestringrequired

Tên lỗi rút gọn

status_codeintegerrequired

Mã trạng thái HTTP

Example

{
  "errors": [
    "No products found"
  ],
  "error_code": "no_products_found",
  "status_code": 400
}

Không được phép

Schema

errorsarray of objectrequired

sourcestring

Nguồn gốc của lỗi

errorsarray of string

Mảng các thông báo lỗi

error_codestringrequired

Tên lỗi rút gọn

status_codeintegerrequired

Mã trạng thái HTTP

Example

{
  "errors": [
    "Invalid API key"
  ],
  "error_code": "unauthorized",
  "status_code": 401
}

Lỗi máy chủ nội bộ

Schema

errorsarray of objectrequired

sourcestring

Nguồn gốc của lỗi

errorsarray of string

Mảng các thông báo lỗi

error_codestringrequired

Tên lỗi rút gọn

status_codeintegerrequired

Mã trạng thái HTTP

Try it

Authorization

Body

curl --request POST \
  --url 'https://api.adapty.io/api/v2/server-side-api/purchase/paddle/token/validate/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "customer_user_id": "<YOUR_CUSTOMER_USER_ID>",
    "paddle_token": "live_7d279f61a3339fed520f7cd8c08"
  }'

const response = await fetch('https://api.adapty.io/api/v2/server-side-api/purchase/paddle/token/validate/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "customer_user_id": "<YOUR_CUSTOMER_USER_ID>",
    "paddle_token": "live_7d279f61a3339fed520f7cd8c08"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api.adapty.io/api/v2/server-side-api/purchase/paddle/token/validate/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "customer_user_id": "<YOUR_CUSTOMER_USER_ID>",
      "paddle_token": "live_7d279f61a3339fed520f7cd8c08"
    })
data = response.json()