Thực hiện chi tiền cho người dùng
Thực hiện chi tiền cho người dùng
- application/json
- application/xml
- application/x-www-form-urlencoded
Request Body required
API dùng để thực hiện lệnh chi tiền cho người dùng qua tài khoản Zalopay, tài khoản ngân hàng
- app_id int64 required
Định danh cho ứng dụng (web, app, pos ...) hay dịch vụ (auto-debit, disbursement ...) của Merchant được cấp khi đăng ký tích hợp phương thức thanh toán với Zalopay.
- payment_id string required
Mã thanh toán của Zalopay cấp cho Merchant để thực hiện chi hộ.
- partner_order_id string required
Mã giao dịch Merchant gửi qua hệ thống Zalopay để thực hiện lệnh chi hộ (TXID của giao dịch chi hộ). Merchant dùng giá trị này cho việc tra cứu thông tin trạng thái giao dịch và đối soát.
- disbursement_type string required
Loại chi hộ:
WALLET
hoặcBANK
. - receiver_info string required
Thông tin tài khoản người nhận tiền đã được mã hóa. Dùng RSA public key để thực hiện mã hóa.
- amount int64 required
Số tiền chi của giao dịch.
- description string required
Thông tin mô tả giao dịch chi tiền.
- partner_embed_data string required
Thông tin cụ thể của merchant khi thực hiện lệnh chi tiền, là một chuỗi JSON.
- Mặc định:"{}"
.
- Sử dụng ví Doanh nghiệp:“{\“merchant_wallet_id\”:\ “35AA123456\”}"
. Giá trị"35AA123456"
là giá trị dùng để ví dụ. - mc_reference_id string
Thông tin riêng của Merchant khi cần cho việc đối soát lệnh chi hộ theo Mã giao dịch chi hộ (partner_order_id).
Ví dụ: Mã định danh của giao dịch chi trên hệ thống của Merchant, mã người dùng ... - extra_info string required
Dữ liệu riêng của giao dịch.
Trường hợp không có thì để giá trị"{}"
. - time int64 required
Thời gian gửi yêu cầu chi hộ (unix timestamp in milisecond). Thời gian tính đến milisecond, lấy theo giờ hiện hành.
- sig string
Thông tin chứng thực: mac = HMAC(hmac_algorihtm, mac key, hmacinput), chi tiết như bên dưới:
- hmac_algorihtm: là phương thức bảo mật được Merchant đăng ký với Zalopay, mặc định là HmacSHA256.
- mac key: được cung cấp bởi Zalopay.
- hmac_input = app_id +|
+ payment_id +|
+ partner_order_id +|
+ disbursement_type +|
+ receiver_info (after encrypt) +|
+ amount +|
+ description +|
+ partner_embed_data +|
+ extra_info +|
time.Vui lòng tham khảo phần truyền dữ liệu an toàn để biết thêm chi tiết.
Request Body required
API dùng để thực hiện lệnh chi tiền cho người dùng qua tài khoản Zalopay, tài khoản ngân hàng
- app_id int64 required
Định danh cho ứng dụng (web, app, pos ...) hay dịch vụ (auto-debit, disbursement ...) của Merchant được cấp khi đăng ký tích hợp phương thức thanh toán với Zalopay.
- payment_id string required
Mã thanh toán của Zalopay cấp cho Merchant để thực hiện chi hộ.
- partner_order_id string required
Mã giao dịch Merchant gửi qua hệ thống Zalopay để thực hiện lệnh chi hộ (TXID của giao dịch chi hộ). Merchant dùng giá trị này cho việc tra cứu thông tin trạng thái giao dịch và đối soát.
- disbursement_type string required
Loại chi hộ:
WALLET
hoặcBANK
. - receiver_info string required
Thông tin tài khoản người nhận tiền đã được mã hóa. Dùng RSA public key để thực hiện mã hóa.
- amount int64 required
Số tiền chi của giao dịch.
- description string required
Thông tin mô tả giao dịch chi tiền.
- partner_embed_data string required
Thông tin cụ thể của merchant khi thực hiện lệnh chi tiền, là một chuỗi JSON.
- Mặc định:"{}"
.
- Sử dụng ví Doanh nghiệp:“{\“merchant_wallet_id\”:\ “35AA123456\”}"
. Giá trị"35AA123456"
là giá trị dùng để ví dụ. - mc_reference_id string
Thông tin riêng của Merchant khi cần cho việc đối soát lệnh chi hộ theo Mã giao dịch chi hộ (partner_order_id).
Ví dụ: Mã định danh của giao dịch chi trên hệ thống của Merchant, mã người dùng ... - extra_info string required
Dữ liệu riêng của giao dịch.
Trường hợp không có thì để giá trị"{}"
. - time int64 required
Thời gian gửi yêu cầu chi hộ (unix timestamp in milisecond). Thời gian tính đến milisecond, lấy theo giờ hiện hành.
- sig string
Thông tin chứng thực: mac = HMAC(hmac_algorihtm, mac key, hmacinput), chi tiết như bên dưới:
- hmac_algorihtm: là phương thức bảo mật được Merchant đăng ký với Zalopay, mặc định là HmacSHA256.
- mac key: được cung cấp bởi Zalopay.
- hmac_input = app_id +|
+ payment_id +|
+ partner_order_id +|
+ disbursement_type +|
+ receiver_info (after encrypt) +|
+ amount +|
+ description +|
+ partner_embed_data +|
+ extra_info +|
time.Vui lòng tham khảo phần truyền dữ liệu an toàn để biết thêm chi tiết.
Request Body required
API dùng để thực hiện lệnh chi tiền cho người dùng qua tài khoản Zalopay, tài khoản ngân hàng
- app_id int64 required
Định danh cho ứng dụng (web, app, pos ...) hay dịch vụ (auto-debit, disbursement ...) của Merchant được cấp khi đăng ký tích hợp phương thức thanh toán với Zalopay.
- payment_id string required
Mã thanh toán của Zalopay cấp cho Merchant để thực hiện chi hộ.
- partner_order_id string required
Mã giao dịch Merchant gửi qua hệ thống Zalopay để thực hiện lệnh chi hộ (TXID của giao dịch chi hộ). Merchant dùng giá trị này cho việc tra cứu thông tin trạng thái giao dịch và đối soát.
- disbursement_type string required
Loại chi hộ:
WALLET
hoặcBANK
. - receiver_info string required
Thông tin tài khoản người nhận tiền đã được mã hóa. Dùng RSA public key để thực hiện mã hóa.
- amount int64 required
Số tiền chi của giao dịch.
- description string required
Thông tin mô tả giao dịch chi tiền.
- partner_embed_data string required
Thông tin cụ thể của merchant khi thực hiện lệnh chi tiền, là một chuỗi JSON.
- Mặc định:"{}"
.
- Sử dụng ví Doanh nghiệp:“{\“merchant_wallet_id\”:\ “35AA123456\”}"
. Giá trị"35AA123456"
là giá trị dùng để ví dụ. - mc_reference_id string
Thông tin riêng của Merchant khi cần cho việc đối soát lệnh chi hộ theo Mã giao dịch chi hộ (partner_order_id).
Ví dụ: Mã định danh của giao dịch chi trên hệ thống của Merchant, mã người dùng ... - extra_info string required
Dữ liệu riêng của giao dịch.
Trường hợp không có thì để giá trị"{}"
. - time int64 required
Thời gian gửi yêu cầu chi hộ (unix timestamp in milisecond). Thời gian tính đến milisecond, lấy theo giờ hiện hành.
- sig string
Thông tin chứng thực: mac = HMAC(hmac_algorihtm, mac key, hmacinput), chi tiết như bên dưới:
- hmac_algorihtm: là phương thức bảo mật được Merchant đăng ký với Zalopay, mặc định là HmacSHA256.
- mac key: được cung cấp bởi Zalopay.
- hmac_input = app_id +|
+ payment_id +|
+ partner_order_id +|
+ disbursement_type +|
+ receiver_info (after encrypt) +|
+ amount +|
+ description +|
+ partner_embed_data +|
+ extra_info +|
time.Vui lòng tham khảo phần truyền dữ liệu an toàn để biết thêm chi tiết.
- 200
OK
- application/json
- Schema
- Example (from schema)
Schema
- return_code integer
Mã trạng thái.
Vui lòng tham khảo mã trạng thái để biết thêm chi tiết. - return_message string
Mô tả mã trạng thái.
- sub_return_code integer
Mã trạng thái chi tiết.
Vui lòng tham khảo mã trạng thái để biết thêm chi tiết. - sub_return_message string
Mô tả mã trạng thái chi tiết.
data object
order_id stringĐịnh danh giao dịch của hệ thống Zalopay.
disbursement_type stringLoại chi hộ:
WALLET
hoặcBANK
m_u_id stringThông tin định danh người dùng của Zalopay.
Chú ý: Chỉ trả về khi disbursement_type ="WALLET"
.phone stringThông tin số điện thoại đăng ký Zalopay đã được che dấu. Ví dụ: masked_user_phone: "****6938".
Chú ý: Chỉ trả về khi disbursement_type ="WALLET"
.bank_code stringMã Ngân hàng thụ hưởng.
Chú ý: Chỉ trả về khi disbursement_type ="BANK"
.account_no stringSố tài khoản thụ hưởng.
Chú ý: Chỉ trả về khi chi qua tài khoản Ngân hàng (account), disbursement_type ="BANK"
.account_holder_name stringTên tài khoản thụ hưởng.
Chú ý: Chỉ trả về khi chi qua tài khoản Ngân hàng (account), disbursement_type ="BANK"
.card_no stringSố thẻ thụ hưởng.
Chú ý: Chỉ trả về khi chi qua tài khoản Ngân hàng (account), disbursement_type ="BANK"
.card_holder_name stringTên thẻ thụ hưởng.
Chú ý: Chỉ trả về khi chi qua tài khoản Ngân hàng (account), disbursement_type ="BANK"
.status integerTrạng thái thực hiện lệnh chi.
- 3 PROCESSING: Giao dịch đang được hệ thống xử lý, merchant lặp lại gọi API Query Transaction (/v2/disbursement/query-txn) trong một khoảng thời gian để truy vấn cho đến khi đạt trạng thái cuối cùng.
- 4 PENDING: Giao dịch đang chờ xử lý, cần liên hệ OP Zalopay để hỗ trợ.amount int64Số tiền chi của giao dịch.
partner_fee int64Phí chi hộ của merchant.
zlp_fee int64Phí chi hộ của Zalopay.
server_time int64Thời gian bắt đầu xử lý của hệ thống.
{
"return_code": 0,
"return_message": "string",
"sub_return_code": 0,
"sub_return_message": "string",
"data": {
"order_id": "string",
"disbursement_type": "string",
"m_u_id": "string",
"phone": "string",
"bank_code": "string",
"account_no": "string",
"account_holder_name": "string",
"card_no": "string",
"card_holder_name": "string",
"status": 0,
"amount": 0,
"partner_fee": 0,
"zlp_fee": 0,
"server_time": 0
}
}