Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến
Tài liệu về Apigee X. thông tin
Để quản lý số dư trong tài khoản trả trước, bạn có thể:
- Xem số dư tài khoản trả trước hiện tại. Xem phần Xem thẻ trả trước số dư tài khoản bằng API.
- Tải lại (nạp tiền vào) số dư tài khoản theo yêu cầu thông qua nhà cung cấp dịch vụ thanh toán bên thứ ba,
chẳng hạn như Worldpay. Xem Quản lý số dư trả trước bằng cách sử dụng bên thứ ba
nhà cung cấp dịch vụ thanh toán.
Ngoài ra, bạn có thể quản lý việc tải lại bằng cách theo dõi các khoản thanh toán theo cách thủ công hoặc thông qua hệ thống thanh toán tích hợp, sau đó gọi API kiếm tiền để tải lại tài khoản, như như được mô tả trong phần Quản lý số dư trả trước theo cách thủ công.
- Thiết lập tự động tải lại khi số dư tài khoản trả trước giảm xuống dưới một ngưỡng nhất định thông qua API Kiếm tiền và nhà cung cấp dịch vụ thanh toán bên thứ ba (chẳng hạn như Worldpay). Lựa chọn này là rất hữu ích trong việc quản lý các khoản thanh toán định kỳ cho các gói giá. Để biết thông tin, hãy xem phần Thiết lập tự động tải lại số dư tài khoản trả trước bằng API.
Làm cách nào để tính số dư tài khoản trả trước còn lại?
Khi xem số dư tài khoản trả trước của một nhà phát triển hoặc công ty, như được mô tả trong các phần sau, bạn cần phải nhận các giá trị sau từ phản hồi:
amount
: Tổng số tiền có cho kỳ thanh toán hiện tại. Giá trị này được cập nhật khi bạn tải lại tài khoản trả trước bằng các phương thức được mô tả trong phần này.usage
: Tổng số tiền đã sử dụng trong kỳ thanh toán hiện tại. Giá trị này được cập nhật với từng công cụ kiếm tiền đủ điều kiện giao dịch hoặc bằng cách phát hành một khoản tín dụng (tích cực hoặc tiêu cực).
Bạn có thể tính
số dư tài khoản trả trước còn lại cho kỳ thanh toán hiện tại bằng cách trừ giá trị usage
cho
Giá trị amount
. Ví dụ: nếu giá trị amount
là 335, 50 và giá trị usage
là 34, thì
số dư còn lại sẽ được tính như sau:
amount(335.50) - usage(34) = 229.50
Xem số dư tài khoản trả trước bằng API
Các phần sau đây mô tả cách xem số dư tài khoản trả trước của nhà phát triển hoặc công ty bằng API.
Xem số dư tài khoản trả trước của nhà phát triển
Để xem số dư tài khoản trả trước cho nhà phát triển, hãy gửi yêu cầu GET tới một trong các API sau, trong đó {developer_id}
là địa chỉ email của nhà phát triển:
/mint/organizations/{org_name}/developers/{developer_id}/developer-balances
: Trả về số dư tài khoản trả trước và thông tin thiết lập định kỳ cho nhà phát triển./mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances
: Trả về thông tin số dư tài khoản trả trước bao gồm tổng số dư hiện tại và tổng số dư, mức sử dụng, giao dịch nạp tiền và thuế sử dụng.
Bạn có thể truyền các tham số truy vấn sau để lọc kết quả:
Tham số truy vấn | Mô tả |
---|---|
all |
Cờ chỉ định liệu có trả về tất cả các gói API hay không. Nếu bạn đặt chính sách này thành false, số lượng gói API được trả về trên mỗi trang sẽ là
được xác định bởi tham số truy vấn size . Giá trị mặc định là false. |
size |
Số gói API được trả về trên mỗi trang. Giá trị mặc định là 20. Nếu truy vấn all
được đặt thành true , nên tham số này sẽ bị bỏ qua. |
page |
Số trang bạn muốn trả lại (nếu nội dung được phân trang). Nếu
tham số truy vấn all được đặt thành true , điều này
sẽ bị bỏ qua. |
currencyId |
Mã đơn vị tiền tệ mà bạn muốn xem số dư tài khoản trả trước. |
Ví dụ:
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/developer-balances" \ -u email:password
Sau đây là ví dụ về phản hồi:
{ "developerBalance": [ { "amount": 2005, "chargePerUsage": false, "id": "your-provider-id", "isRecurring": false, "supportedCurrency": { "description": "United States Dollars", "displayName": "United States Dollars", "id": "usd", "name": "USD", "organization": { "address": [ { "address1": "10 Almaden Blvd.", "city": "San Jose", "country": "US", "id": "32e808d8-3a3c-4d76-a0ae-17d70a982c61", "isPrimary": true, "state": "CA", "zip": "95113" } ], "approveTrusted": false, "approveUntrusted": false, "billingCycle": "CALENDAR_MONTH", "country": "US", "currency": "USD", "description": "my-org", "groupOrganization": false, "hasBillingAdjustment": false, "hasBroker": false, "hasSelfBilling": false, "hasSeparateInvoiceForProduct": false, "id": "my-org", "issueNettingStmt": false, "name": "my-org", "nettingStmtPerCurrency": false, "selfBillingAsExchOrg": false, "selfBillingForAllDev": false, "separateInvoiceForFees": false, "status": "ACTIVE", "supportedBillingType": "BOTH", "taxModel": "HYBRID", "timezone": "UTC" }, "status": "ACTIVE", "virtualCurrency": false }, "usage": 2.1572 } ], "totalRecords": 1 }
Xem số dư tài khoản trả trước của công ty
Để xem số dư tài khoản trả trước cho một công ty, hãy gửi yêu cầu GET tới
/mint/organizations/{org_name}/companies/{company_id}/developer-balances
, trong đó
{company_id}
là mã nhận dạng của công ty. Nếu công ty sử dụng hình thức trả trước, thì yêu cầu
truy xuất số dư tài khoản trả trước hiện tại. Nếu công ty là công ty trả sau, yêu cầu sẽ truy xuất
hạn mức tín dụng hiện tại.
Bạn có thể truyền các tham số truy vấn sau để lọc kết quả:
Tham số truy vấn | Mô tả |
---|---|
all |
Cờ chỉ định liệu có trả về tất cả các gói API hay không. Nếu bạn đặt chính sách này thành false, số lượng gói API được trả về trên mỗi trang sẽ là
được xác định bởi tham số truy vấn size . Giá trị mặc định là false. |
size |
Số gói API được trả về trên mỗi trang. Giá trị mặc định là 20. Nếu truy vấn all
được đặt thành true , nên tham số này sẽ bị bỏ qua. |
page |
Số trang bạn muốn trả lại (nếu nội dung được phân trang). Nếu
tham số truy vấn all được đặt thành true , điều này
sẽ bị bỏ qua. |
currencyId |
Mã đơn vị tiền tệ mà bạn muốn xem số dư tài khoản trả trước. |
Ví dụ:
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/{company_id}/developer-balances" \ -u email:password
Phản hồi tương tự như phản hồi hiển thị ở trên, khi xem số dư tài khoản trả trước cho một nhà phát triển.