GET /api/v2/server-side-api/vc/balances/

Liệt kê số dư tiền tệ ảo

Trả về số dư hiện tại của mọi tiền tệ ảo cho một hồ sơ người dùng. Nếu ứng dụng không có tiền tệ ảo, data là một mảng rỗng.

Header parameters

adapty-customer-user-idstring

ID duy nhất của khách hàng trong hệ thống của bạn. Yêu cầu phải có adapty-customer-user-id hoặc adapty-profile-id.

adapty-profile-idstring

ID duy nhất của hồ sơ người dùng trong hệ thống của bạn. Lựa chọn tốt nhất nếu bạn đang làm việc với các hồ sơ người dùng ẩn danh. Yêu cầu phải có adapty-customer-user-id hoặc adapty-profile-id.

Responses

Số dư được trả về thành công

Schema

Số dư hiện tại cho tất cả các loại tiền tệ ảo của hồ sơ người dùng.

response_created_atintegerrequired

Thời điểm phản hồi được tạo, dưới dạng Unix timestamp tính bằng mili giây.

dataarray of objectrequired
codestringrequired

Mã tiền tệ ảo duy nhất trong ứng dụng. Chữ cái ASCII, chữ số và dấu gạch dưới.

namestringrequired

Tên hiển thị của tiền tệ ảo.

balanceintegerrequired

Tổng số dư, bao gồm các khoản hiện đang được giữ.

heldintegerrequired

Tổng của tất cả các khoản giữ đang hoạt động (số tiền được đặt trước). Hiện luôn là 0.

availableintegerrequired

Số dư có thể chi tiêu, được tính bằng balance - held.

Example
{
  "response_created_at": 1779791400000,
  "data": [
    {
      "code": "COINS",
      "name": "Gold Coins",
      "balance": 12450,
      "held": 0,
      "available": 12450
    },
    {
      "code": "GEMS",
      "name": "Gems",
      "balance": 3280,
      "held": 0,
      "available": 3280
    },
    {
      "code": "ENERGY",
      "name": "Energy",
      "balance": 840,
      "held": 0,
      "available": 840
    }
  ]
}

Yêu cầu không hợp lệ. Không có adapty-profile-id hay adapty-customer-user-id nào được gửi (error_code là validation_error).

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

Không được phép. API key bị thiếu hoặc không hợp lệ (error_code là not_authenticated).

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

Không tìm thấy hồ sơ người dùng (error_code là profile_does_not_exist).

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

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