Hàm chi hộ

HTTP request

POST {{URL}}/api/v2/disbursement/create

URL

+ Sanbox: http://sb-disbursement.esms.center

+ Production: https://api.vihatsoftware.com

• Content Type: application/json

• Response Type: application/json

curl --location --globoff '{{URL}}/api/v2/disbursement/create' \
--header 'token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyZGF0YSI6IntcIlVzZXJJZFwiOjEsXCJTY29wZXNcIjpudWxsLFwiVG9rZW5cIjpudWxsfSJ9.vPtV3VpWN9fzwCkYsp2B_gcLWgJmHH37A0SYzMyE3eA' \
--header 'Content-Type: application/json' \
--data '{
    "amount": {{amount}}, 
    "disbursementMethod": {{disbursementMethod}}, 
    "channel": {{channel}}, 
    "disbursementData": "{{disbursementData}}", 
    "orderId": {{orderId}}, 
    "callbackUrl": {{callbackUrl}}, 
    "description": {{description}}, 
    "signature": {{signature}} 
}'

Cấu trúc body của request:

Thuộc tính	Kiểu dữ liệu	Tính bắt buộc	Mô tả
token	String		token lấy được ở hàm đăng nhập.
amount	Int		Số tiền nạp vào ví. Nhỏ nhất 10.000 Là bội của 1000
disbursementMethod	Int		Hình thức chi hộ 1. Nạp vào ví điện tử
channel	Int		Kênh chi hộ 1: MoMo 2: ZaloPay
disbursementData	String		Thông tin chi hộ. Tùy theo kênh chi hộ sẽ có format khác nhau 1: Nạp vào ví điện tử disbursementData=base64({ "phone" : "0335690164" })
orderId	String (50)		Mã giao dịch ở phía khách hàng.
description	String (255)		Nội dung chi hộ - chuyển khỏan
signature	String		Chữ ký điện tử được tạo từ secretKey theo format bên dưới HmacSHA256(“amount_channel_description_disbursementData_disbursementMethod_orderId”)
callbackurl	String		eSMS sẽ trả trạng thái của giao dịch vào link callback của khách hàng. Callback trả về mẫu: Callback

• Response:

{
    "data": {
        "transactionId": "d675a4d9c6e64190be53737544fd98de",
        "channelId": 1,
        "method": 1,
        "amount": 10000000,
        "status": 0,
        "timestamp": 1724305723,
        "orderId": "mã-1724305722484",
        "callbackUrl": "https://webhook.site/6aacd916-2970-4ede-8588-9eca20fcc201"
    },
    "code": 0,
    "message": "Success"
}

• Cấu trúc body của response:

Thuộc tính	Mô tả
data	resultCode: Mã lỗi từ kênh chi hộ trả về. message: Thông tin lỗi từ kênh chi hộ orderId : Giá trị orderId. amount : Số tiền chi hộ. transactionId: Mã giao dịch eSMS trả về. channelId : Kênh chi hộ. method : Hình thức chi hộ. timestamp : Thời gian hòan thành giao dịch status : Trạng thái giao dịch (0: Trạng thái ban đầu, 1:Đang chờ , 2: Đang xử lý , 3: Thành công, -1: Thất bại ) callbackUrl : Link callback khách hàng truyền vào
code	Mã lỗi eSMS trả về 0 : Thành công.
message	Thông báo thành công hay thất bại của giao dịch.

• Thông tin chi tiết mã lỗi xem ở bảng: esms , momo, zalo .