THAM SỐ ĐẦU VÀO

STT

Tên tham số

Kiểu dữ liệu

Mô tả

1

Merchant_site_code

Int (11)

Mã merchant site (khi khai báo website tại NgânLượng.vn sẽ phát sinh mã này)

2

params

String XML

Là một chuỗi các tham số được định dạng theo cấu trúc của XML. Params nhận 5 tham số dưới đây

receiver

String (255)

Địa chỉ Email của tài khoản NgânLượng.vn nhận tiền nạp

order_code

String (50)

Mã hóa đơn (duy nhất) do merchant phát sinh, dùng để cập nhật tự động trạng thái (ví dụ: nạp tiền ảo cho khách tại merchant) khi NgânLượng.vn trả kết quả về

return_url

String (500)

Địa chỉ url NgânLượng.vn trả về kết quả khi giao dịch nạp tiền thành công

cancel_url

String (500)

Địa chỉ url NgânLượng.vn trả về kết quả khi khách hàng từ chối nạp tiền

language

String (4)

Ngôn ngữ hiển thị trên form giao diện của NgânLượng.vn, nhận một trong hai giá trị sau:
vn: tiếng Việt
en: tiếng Anh

Ví dụ về tham số params:
params =
“<params>
                <receiver>diendc@nganluong.vn</receiver>
                <language>vn></language>
                <return_url>http://sandbox.nganluong.vn/demo/update_order.php</return_url>
                <cancel_url>http://sandbox.nganluong.vn/demo/cancel_order.php</cancel_url>
</params>”

3

checksum

String (50)

Mã kiểm tra tính hợp lệ khi truy cập API của NgânLượng.vn

Cấu trúc của tham số checksum
checksum = MD5(receiver+ order_code+ return_url+ cancel_url+language+Mật khẩu giao tiếp khi khai báo website tại NgânLượng.vn).
Ví dụ: checksum được tạo bởi mã ngôn ngữ lập trình PHP:
$receiver = "diendc@nganluong.vn";
$order_code = "24785324";
$return_url = "http://sandbox.nganluong.vn/demo/update_order.php";
$cancel_url = "http://sandbox.nganluong.vn/demo/cancel_order.php";
$languge ="vn";
$password = "2e9ee046bba482cc52e5121c3c9958ff";
$checksum = MD5($receiver+$order_code+$return_url+$cancel_url+$languge+$password);

THAM SỐ ĐẦU RA

Result

String (500)

Kết quả trả về là một chuỗi string được định dạng theo cấu trúc XML, bao gồm các tham số dưới đây

result_code

String (4)

Mã kết quả trả về khi gọi hàm SetExpressCheckoutDeposit

token

String (100)

Mã tham chiếu giao dịch thanh toán (mã tham chiếu này sẽ được sử dụng trong suốt quá trình thanh toán của NgânLượng.vn)

link_checkout

String (255)

Đây là url để khách hàng thanh toán (sẽ được chèn vào mã javascript để bật lên popup)

time_limit

String (19)

Thời gian hết hạn thanh toán ứng với một token (dd/mm/YYYY, HH:ii:ss)

result_description

String (500)

Mô tả lỗi tương ứng với giá trị của result_code

Cấu trúc của kết quả trả về như sau:
“<result>
                <result_code>Mã lỗi</result_code>
                <result_description>Mô tả lỗi</result_description>
                <token>Mã tham chiếu giao dịch</token>
                <link_checkout>Đường link thanh toán (dùng để bật popup)</link_checkout>
                <time_limit>Thời gian timeout của mã token</time_limit>

THAM SỐ ĐẦU VÀO

STT

Tên tham số

Kiểu dữ liệu

Mô tả

1

merchant_site_code

Int (11)

Mã merchant site (khi khai báo website tại NgânLượng.vn sẽ phát sinh mã này)

2

params

String XML

Là một chuỗi các tham số được định dạng theo cấu trúc của XML. Params nhận các tham số dưới đây

Receiver

String (255)

Địa chỉ Email của tài khoản NgânLượng.vn nhận tiền thanh toán

order_code

String (50)

Mã hóa đơn bán hàng (duy nhất) do merchant phát sinh

Amount

String (20)

Tổng số tiền toàn bộ đơn hàng khách hàng phải thanh toán

currency_code

String (5)

Mã tiền tệ niêm yết tại website bán hàng, nhận các giá trị sau: VND hoặc USD

tax_amount

String (20)

Tổng tiền thuế (nếu có)

discount_amount

String (20)

Tổng tiền khách hàng được giảm giá

no_shipping

Int (1)

Hàng hóa có phải vận chuyển hay không, nội dung số giá trị này = 1

fee_shipping

String (20)

Tổng phí vận chuyển, nội dung số giá trị này = 0

request_confirm_shipping

Int (1)

Yêu cầu người mua nhập thông tin nhận hàng, với nội dung số giá trị này = 0

return_url

String (500)

Địa chỉ url NgânLượng.vn trả về kết quả khi giao dịch nạp tiền thành công

cancel_url

String (500)

Địa chỉ url NgânLượng.vn trả về kết quả khi khách hàng từ chối nạp tiền

Language

String (4)

Ngôn ngữ hiển thị trên form giao diện của NgânLượng.vn, nhận một trong hai giá trị sau:
vn: tiếng Việt
en: tiếng Anh

Items

String XML

Thông tin chi tiết sản phẩm cần thanh toán, items được lưu theo cấu trúc XML có dạg như sau

<items>
                <item>
                                <item_name>Tên sản phẩm 1</item_name>
                                <item_quanty>Số lượng sản phẩm 1</item_quanty>
                                <item_amount>Đơn giá sản phẩm 1</item_amount>
                </item>
                <item>
                                <item_name>Tên sản phẩm 2</item_name>
                                <item_quanty>Số lượng sản phẩm 2</item_quanty>
                                <item_amount>Đơn giá sản phẩm 2</item_amount>
                </item>
                …

Ví dụ về tham số params:
params = “<params>
                <receiver>diendc@nganluong.vn</receiver>
                <order_code>DH-115813-29092011</order_code>
                <amount>3700</amount>
                <currency_code>vnd</currency_code>
                <tax_amount>0</tax_amount>
                <discount_amount>0</discount_amount>
                <fee_shipping>0</fee_shipping>
                <request_confirm_shipping>0</request_confirm_shipping>
                <no_shipping>1</no_shipping>
                <return_url>http://sandbox.nganluong.vn/demo/update_order.php</return_url>
                <cancel_url>http://sandbox.nganluong.vn/demo/cancel_order.php</cancel_url>
                <language>vn</language>
                <items>
                                <item>
                                                <item_name>Cuốn sách hoàn hảo về ngôn ngữ cơ thể</item_name>
                                                <item_quanty>1</item_quanty>
                                                <item_amount>2000</item_amount>
                                </item>
                                <item>
                                                <item_name>Sản phẩm 2</item_name>
                                                <item_quanty>1</item_quanty>
                                                <item_amount>1000</item_amount>
                                </item>
                                <item>
                                                <item_name>Sản phẩm 3</item_name>
                                                <item_quanty>1</item_quanty>
                                                <item_amount>700</item_amount>
                                </item>
                </items>

3

Checksum

String (50)

Mã kiểm tra tính hợp lệ khi truy cập API của NgânLượng.vn

checksum = MD5(receiver+ order_code+amount+ currency_code + tax_amount + discount_amount + no_shipping + fee_shipping + request_confirm_shipping +return_url+ cancel_url+Mật khẩu giao tiếp khi khai báo website tại NgânLượng.vn).

Ví dụ: checksum được tạo bởi mã ngôn ngữ lập trình PHP:
$receiver = "diendc@nganluong.vn";
$order_code = "24785324";
$amount = "1000";
$currency_code = "VND";
$tax_amount = 0;
$discount_amount = 0;
$no_shipping = 1;
$fee_shipping = 0;
$request_confirm_shipping = 0;
$return_url = "http://sandbox.nganluong.vn/demo/update_order.php";
$cancel_url = "http://sandbox.nganluong.vn/demo/cancel_order.php";
$password = "2e9ee046bba482cc52e5121c3c9958ff";
$checksum = MD5($receiver +  $order_code + $amount + $currency_code + $tax_amount + $discount_amount + $no_shipping + $fee_shipping + $request_confirm_shipping +$return_url+ $cancel_url+$password);

THAM SỐ ĐẦU RA

Result

String XML

Kết quả trả về là một chuỗi string được định dạng theo cấu trúc XML, bao gồm các tham số dưới đây

result_code

String (4)

Mã kết quả trả về khi gọi hàm SetExpressCheckoutPayment

Token

String (100)

Mã tham chiếu giao dịch thanh toán (mã tham chiếu này sẽ được sử dụng trong suốt quá trình thanh toán của NgânLượng.vn)

link_checkout

String (255)

Đây là url để khách hàng thanh toán (sẽ được chèn vào mã javascript để bật lên popup)

time_limit

String (19)

Thời gian hết hạn thanh toán ứng với một token (dd/mm/YYYY, HH:ii:ss)

result_description

String (500)

Mô tả lỗi tương ứng với giá trị của result_code

Cấu trúc của kết quả trả về như sau:
“<result>
                <result_code>Mã lỗi</result_code>
                <result_description>Mô tả lỗi</result_description>
                <token>Mã tham chiếu giao dịch</token>
                <link_checkout>Đường link thanh toán (dùng để bật popup)</link_checkout>
                <time_limit>Thời gian timeout của mã token</time_limit>

THAM SỐ ĐẦU VÀO

STT

Tên tham số

Kiểu dữ liệu

Mô tả

1

merchant_site_code

Int (11)

Mã merchant site (khi khai báo website tại NgânLượng.vn sẽ phát sinh mã này)

2

Params

String (50)

Chứa mã token được sinh ra bởi hàm SetExpressCheckoutDeposit hoặc SetExpressCheckoutPayment.
Params được lưu theo cấu trúc XML như sau:

Giá trị token

3

Checksum

String (50)

Mã kiểm tra tính hợp lệ khi truy cập API của NgânLượng.vn

checksum = MD5(token+Mật khẩu giao tiếp khi khai báo website tại NgânLượng.vn).

Ví dụ: checksum được tạo bởi mã ngôn ngữ lập trình PHP:
$token = "b4609b508dc5418f93da6cbc97d5cb61";
$password = "2e9ee046bba482cc52e5121c3c9958ff";
$checksum = MD5($token +  $password);

THAM SỐ ĐẦU RA

result

String XML

Kết quả trả về là một chuỗi string được định dạng theo cấu trúc XML, bao gồm các tham số dưới đây

result_code

String (4)

Mã kết quả trả về của hàm xử lý GetExpressCheckout

result_description

String (500)

Mô tả mã lỗi

time_limit

String (19)

Thời gian hết hạn thanh toán ứng với một token (dd/mm/YYYY,HH:ii:ss)

merchant_site_code

Int (11)

Mã đăng ký website của merchant tại NgânLượng.vn

transaction_id

Int (11)

Mã giao dịch thanh toán phát sinh tại NgânLượng.vn

Amount

String (20)

Tổng số tiền khách hàng đã thanh toán

currency_code

String (5)

Mã tiền tệ niêm yết tại website bán hàng, nhận các giá trị sau: VND hoặc USD

transaction_type

Int (1)

Phương thức thanh toán: 1 - Thanh toán ngay; 2 -  Thanh toán tạm giữ

transaction_status

Int (1)

Trạng thái giao dịch thanh toán: 1- Chưa thanh toán; 2 – Đã thanh toán, tiền đang tạm giữ; 3 – Giao dịch lỗi, 4 – Đã thanh toán, tiền đã chuyển vào tài khoản của người bán

payer_name

String (255)

Họ và tên người mua

payer_email

String (255)

Địa chỉ email người mua

payer_mobile

String (20)

Số điện thoại của người mua

receiver_name

String (255)

Họ tên người nhận hàng

receiver_address

String (500)

Địa chỉ nhận hàng

receiver_mobile

String (20)

Số điện thoại người nhận hàng

method_payment_name

String (255)

Tên hình thức thanh toán người mua sử dụng trên NgânLượng.vn

card_info

String XML

Danh sách: Loại thẻ, mã thẻ cào và mệnh giá thẻ

Cấu trúc kết quả trả về như sau:
“<result>
                <result_code></result_code>
                <result_description></result_description>                                           
                <time_limit></time_limit>
                <merchant_site_code></merchant_site_code>
                <transaction_id></transaction_id>
                <amount></amount>
                <currency_code></currency_code>
                <transaction_type></transaction_type>
                <transaction_status></transaction_status>
                <payer_name></payer_name>
                <payer_email></payer_email>
                <payer_mobile></payer_mobile>
                <receiver_name></receiver_name>
                <receiver_address></receiver_address>
                <receiver_mobile></receiver_mobile>
                <method_payment_name></method_payment_name>
             &