Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào
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ư hiện tại trong tài khoản trả trước. Xem phần Xem số dư tài khoản trả trước 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 một nhà cung cấp dịch vụ thanh toán bên thứ ba, chẳng hạn như Worldpay. Xem bài viết Quản lý số dư trả trước bằng nhà cung cấp dịch vụ thanh toán bên thứ ba.
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 một hệ thống thanh toán tích hợp, rồi gọi API kiếm tiền để tải lại tài khoản, như mô tả trong phần Quản lý số dư trả trước theo cách thủ công.
- Thiết lập tính năng tự động nạp lại khi số dư trong tài khoản trả trước giảm xuống dưới một ngưỡng nhất định bằng cách sử dụng 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. Tuỳ chọn này rất hữu ích để quản lý các khoản thanh toán định kỳ cho gói giá. Để biết thông tin, hãy xem bài viết Thiết lập tính năng tự động nạp 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 cho một nhà phát triển hoặc công ty, như mô tả trong các phần sau, bạn cần lấy các giá trị sau từ phản hồi:
amount
: Tổng số tiền có sẵn cho kỳ thanh toán hiện tại. Giá trị này được cập nhật khi bạn nạp 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 cho mỗi giao dịch kiếm tiền đủ điều kiện hoặc bằng cách phát hành một khoản tín dụng (dương hoặc âm).
Bạn có thể tính toán số dư còn lại trong tài khoản trả trước cho kỳ thanh toán hiện tại bằng cách trừ giá trị usage
khỏi 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 cho một 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 của một nhà phát triển, hãy đưa ra yêu cầu GET cho 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 về số dư tài khoản trả trước, bao gồm cả số dư hiện tại và tổng số dư, mức sử dụng, số tiền nạp 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 được đặt thành false, số lượng gói API được trả về trên mỗi trang sẽ được xác định bằng tham số truy vấn size . Giá trị mặc định là false. |
size |
Số lượng gói API được trả về trên mỗi trang. Giá trị mặc định là 20. Nếu bạn đặt tham số truy vấn all thành true , thì tham số này sẽ bị bỏ qua. |
page |
Số trang mà bạn muốn trả về (nếu nội dung được phân trang). Nếu bạn đặt tham số truy vấn all thành true , thì tham số 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 của một công ty, hãy đưa ra yêu cầu GET đến /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 phương thức trả trước, thì yêu cầu này sẽ truy xuất số dư tài khoản trả trước hiện tại. Nếu công ty sử dụng phương thức trả sau, thì 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 được đặt thành false, số lượng gói API được trả về trên mỗi trang sẽ được xác định bằng tham số truy vấn size . Giá trị mặc định là false. |
size |
Số lượng gói API được trả về trên mỗi trang. Giá trị mặc định là 20. Nếu bạn đặt tham số truy vấn all thành true , thì tham số này sẽ bị bỏ qua. |
page |
Số trang mà bạn muốn trả về (nếu nội dung được phân trang). Nếu bạn đặt tham số truy vấn all thành true , thì tham số 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 này tương tự như phản hồi nêu trên, khi xem số dư tài khoản trả trước của một nhà phát triển.
Quản lý số dư tài khoản trả trước bằng cách sử dụng nhà cung cấp dịch vụ thanh toán
Quản lý số dư tài khoản trả trước bằng cách thiết lập tài khoản người bán với một nhà cung cấp dịch vụ thanh toán bên thứ ba, chẳng hạn như Worldpay. Hình sau đây cho thấy cách quản lý số dư tài khoản trả trước thông qua nhà cung cấp dịch vụ thanh toán Worldpay.
Bảng sau đây mô tả từng bước trong quy trình quản lý số dư tài khoản trả trước, được hiển thị ở trên.
Bước | Mô tả |
---|---|
0 |
Các bước điều kiện tiên quyết Là nhà cung cấp API, để thiết lập nhà cung cấp dịch vụ thanh toán bên thứ ba, chẳng hạn như Worldpay, bạn phải: |
1 |
Để kích hoạt flow, người dùng API sẽ thực hiện một trong những việc sau trên cổng thông tin dành cho nhà phát triển:
|
2 | Cổng thông tin dành cho nhà phát triển sẽ bắt đầu quy trình thanh toán cho nhà phát triển qua Edge, với mã nhà cung cấp, số tiền tải lại và đơn vị tiền tệ. Để biết thông tin về cách sử dụng API để bắt đầu thanh toán, hãy xem bài viết Bắt đầu thanh toán cho tài khoản trả trước bằng trình cung cấp dịch vụ thanh toán. |
3 | Edge tìm nhà cung cấp theo mã nhận dạng, xác định đó là tài khoản Worldpay. |
4 | Edge tạo mã đơn đặt hàng. |
5 | Edge tạo lệnh thanh toán trên Worldpay. |
6 | Worldpay trả về một mã tham chiếu cho đơn đặt hàng và một URL có giới hạn thời gian để thực hiện đơn đặt hàng đó. |
7 |
Phản hồi của Worldpay được chuyển đổi thành phản hồi API Edge /thanh toán chung, được trả về cổng thông tin dành cho nhà phát triển để hoàn tất lệnh gọi được bắt đầu ở bước 2. Ví dụ: { "isRecurring": "false", "orderCode": "1234", "referenceId": "3042815493", "referenceUrl": "https://secure.worldpay.com/wcc/dispatcher?OrderKey=MERCH_CODE_FROM_PROVIDER%5E1234", "success": "true" } |
8 | Cổng thông tin dành cho nhà phát triển sẽ thêm URL lệnh gọi lại (cho trạng thái thành công, không thành công, v.v.) dưới dạng tham số truy vấn vào URL. |
9 | Cổng thông tin dành cho nhà phát triển phản hồi yêu cầu ở bước 1 bằng cách chuyển hướng trình duyệt của người dùng API đến URL đã sửa đổi. |
10 | Người dùng API hoàn tất biểu mẫu đăng ký và bắt đầu xử lý bằng Worldpay. |
11 | Worldpay thu thập thông tin thanh toán và xử lý khoản thanh toán. Nếu thành công, Worldpay sẽ tạo một Mã xác thực thông báo (MAC) bằng cách sử dụng MAC Secret được định cấu hình trên cả Worldpay và cổng thông tin dành cho nhà phát triển. |
12 | Worldpay chuyển hướng trình duyệt của người dùng API đến URL gọi lại thành công (từ bước 8), thêm MAC dưới dạng tham số truy vấn và số tiền. |
13 | Trình duyệt gọi URL trên cổng thông tin dành cho nhà phát triển với số lượng và MAC được yêu cầu. |
14 | Cổng xác minh MAC dựa trên khoá bí mật MAC. MAC ngăn người dùng tuỳ ý tuyên bố rằng đã thực hiện thanh toán thành công. |
15 | Cổng thông tin dành cho nhà phát triển gửi yêu cầu đến Edge để tải lại số dư tài khoản trả trước. Để biết thông tin về cách sử dụng API để tải lại số dư tài khoản, hãy xem bài viết Tải lại số dư tài khoản trả trước bằng API. |
Các phần sau đây mô tả các bước cần thiết để quản lý số dư trả trước bằng cách sử dụng nhà cung cấp dịch vụ thanh toán bên thứ ba:
- Thiết lập tài khoản người bán với nhà cung cấp dịch vụ thanh toán Worldpay
- Định cấu hình nhà cung cấp thanh toán trong Edge
- Xem các nhà cung cấp dịch vụ thanh toán được định cấu hình cho tổ chức của bạn
- Bật và định cấu hình các mô-đun bắt buộc trong cổng thông tin dành cho nhà phát triển
- Bắt đầu thanh toán cho tài khoản trả trước bằng trình cung cấp dịch vụ thanh toán
- Tải lại số dư tài khoản trả trước bằng API
- Xoá nhà cung cấp dịch vụ thanh toán bên thứ ba
Thiết lập tài khoản người bán với nhà cung cấp dịch vụ thanh toán Worldpay
Trước khi bắt đầu, bạn phải liên hệ với một nhà cung cấp dịch vụ thanh toán bên thứ ba (Worldpay) để thiết lập(các) tài khoản người bán. Bạn nên thiết lập hai tài khoản, một tài khoản để thử nghiệm và một tài khoản để phát hành chính thức. Để biết thêm thông tin về tài khoản người bán Worldpay, hãy truy cập vào www.worldpay.com và wp-support.crm.worldpay.com (trung tâm hỗ trợ của Worldpay).
Sau khi bạn thiết lập tài khoản người bán và nhận được thông tin đăng nhập tài khoản, để định cấu hình tài khoản người bán với Worldpay:
- Truy cập vào https://secure.worldpay.com/sso/public/auth/login.html.
- Đăng nhập vào tài khoản Worldpay bằng thông tin xác thực mà Worldpay cung cấp cho bạn.
- Đặt mật khẩu XML và khoá bí mật của mã xác thực thông báo (MAC):
- Nhấp vào Hồ sơ.
- Đặt mật khẩu để sử dụng khi định cấu hình nhà cung cấp dịch vụ thanh toán Worldpay trong Edge trong trường Mật khẩu XML.
- Nhập khoá bí mật MAC có độ dài từ 20 đến 30 ký tự vào trường Mã bí mật chuyển hướng MAC.
- Nhấp vào Lưu hồ sơ
- Thêm máy chủ quản lý Apigee Edge vào danh sách IP của người bán (danh sách cho phép):
- Nhấp vào Hồ sơ > Môi trường của người bán.
- Nhấp vào New Test IP (IP thử nghiệm mới).
- Nhập IP cho máy chủ quản lý Apigee Edge.
- Nhấp vào Lưu.
- Định cấu hình URL của người bán để nối các tham số Worldpay, bao gồm cả mã xác thực phương thức (MAC):
- Nhấp vào Lượt cài đặt > Trang thanh toán được lưu trữ > Trình thiết kế trang thanh toán.
- Trong mục Chỉnh sửa trang thanh toán, hãy chọn mã cài đặt của bạn trong danh sách thả xuống Chọn kênh.
- Trên thẻ Tài sản, hãy chọn Chỉnh sửa cấu hình người bán.
- Đặt giá trị thông số Gửi URL thành True.
- Nhấp vào thẻ Xuất bản.
- Quảng bá các thay đổi như sau:
- Đối với môi trường thử nghiệm, hãy nhấp vào Promote (Đăng) trong mục Design (Thiết kế) để chuyển từ Design sang Sandbox.
- Đối với môi trường phát hành công khai, hãy nhấp vào Chuyển sang công khai trong phần Hộp cát để chuyển từ Hộp cát sang Công khai.
Định cấu hình nhà cung cấp thanh toán trong Edge
Bước tiếp theo là định cấu hình trình cung cấp dịch vụ thanh toán trong Edge.
Bạn có thể định cấu hình nhà cung cấp dịch vụ thanh toán cho một tổ chức cụ thể bằng cách sử dụng API sau:
/organizations/{org-name}/providers
Chỉ khách hàng Apigee Edge Private Cloud có đặc quyền quản trị viên hệ thống mới có thể tuỳ ý định cấu hình nhà cung cấp dịch vụ thanh toán toàn cầu bằng API sau:
/config/providers
Khi gọi từng API, bạn phải chỉ định thông tin sau trong phần nội dung yêu cầu:
Tham số | Nội dung mô tả | Bắt buộc |
authType |
Mã cài đặt do nhà cung cấp dịch vụ thanh toán cung cấp. | Có |
credential |
Thông tin xác thực được mã hoá Base64 (username:XMLpassword ) cho tài khoản người bán
Worldpay; username tương đương với mã người bán (viết hoa tất cả các chữ cái)
và XMLpassword chỉ định mật khẩu XML mà bạn đã đặt ở bước trước, khi
thiết lập tài khoản người bán Worldpay. |
Có |
description |
Nội dung mô tả về nhà cung cấp dịch vụ thanh toán. | Không |
endpoint |
Điểm cuối để truy cập vào nhà cung cấp dịch vụ thanh toán
|
Có |
merchantCode |
Mã người bán do nhà cung cấp dịch vụ thanh toán cung cấp cho người dùng API | Có |
name |
Tên để sử dụng cho nhà cung cấp.
Chỉ dành cho khách hàng Apigee Edge Private Cloud: Đối với các nhà cung cấp dịch vụ thanh toán toàn cầu, hãy đảm bảo rằng tên là duy nhất trên tất cả các tổ chức Edge. Bạn nên đưa WorldPay (không phân biệt chữ hoa chữ thường) vào tên nhà cung cấp để dễ dàng nhận dạng. Ví dụ: |
Có |
Ví dụ: Sau đây là cách thiết lập tài khoản người bán với Worldpay có tên là Worldpay-myorg:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Worldpay-myorg", "description": "Worldpay payment provider", "endpoint": "https://secure.worldpay.com/jsp/merchant/xml/paymentService.jsp", "authType": "123456", "credential": "dXNlcm5hbWU6cGFzc3dvcmQ=", "merchantCode": "myMerchantCode" }' \ "https://api.enterprise.apigee.com/v1/organizations/myOrg/providers" \ -u email:password
Xem nhà cung cấp dịch vụ thanh toán bên thứ ba
Xem và xác nhận nhà cung cấp dịch vụ thanh toán bên thứ ba được định cấu hình cho tổ chức Edge của bạn bằng cách gửi yêu cầu GET đến tài nguyên sau:
/mint/organizations/{org-name}/providers
Ví dụ: nội dung sau đây cho thấy các nhà cung cấp dịch vụ thanh toán bên thứ ba hiện được định cấu hình cho myorg
:
$ curl -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/providers" \ -u email:password
Sau đây là ví dụ về phản hồi cho thấy hai tài khoản người bán, một tài khoản để kiểm thử và một tài khoản để phát hành công khai.
{ "provider" : [ { "authType" : "123456", "credential" : "dXNlcm5hbWU6cGFzc3dvcmQ=", "description" : "Worldpay payment provider", "endpoint" : "https://secure.worldpay.com/jsp/merchant/xml/paymentService.jsp", "id" : "worldpay-myorg", "merchantCode" : "MERCH_CODE", "name" : "Worldpay-myorg" }, { "authType" : "123456", "credential" : "dXNlcm5hbWU6cGFzc3dvcmQ=", "description" : "Worldpay payment provider", "endpoint" : "https://secure-test.worldpay.com/jsp/merchant/xml/paymentService.jsp", "id" : "worldpay-test", "merchantCode" : "MERCH_CODE_FROM_PROVIDER", "name" : "Worldpay-test" } ] }
Bật và định cấu hình mô-đun Kiếm tiền và Worldpay trong trang web dành cho nhà phát triển
Bật các mô-đun Kiếm tiền và Worldpay bắt buộc trong cổng thông tin dành cho nhà phát triển. Để biết thông tin chi tiết, hãy xem bài viết Định cấu hình tính năng Kiếm tiền trong Cổng thông tin dành cho nhà phát triển.
Bắt đầu thanh toán cho tài khoản trả trước bằng nhà cung cấp dịch vụ thanh toán
Như minh hoạ trong bước 2 của quy trình quản lý tài khoản trả trước, khoản thanh toán cho tài khoản trả trước thông qua nhà cung cấp dịch vụ thanh toán sẽ do cổng thông tin dành cho nhà phát triển thực hiện khi người sử dụng API:
- Chấp nhận gói giá nhưng không có đủ tiền trong tài khoản trả trước
- Yêu cầu nạp tiền vào tài khoản trả trước của họ.
Để bắt đầu thanh toán qua nhà cung cấp dịch vụ thanh toán bên thứ ba bằng API, hãy đưa ra yêu cầu POST đến tài nguyên sau, trong đó {developer_id}
là địa chỉ email của nhà phát triển.
/mint/organizations/{org_name}/developers/{developer_id}/payment?amount={amount}&provider={providerId}&supportedCurrencyId={currency}
Khi đưa ra yêu cầu, bạn cần chỉ định các giá trị sau làm tham số truy vấn:
- Số tiền cần thêm vào số dư của tài khoản trả trước (
amount={amount}
) - Mã nhà cung cấp thanh toán (
provider={providerId}
) - Đơn vị tiền tệ được hỗ trợ (
supportedCurrencyId={currency}
)
Ngoài ra, bạn cần chuyển thông tin cơ bản về tài khoản, chẳng hạn như địa chỉ thanh toán của công ty.
Ví dụ: mã sau đây sẽ nạp lại số dư tài khoản trả trước bằng nhà cung cấp dịch vụ thanh toán Worldpay. Khoản chuyển ban đầu vào tài khoản trả trước của bạn sẽ là 10 đô la Mỹ (tham số truy vấn amount
được đặt thành 10
).
$ curl -H "Content-Type:application/xml" -X POST -d \ '{ "address1": "5115 Hopyard Ave.", "city": "Pleasanton", "country": "US", "state": "CA", "zip": "58158" }' ' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/payment?amount=10&provider=worldpay-myorg&supportedCurrencyId=usd" \ -u email:password
Sau đây là ví dụ về phản hồi:
{ "isRecurring": "false", "orderCode": "1234", "referenceId": "3042815493", "referenceUrl": "https://secure.worldpay.com/wcc/dispatcher?OrderKey=MERCH_CODE_FROM_PROVIDER%5E1234", "success": "true" }
URL đến trang Thanh toán bảo mật của Worldpay được trả về trong referenceUrl
, trong đó khoá đơn đặt hàng duy nhất của bạn được thêm vào dưới dạng tham số truy vấn.
Tải lại số dư của tài khoản trả trước bằng API
Như minh hoạ trong bước 15 của quy trình quản lý tài khoản trả trước, sau khi xác minh nhà cung cấp thanh toán đã xử lý thành công, cổng thông tin dành cho nhà phát triển sẽ gửi yêu cầu đến Edge để tải lại tài khoản trả trước.
Bạn có thể nạp lại số dư tài khoản trả trước bằng API cho nhà phát triển hoặc công ty, như mô tả trong các phần sau.
Tải lại số dư tài khoản trả trước cho nhà phát triển
Để nạp lại số dư tài khoản trả trước cho nhà phát triển bằng API, hãy đưa ra yêu cầu POST đến /mint/organizations/{org_name}/developers/{developer_id}/developer-balances
, trong đó {developer_id}
là địa chỉ email của nhà phát triển. Khi đưa ra yêu cầu, bạn cần chỉ định trong nội dung yêu cầu số tiền cần thêm vào số dư và đơn vị tiền tệ được sử dụng.
Ví dụ: yêu cầu sau đây sẽ thêm 1.000 USD vào số dư tài khoản trả trước của nhà phát triển:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "amount": 1000, "supportedCurrency": { "id": "usd" } }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/developer-balances" \ -u email:password
Để biết nội dung mô tả về các thuộc tính yêu cầu, hãy xem phần Tóm tắt về các thuộc tính yêu cầu để nạp tiền lại tài khoản trả trước.
Nạp lại số dư trả trước cho tài khoản của một công ty
Để nạp lại số dư tài khoản trả trước cho một công ty bằng API, hãy đưa ra yêu cầu POST đến /mint/organizations/{org_name}/companies/{company_id}/developer-balances
, trong đó {company_id}
là mã nhận dạng của công ty. Khi đưa ra yêu cầu, bạn cần chỉ định trong nội dung yêu cầu số tiền cần thêm vào số dư và đơn vị tiền tệ được sử dụng.
Ví dụ: yêu cầu sau đây sẽ thêm 1.000 đô la vào số dư tài khoản trả trước của một công ty:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "amount": 1000, "supportedCurrency": { "id": "usd" } }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/{company_id}/developer-balances" \ -u email:password
Để xem nội dung mô tả về các thuộc tính yêu cầu, hãy xem bài viết Tóm tắt về các thuộc tính yêu cầu để tải lại một tài khoản trả trước.
Tóm tắt các thuộc tính yêu cầu để tải lại tài khoản trả trước
Bạn phải chỉ định các thuộc tính sau đây khi nạp lại số dư tài khoản trả trước bằng API:
Tên | Mô tả | Mặc định | Bắt buộc? |
---|---|---|---|
amount |
Số tiền được áp dụng cho số dư trả trước (bằng đơn vị tiền tệ hiện hành). |
Không áp dụng | Có |
supportedCurrency |
Đơn vị tiền tệ dùng cho số dư trả trước. Đây là đơn vị tiền tệ được thiết lập cho gói trong API mà nhà phát triển đã mua. |
Không áp dụng | Có |
Xoá nhà cung cấp dịch vụ thanh toán bên thứ ba
Bạn có thể xoá nhà cung cấp dịch vụ thanh toán bên thứ ba được định cấu hình cho tổ chức Edge của mình bằng cách gửi yêu cầu DELETE đến tài nguyên sau:
Để xoá một nhà cung cấp dịch vụ thanh toán cho một tổ chức cụ thể, hãy sử dụng API sau:
/mint/organizations/{org-name}/providers/id
Chỉ khách hàng Apigee Edge Private Cloud có đặc quyền quản trị viên hệ thống mới có thể chọn xoá nhà cung cấp dịch vụ thanh toán toàn cầu bằng API sau:
/config/providers/id
Ví dụ: nội dung sau đây sẽ xoá các nhà cung cấp dịch vụ thanh toán bên thứ ba hiện được định cấu hình cho myorg:
$ curl -X DELETE \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/providers/worldpay-myorg" \ -u email:password
Quản lý số dư tài khoản trả trước theo cách thủ công
Ngoài ra, bạn có thể quản lý việc nạp lại số dư trả trước bằng cách theo dõi các khoản thanh toán theo cách thủ công hoặc qua một hệ thống thanh toán tích hợp, sau đó gọi API kiếm tiền để nạp lại tài khoản, như mô tả trong phần Nạp lại số dư tài khoản trả trước bằng API.
Thiết lập tính năng tự động nạp lại số dư tài khoản trả trước bằng API
Các phần sau đây mô tả cách thiết lập tính năng tự động nạp lại số dư tài khoản trả trước cho nhà phát triển hoặc công ty bằng cách sử dụng nhà cung cấp dịch vụ thanh toán bên thứ ba. Tuỳ chọn này rất hữu ích khi quản lý các khoản thanh toán định kỳ cho các gói giá.
Thiết lập tính năng tự động tải lại số dư tài khoản trả trước cho nhà phát triển
Để thiết lập tính năng tự động nạp lại số dư tài khoản trả trước cho nhà phát triển khi số dư giảm xuống dưới một ngưỡng nhất định, hãy đưa ra yêu cầu POST đến /mint/organizations/{org_name}/developers/{developer_id}/developer-balances/recurring-setup
, trong đó {developer_id
} là địa chỉ email của nhà phát triển.
Khi đưa ra yêu cầu, bạn cần chỉ định những thông tin sau:
- Mã nhận dạng của nhà cung cấp thanh toán để sử dụng nhằm nạp lại tài khoản (
providerID
) - Cờ bật tính năng tự động tải lại (
isRecurring
) - Ngưỡng mà số dư tài khoản trả trước phải giảm xuống để kích hoạt tính năng tự động nạp lại (
replenishAmount
) - Số tiền cần tự động thêm vào tài khoản (
recurringAmount
) - Tham số truy vấn
supportedCurrencyID
để chỉ định đơn vị tiền tệ.
Trong ví dụ sau, khi số dư tài khoản trả trước của nhà phát triển giảm xuống dưới 5 đô la Mỹ, hệ thống sẽ tự động thêm 10 đô la Mỹ vào tài khoản đó.
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "providerId": "worldpay-myorg", "isRecurring" : true, "replenishAmount" : 5, "recurringAmount" : 10 }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/developer-balances/recurring-setup?supportedCurrencyId=usd" \ -u email:password
Để biết nội dung mô tả về các thuộc tính yêu cầu, hãy xem phần Tóm tắt về các thuộc tính yêu cầu để thiết lập tính năng tự động nạp lại tài khoản trả trước.
Thiết lập tính năng tự động nạp lại số dư tài khoản trả trước cho một công ty
Để thiết lập tính năng tự động tải lại số dư tài khoản trả trước cho một công ty khi số dư giảm xuống
thấp hơn một số tiền nhất định, hãy gửi yêu cầu POST tới
/mint/organizations/{org_name}/companies/{company_id}/developer-balances/recurring-setup
,
trong đó {company_id} là mã nhận dạng của
công ty.
Khi đưa ra yêu cầu, bạn cần chỉ định những thông tin sau:
- Mã nhận dạng của nhà cung cấp thanh toán để dùng để nạp lại tài khoản (
providerID
) - Cờ bật tính năng tự động tải lại (
isRecurring
) - Ngưỡng mà số dư tài khoản trả trước phải giảm xuống dưới để kích hoạt tính năng
tự động tải lại (
replenishAmount
) - Số tiền cần tự động thêm vào tài khoản (
recurringAmount
) - Tham số truy vấn
supportedCurrencyID
để chỉ định đơn vị tiền tệ.
Trong ví dụ sau, khi số dư trong tài khoản trả trước của công ty giảm xuống dưới 5 đô la Mỹ, hệ thống sẽ tự động thêm 10 đô la Mỹ vào tài khoản.
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "providerId": "worldpay-myorg", "isRecurring" : true, "replenishAmount" : 5, "recurringAmount" : 10 }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/{company_id}/developer-balances/recurring-setup?supportedCurrencyId=usd" \ -u email:password
Để biết nội dung mô tả về các thuộc tính yêu cầu, hãy xem bài viết Tóm tắt về các thuộc tính yêu cầu để thiết lập tính năng tự động tải lại tài khoản trả trước.
Tóm tắt các thuộc tính yêu cầu để thiết lập tính năng tự động tải lại tài khoản trả trước
Bạn có thể chỉ định các thuộc tính sau khi tự động nạp lại số dư tài khoản trả trước bằng API.
Tên | Mô tả | Mặc định | Bắt buộc? |
---|---|---|---|
providerId |
Mã nhận dạng của nhà cung cấp dịch vụ thanh toán. |
Không áp dụng | Có |
chargePerUsage |
false | Không | |
isRecurring |
Cờ chỉ định xem có bật tính năng tự động tải lại hay không ( |
Không áp dụng | Có |
replenishAmount |
Ngưỡng mà số dư tài khoản trả trước phải giảm xuống dưới để kích hoạt tính năng tự động tải lại. |
Không áp dụng | Có |
recurringAmount |
Số tiền cần thêm vào số dư tài khoản trả trước khi tính năng tự động nạp lại được kích hoạt. |
Không áp dụng | Có |
Di chuyển sang trang thanh toán được lưu trữ của WorldPay
WorldPay đã cập nhật quy trình xử lý thanh toán bảo mật để sử dụng một nhóm trang mới, được gọi là Trang thanh toán được lưu trữ.
Nếu đã định cấu hình(các) nhà cung cấp dịch vụ thanh toán WorldPay bằng quy trình xử lý thanh toán bảo mật không còn được dùng nữa (trước tháng 8 năm 2017), thì bạn cần di chuyển sang Trang thanh toán được lưu trữ mới của WorldPay trước tháng 1 năm 2018.
Cách di chuyển sang Trang thanh toán được lưu trữ của WorldPay:
- Hãy liên hệ với WorldPay để di chuyển tài khoản hiện tại của bạn sang sử dụng Trang thanh toán được lưu trữ mới và nhận mã cài đặt mới cho tài khoản của bạn.
- Định cấu hình nhà cung cấp thanh toán WorldPay mới, như mô tả trong phần Định cấu hình nhà cung cấp thanh toán trong Edge, truyền mã cài đặt trong trường
authType
. - Định cấu hình(các) nhà cung cấp dịch vụ thanh toán mới trên cổng thông tin dành cho nhà phát triển, như mô tả trong phần Định cấu hình tính năng kiếm tiền trong Cổng thông tin dành cho nhà phát triển.
- Nếu thiết lập tính năng tự động nạp lại tài khoản trả trước bằng nhà cung cấp dịch vụ thanh toán, bạn cần định cấu hình lại tính năng tự động nạp lại để sử dụng mã nhà cung cấp mới, như mô tả trong phần Thiết lập tính năng tự động nạp lại số dư tài khoản trả trước bằng API.
Các bước tiếp theo
Bạn có thể đặt hạn mức tín dụng cho từng nhà phát triển trả sau. Tìm hiểu cách thực hiện trong phần Quản lý số dư trả sau.