API tạo giao dịch mới
Api cho phép bạn tạo giao dịch cho đơn hàng trên Checkout
Sử dụng phương thức POST với URL và các tham số như dưới đây:
https://checkout.vn/api/transaction/create
Tất cả các request đến API service sẽ được xác thực theo giá trị "Token" trong header của request
Lấy giá trị Token (Api token) tại đây
Header
| Key | Value |
|---|---|
| Content-Type | application/json |
| Token | TOKEN |
Tạo transaction với các tham số
Nội dung param
| Tên tham số | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|
| website_id | Int | Không |
Đơn hàng tạo từ Website nào Cách lấy id của website: Tại đây VD: 1 |
| order_id | Int | Có |
Mã đơn hàng của hệ thống CRM tích hợp sang checkout.vn VD:101 |
| description | String | Không |
Mô tả giao dịch VD: Thanh toán đơn hàng 1001 |
| pay_money | Double | Có |
Số tiền thanh toán VD: 100000 |
| currency | String | Có |
Loại tiền tệ VD: USD,VND |
| contact_name | String | Không |
Tên người thanh toán VD: NGUYEN VAN A |
| contact_email | String | Không |
Email người thanh toán VD: anh@gmail.com |
| contact_mobile | String | Không |
Số điện thoại người thanh toán VD: 0987654321 |
| status | Int | Có |
Trạng thái thanh toán 0: Chưa thanh toán 1: Đã thanh toán |
| gate_id | Int | Có |
Cổng thanh toán Cách lấy id của website: Tại đây VD: 12 |
| url_thanks | String | Không |
Link trả về kết quả thanh toán khi thành công VD: https://checkout.vn/payment/success |
| url_cancel | String | Không |
Link trả về kết quả thanh toán khi thất bại VD: https://checkout.vn/payment/faild |
| order_items | Array | Có |
Mảng danh sách sản phẩm trong đơn hàng { item_name: "Áo Nam", item_quantity : 2, item_price : 1000 } ] |
Định dạng dữ liệu mẫu Api chứa data là chuỗi json:
{
"website_id":"1",
"order_id":"1001",
"description": "Thanh toán đơn hàng 1001",
"pay_money":"10000",
"currency":"vnd",
"contact_name":"Nguyen Van A",
"contact_mobile":"0987654321",
"contact_email":"anh@gmail.com",
"gate_id":"2",
"status": 1,
"url_thanks":"",
"url_cancel":"",
"order_items" : [
{
"item_name": "Áo Nam",
"item_quantity" : 2,
"item_price" : 1000
},
{
"item_name": "Áo Nữ",
"item_quantity" : 1,
"item_price" : 5000
}
]
}
Response
| Tham số | Giá trị |
|---|---|
| error | false |
|
id
|
1 |
| msg |
Tạo giao dịch thành công
|
Code Mẫu
curl --location --request POST 'https://checkout.vn/api/transaction/create'
--header 'token: aiqekDbQcw6zhgSuY42kE7pC89MT0YcQFU66uAJejHNL2xzUfQ'
--header 'Content-Type: application/json'
--data-raw '{
"website_id":"1",
"description": "Thanh toán đơn hàng 1001",
"currency":"vnd",
"gate_id":"2",
"status": 1,
"pay_money":"10000",
"contact_name":"Nguyen Van A",
"contact_mobile":"0987654321",
"contact_email":"anh@gmail.com",
"order_id":"1001",
"url_thanks":"",
"url_cancel":"",
"order_items" : [
{
"item_name": "Áo Nam",
"item_quantity" : 2,
"item_price" : 1000
},
{
"item_name": "Áo Nữ",
"item_quantity" : 1,
"item_price" : 5000
}
]
}'