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. Hãy xem phần Xem số dư tài khoản trả trước bằng API.
- Nạp tiền (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. Hãy xem phần 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, sau đó gọi API kiếm tiền để tải lại tài khoản, 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ính năng 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 bằng cách sử dụng API kiếm tiền và một nhà cung cấp dịch vụ thanh toán bên thứ ba như Worldpay. Tuỳ chọn này rất hữu ích khi 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 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ư 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òn lại 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 như mô tả trong phần này.usage
: Tổng số tiền được sử dụng trong kỳ thanh toán hiện tại. Giá trị này được cập nhật với 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 (tích cực hoặc âm).
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 lấy giá trị amount
trừ đi giá trị usage
. Ví dụ: nếu giá trị amount
là 335, 5 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
Những phần sau đây mô tả cách xem số dư tài khoản trả trước của một nhà phát triển hoặc công ty sử dụ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ỳ của 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ể chuyển các tham số truy vấn sau đây để lọc kết quả:
Tham số truy vấn | Nội dung mô tả |
---|---|
all |
Cờ chỉ định xem có trả về tất cả các gói API hay không. Nếu bạn đặt thành false, thì 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ố 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 một công ty
Để xem số dư tài khoản trả trước của một công ty, hãy gửi 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 hình thức trả trước, thì yêu cầu sẽ lấy số dư tài khoản trả trước hiện tại. Nếu công ty sử dụng hình 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ể chuyển các tham số truy vấn sau đây để lọc kết quả:
Tham số truy vấn | Nội dung mô tả |
---|---|
all |
Cờ chỉ định xem có trả về tất cả các gói API hay không. Nếu bạn đặt thành false, thì 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ố 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
Nội dung phản hồi tương tự như nội dung phản hồi ở 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 qua 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 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 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 như trình bày ở trên.
Bước | Nội dung mô tả |
---|---|
0 |
Các bước tiên quyết Là nhà cung cấp API, để thiết lập một nhà cung cấp dịch vụ thanh toán bên thứ ba như Worldpay, bạn phải: |
1 |
Để kích hoạt luồng, người dùng API sẽ thực hiện một trong những tác vụ sau trong 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ẽ thực hiện thanh toán cho nhà phát triển thông qua Edge, kèm theo 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 phần Bắt đầu thanh toán cho tài khoản trả trước qua nhà cung cấp dịch vụ thanh toán. |
3 | Edge tìm nhà cung cấp theo mã nhận dạng và xác định rằng đó là tài khoản Worldpay. |
4 | Edge tạo một mã đơn đặt hàng. |
5 | Edge tạo yêu cầu thanh toán trên Worldpay. |
6 | Worldpay sẽ trả về 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 chung của Edge /payment API. Phản hồi này được trả về cổng thông tin dành cho nhà phát triển để hoàn tất lệnh gọi đã 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 gọi lại (khi 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 cho nhà phát triển sẽ 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. Sau khi thành công, Worldpay sẽ tạo Mã xác thực thư (MAC) bằng cách sử dụng Mã bí mật MAC đã đị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 làm 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ố tiền và địa chỉ MAC được yêu cầu. |
14 | Cổng xác minh MAC theo bí mật MAC. MAC ngăn người khác tự ý tuyên bố rằng họ đã 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. |
Phần sau đây mô tả các bước mà bạn cần thực hiện để quản lý số dư trả trước bằ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 dịch vụ thanh toán trong Edge
- Xem những 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 cho nhà phát triển
- Bắt đầu thanh toán cho tài khoản trả trước thông qua 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 trê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 xác thực tài khoản, để thiết lập 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 của bạn bằng thông tin xác thực mà Worldpay cung cấp cho bạn.
- Đặt khoá bí mật mã xác thực thư và mật khẩu XML (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 gồm 20 đến 30 ký tự trong trường Mã bí mật MAC chuyển hướng.
- 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 người bán.
- Nhấp vào New Test IP (IP kiểm tra 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 để thêm các tham số Worldpay, bao gồm cả mã xác thực phương thức (MAC):
- Nhấp vào Cài đặt > Trang thanh toán được lưu trữ > Trình thiết kế trang thanh toán.
- Trong Edit Payment Pages (Chỉnh sửa trang thanh toán), chọn mã cài đặt từ danh sách thả xuống Select channel (Chọn kênh).
- Trên thẻ Thuộc tính, hãy chọn Chỉnh sửa cấu hình của người bán.
- Đặt giá trị của tham 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 Quảng bá trong mục Thiết kế để quảng cáo từ Thiết kế đến Hộp cát.
- Đối với môi trường sản xuất, hãy nhấp vào Quảng bá trong Hộp cát để quảng cáo từ Hộp cát lên Phiên bản chính thức.
Định cấu hình nhà cung cấp dịch vụ thanh toán trong Edge
Bước tiếp theo là định cấu hình 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 API sau:
/organizations/{org-name}/providers
Chỉ những khách hàng API riêng tư của Apigee có đặc quyền của quản trị viên hệ thống mới có thể tuỳ ý định cấu hình một nhà cung cấp dịch vụ thanh toán toàn cầu bằng API sau:
/config/providers
Khi gọi mỗi API, bạn phải chỉ định thông tin sau đây trong nội dung yêu cầu:
Tham số | 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 của bạn; username tương đương với mã người bán (viết hoa toàn bộ) 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 trê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 tiêu dùng API | Có |
name |
Tên để sử dụng cho nhà cung cấp.
Chỉ dành cho khách hàng của API riêng tư trên Đám mây riêng tư: Đố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 của Edge. Bạn nên thêm WorldPay (không phân biệt chữ hoa chữ thường) trong tên nhà cung cấp để dễ dàng nhận dạng. Ví dụ: |
Có |
Ví dụ: Quy trình sau đây giúp thiết lập tài khoản người bán với Worldpay: 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 đã đị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 tới tài nguyên sau:
/mint/organizations/{org-name}/providers
Ví dụ: phần sau đây cho thấy những 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 dùng để kiểm thử và một tài khoản dùng cho phiên bản chính thức.
{ "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 các mô-đun Kiếm tiền và Worldpay trong cổng thông tin 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 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.
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ư đã trình bày 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 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 người đó.
Để bắt đầu thanh toán từ nhà cung cấp dịch vụ thanh toán bên thứ ba bằng API, hãy gửi yêu cầu POST tới 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ư tài khoản trả trước (
amount={amount}
) - Mã nhà cung cấp dịch vụ 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ụ: thao tác sau đây sẽ tải lại số dư tài khoản trả trước qua nhà cung cấp dịch vụ thanh toán Worldpay. Số tiền chuyển ban đầu đến 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 dẫn đến trang Thanh toán an toàn của Worldpay sẽ được trả về trong referenceUrl
cùng với 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ư tài khoản trả trước bằng API
Như đã trình bày trong bước 15 của quy trình quản lý tài khoản trả trước, sau khi xác minh rằng nhà cung cấp dịch vụ 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ể tải lại số dư tài khoản trả trước bằng API dành cho một nhà phát triển hoặc công ty, như mô tả trong phần sau.
Tải lại số dư tài khoản trả trước cho nhà phát triển
Để tải lại số dư tài khoản trả trước cho nhà phát triển sử dụng API, hãy gửi yêu cầu POST tới /mint/organizations/{org_name}/developers/{developer_id}/developer-balances
, trong đó {developer_id}
là địa chỉ email của nhà phát triển. Khi gửi yêu cầu, bạn cần nêu rõ 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 cộng 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 để tải lại tài khoản trả trước.
Tải lại số dư tài khoản trả trước cho công ty
Để tải lại số dư tài khoản trả trước cho một công ty bằng API, hãy gửi yêu cầu POST tới /mint/organizations/{org_name}/companies/{company_id}/developer-balances
, trong đó {company_id}
là mã công ty. Khi gửi yêu cầu, bạn cần nêu rõ 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 thêm 1.000 đô la vào số dư tài khoản trả trước của 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
Để 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 để 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 để tải lại tài khoản trả trước
Bạn phải chỉ định các thuộc tính sau khi tải lại số dư tài khoản trả trước bằng API:
Tên | Nội dung mô tả | Mặc định | Bắt buộc? |
---|---|---|---|
amount |
Số tiền được áp dụng cho số dư trả trước (theo đơn vị tiền tệ hiện hành). |
Không áp dụng | Có |
supportedCurrency |
Đơn vị tiền tệ được sử dụng cho số dư trả trước. Đây là đơn vị tiền tệ đã được thiết lập cho gói trong gói 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 đã định cấu hình cho tổ chức Edge của bạn bằng cách gửi yêu cầu DELETE tới tài nguyên sau:
Để xoá 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ỉ những khách hàng dùng dịch vụ đám mây riêng tư của Apigee có đặc quyền của quản trị viên hệ thống mới có thể tuỳ ý xoá một nhà cung cấp dịch vụ thanh toán toàn cầu bằng API sau:
/config/providers/id
Ví dụ: thao tác sau đây sẽ xoá những nhà cung cấp dịch vụ thanh toán bên thứ ba hiện đã đị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 tải 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 thông qua một 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ư mô tả trong phần Tải lại số dư tài khoản trả trước bằng API.
Thiết lập tính năng tự động tải lại số dư tài khoản trả trước bằng API
Những phần sau đây mô tả cách 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 hoặc công ty sử dụng nhà cung cấp dịch vụ thanh toán bên thứ ba. Tuỳ chọn này sẽ hữu ích khi quản lý các khoản thanh toán định kỳ cho 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 tải 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 gửi yêu cầu POST tới /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ã của nhà cung cấp dịch vụ thanh toán cần sử dụng để tải lại tài khoản (
providerID
) - Cờ cho phép 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 ngưỡng để kích hoạt tính năng tự động tải lại (
replenishAmount
) - Số tiề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ỹ, thì tài khoản sẽ tự động nạp thêm 10 đô la Mỹ.
$ 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
Để 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 để thiết lập tính năng tự động tải lại tài khoản trả trước.
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
Để 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
dưới một mức 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ã của nhà cung cấp dịch vụ thanh toán cần sử dụng để tải lại tài khoản (
providerID
) - Cờ cho phép 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 ngưỡng để kích hoạt tính năng tự động tải lại (
replenishAmount
) - Số tiề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 công ty giảm xuống dưới 5 đô la Mỹ, thì tài khoản sẽ tự động nạp thêm 10 đô la Mỹ.
$ 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
Để 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 để 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 tải lại số dư tài khoản trả trước bằng API.
Tên | Nội dung mô tả | Mặc định | Bắt buộc? |
---|---|---|---|
providerId |
Mã 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 liệu 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 ngưỡng thì mới có thể 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 tải lại được kích hoạt. |
Không áp dụng | Có |
Di chuyển sang các trang thanh toán được lưu trữ trên 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, 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 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 nhằm 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 dịch vụ thanh toán mới của WorldPay, như mô tả trong bài viết Định cấu hình nhà cung cấp dịch vụ thanh toán trong Edge, truyền mã cài đặt vào 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 bài viết Thiết lập hoạt động kiếm tiền trong Cổng thông tin cho nhà phát triển.
- Nếu thiết lập tính năng tự động tải lại tài khoản trả trước thông qua 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 tải lại để sử dụng mã nhà cung cấp mới, như mô tả trong bài viết Thiết lập tính năng tự động tải 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.