PayLink

Generate PayLink API

เป็นเซอร์วิสที่ให้ร้านค้าสามารถสร้างรายการ PayLink ได้ โดยไม่ต้องเข้าไปใช้งานในหน้า Add New Link บนระบบ Frontend ของชิวเพย์

Endpoint Url สำหรับใช้งานในแต่ละ Environment

• Sandbox : https://sandbox-apipaylink.chillpay.co/api/v1/paylink/generate
• Production : https://api-paylink.chillpay.co/api/v1/paylink/generate

ตารางที่ 1.1 Request Header Parameters

No.	Parameters Name	Data Type	Length	Mandatory / Optional	Description
1	CHILLPAY-MerchantCode	String	15	M	รหัสร้านค้าที่ออกให้โดยชิวเพย์
2	CHILLPAY-ApiKey	String	100	M	รหัสอ้างอิงที่ออกให้โดยชิวเพย์ใช้ในการเชื่อมต่อระบบ

ตารางที่ 1.2 Request Body Parameters สำหรับส่งค่าผ่าน Method: POST

No.	Parameters Name	Data Type	Length	Mandatory / Optional	Description
1	ProductImage	String		O	รูปภาพสินค้าหรือบริการ * ร้านค้าจะต้องส่งข้อมูลรูปสินค้าหรือบริการ มาในรูปแบบของ string.base64
2	ProductName	String	255	M	ชื่อสินค้าหรือบริการ
3	ProductDescription	String	255	M	รายละเอียดสินค้าหรือบริการ
4	PaymentLimit	Number		O	จำนวนครั้งที่ชำระได้1 : ชำระครั้งเดียว0 : ไม่จำกัดจำนวน*หากไม่ได้ส่งมาค่าเริ่มต้นคือ 1
5	StartDate	String	19	M	วันที่ลิงก์สามารถเริ่มชำระเงินได้ [dd/MM/yyyy HH:mm:ss]
6	ExpiredDate	String	19	M	วันที่ลิงก์หมดอายุ [dd/MM/yyyy HH:mm:ss]
7	Currency	String	3	M	ข้อมูลสกุลเงิน เช่น THB, USD
8	Amount	Number		M	จำนวนเงินค่าสินค้าหรือบริการโดยที่ 2 หลักสุดท้ายจะเป็นค่าทศนิยม เช่น หากส่งข้อมูลมา 27500 ระบบจะอ่านค่าเป็น 275.00 *สกุลเงิน JPY และ KRW จะไม่ มีหน่วยทศนิยม
9	Checksum	String	32	M	ผลลัพธ์ที่ได้จากการนำค่าทั้งหมดไปเข้ารหัส MD5

ตัวอย่าง การเรียก Request Generate PayLink API (Code ภาษา C# .NET)

var client = new RestClient("https://api-paylink.chillpay.co/api/v1/paylink/generate");
var request = new RestRequest(Method.POST);
request.AddHeader("CHILLPAY-MerchantCode", "M000000");
request.AddHeader("CHILLPAY-ApiKey", "IvT3g19J2CfqNJJAXxbWdkXS5jCpo9XntXhCaiiwdu6eW7JviKBwRm02BlMxE773");
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("ProductImage", "");
request.AddParameter("ProductName", "AirPods Pro");
request.AddParameter("ProductDescription", "AirPods Pro have been designed to deliver Active Noise Cancellation for immersive sound.");
request.AddParameter("PaymentLimit", "");
request.AddParameter("StartDate", "01/10/2021 11:05:06");
request.AddParameter("ExpiredDate", "01/10/2022 11:05:06");
request.AddParameter("Currency", "THB");
request.AddParameter("Amount", "899200");
request.AddParameter("Checksum", "3f75f295446f11b5505a0adcc0955f1b");
IRestResponse response = client.Execute(request);

ตารางที่ 1.3 Response Message Parameters

No.	Parameters Name	Data Type	Length	Description
1	status	String	5	รหัสสถานะการทำรายการ
2	message	String	255	คำอธิบายสถานะการทำรายการ
3	data.payLinkId	Number		รหัสประจำลิงก์
4	data.productImage	String	255	ลิงก์รูปภาพสินค้าหรือบริการ
5	data.productName	String	255	ชื่อสินค้าหรือบริการ
6	data.productDescription	String	255	รายละเอียดสินค้าหรือบริการ
7	data.amount	Decimal	15,2	ค่าสินค้าหรือบริการ
8	data.currency	String	3	ข้อมูลสกุลเงิน
9	data.createdDate	String	19	วันเวลาที่สร้างลิงก์ [dd/MM/yyyy HH:mm:ss]
10	data.startDate	String	19	วันเวลาที่ลิงก์สามารถเริ่มชำระเงินได้[dd/MM/yyyy HH:mm:ss]
11	data.expiredDate	String	19	วันเวลาที่ลิงก์หมดอายุ [dd/MM/yyyy HH:mm:ss]
12	data.paymentLimit	Number		จำนวนครั้งที่ชำระได้
13	data.status	String	10	สถานะของลิงก์
14	data.payLinkToken	String	20	รหัสอ้างอิงลิงก์
15	data.paymentUrl	String	255	URL สำหรับชำระเงิน
16	data.qrImage	String		รูปภาพคิวอาร์สำหรับแสกนเปิดลิงก์* จะส่งข้อมูลในรูปแบบของ string.base64

ตัวอย่าง ข้อมูล JSON Response Message ที่ได้รับจากการเรียก Generate PayLink API

{
    "status": 200,
    "message": "Success",
    "data": {
        "payLinkId": 20255,
        "productImage": "",
        "productName": "AirPods Pro",
        "productDescription": "AirPods Pro have been designed to deliver Active Noise Cancellation for immersive sound.",
        "amount": 8992.00,
        "currency": "THB",
        "createdDate": "04/10/2021 15:35:11",
        "startDate": "01/10/2021 11:05:06",
        "expiredDate": "01/10/2022 11:05:06",
        "paymentLimit": 1,
        "status": "Actived",
        "payLinkToken": "BDKYCT0J4U",
        "paymentUrl": "https://link2.chillpay.co/BDKYCT0J4U",
        "qrImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAABPDSURBVHhe7ZNBbiRJEsTm/5+ebd7mQPOGG7yUpUUS4I1hEUqo/vn35eUl8v5AXl4G3h/..."
    }
}

Close PayLink API

เป็นเซอร์วิสในการปิดการใช้งาน PayLink เพื่อไม่ให้ลิงก์นั้นสามารถชำระเงินได้

Endpoint Url สำหรับใช้งานในแต่ละ Environment

• Sandbox : https://sandbox-apipaylink.chillpay.co/api/v1/paylink/close
• Production : https://api-paylink.chillpay.co/api/v1/paylink/close

ตารางที่ 2.1 Request Header Parameters

No.	Parameters Name	Data Type	Length	Mandatory / Optional	Description
1	CHILLPAY-MerchantCode	String	15	M	รหัสร้านค้าที่ออกให้โดยชิวเพย์
2	CHILLPAY-ApiKey	String	100	M	รหัสอ้างอิงที่ออกให้โดยชิวเพย์ใช้ในการเชื่อมต่อระบบ

ตารางที่ 2.2 Request Body Parameters สำหรับส่งค่าผ่าน Method: POST

No.	Parameters Name	Data Type	Length	Mandatory / Optional	Description
1	PayLinkId	Number		M	รหัสประจำลิงก์
2	Checksum	String	32	M	ผลลัพธ์ที่ได้จากการนำค่าทั้งหมดไปเข้ารหัส MD5

ตัวอย่าง การเรียก Request Close PayLink API (Code ภาษา C# .NET)

var client = new RestClient("https://api-paylink.chillpay.co/api/v1/paylink/close");
var request = new RestRequest(Method.POST);
request.AddHeader("CHILLPAY-MerchantCode", "M000000");
request.AddHeader("CHILLPAY-ApiKey", "IvT3g19J2CfqNJJAXxbWdkXS5jCpo9XntXhCaiiwdu6eW7JviKBwRm02BlMxE773");
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("PayLinkId", "20255");
request.AddParameter("Checksum", "a0568a51d7380d5e7db3ed0621075e2e");
IRestResponse response = client.Execute(request);

ตารางที่ 2.3 Response Message Parameters

No.	Parameters Name	Data Type	Length	Description
1	status	String	5	รหัสสถานะการทำรายการ
2	message	String	255	คำอธิบายสถานะการทำรายการ
3	data.payLinkId	Number		รหัสประจำลิงก์
4	data.productName	String	255	ชื่อสินค้าหรือบริการ
5	data.amount	Decimal	15,2	จำนวนเงินค่าสินค้าหรือบริการ
6	data.currency	String	3	ข้อมูลสกุลเงิน
7	data.createdDate	String	19	วันเวลาที่สร้างลิงก์ [dd/MM/yyyy HH:mm:ss]
8	data.modifiedDate	String	19	วันเวลาที่แก้ไขล่าสุด [dd/MM/yyyy HH:mm:ss]
9	data.status	String	10	สถานะของลิงก์

ตัวอย่าง ข้อมูล JSON Response Message ที่ได้รับจากการเรียก Close PayLink API

{
    "status": 200,
    "message": "Success",
    "data": {
        "payLinkId": 20255,
        "productName": "AirPods Pro",
        "amount": 8992.00,
        "currency": "THB",
        "createdDate": "04/10/2021 15:35:11",
        "modifiedDate": "04/10/2021 15:55:02",
        "status": "Closed"
    }
}

Delete PayLink API

เป็นเซอร์วิสในการลบรายการ PayLink ซึ่งลิงก์ที่สามารถลบได้ ต้องเป็นลิงก์ที่ไม่เคยสร้างรายการชำระเงินเลย

Endpoint Url สำหรับใช้งานในแต่ละ Environment

• Sandbox : https://sandbox-apipaylink.chillpay.co/api/v1/paylink/delete
• Production : https://api-paylink.chillpay.co/api/v1/paylink/delete

ตารางที่ 3.1 Request Header Parameters

No.	Parameters Name	Data Type	Length	Mandatory / Optional	Description
1	CHILLPAY-MerchantCode	String	15	M	รหัสร้านค้าที่ออกให้โดยชิวเพย์
2	CHILLPAY-ApiKey	String	100	M	รหัสอ้างอิงที่ออกให้โดยชิวเพย์ใช้ในการเชื่อมต่อระบบ

ตารางที่ 3.2 Request Body Parameters สำหรับส่งค่าผ่าน Method: POST

No.	Parameters Name	Data Type	Length	Mandatory / Optional	Description
1	PayLinkId	Number		M	รหัสประจำลิงก์
2	Checksum	String	32	M	ผลลัพธ์ที่ได้จากการนำค่าทั้งหมดไปเข้ารหัส MD5

ตัวอย่าง การเรียก Request Delete PayLink API (Code ภาษา C# .NET)

var client = new RestClient("https://api-paylink.chillpay.co/api/v1/paylink/delete");
var request = new RestRequest(Method.POST);
request.AddHeader("CHILLPAY-MerchantCode", "M000000");
request.AddHeader("CHILLPAY-ApiKey", "IvT3g19J2CfqNJJAXxbWdkXS5jCpo9XntXhCaiiwdu6eW7JviKBwRm02BlMxE773");
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("PayLinkId", "20255");
request.AddParameter("Checksum", "a0568a51d7380d5e7db3ed0621075e2e");
IRestResponse response = client.Execute(request);

ตารางที่ 3.3 Response Message Parameters

No.	Parameters Name	Data Type	Length	Description
1	status	String	5	รหัสสถานะการทำรายการ
2	message	String	255	คำอธิบายสถานะการทำรายการ
3	data.payLinkId	Number		รหัสประจำลิงก์
4	data.productName	String	255	ชื่อสินค้าหรือบริการ
5	data.amount	Decimal	15,2	จำนวนเงินค่าสินค้าหรือบริการ
6	data.currency	String	3	ข้อมูลสกุลเงิน
7	data.createdDate	String	19	วันเวลาที่สร้างลิงก์ [dd/MM/yyyy HH:mm:ss]
8	data.modifiedDate	String	19	วันเวลาที่แก้ไขล่าสุด [dd/MM/yyyy HH:mm:ss]
9	data.status	String	10	สถานะของลิงก์

ตัวอย่าง ข้อมูล JSON Response Message ที่ได้รับจากการเรียก Delete PayLink Api

{
    "status": 200,
    "message": "Success",
    "data": {
        "payLinkId": 20255,
        "productName": "AirPods Pro",
        "amount": 8992.00,
        "currency": "THB",
        "createdDate": "04/10/2021 15:35:11",
        "modifiedDate": "04/10/2021 15:59:18",
        "status": "Deleted"
    }
}

Search PayLink API

เป็นเซอร์วิสในการค้นหารายการ PayLink ของร้านค้าในระบบชิวเพย์

Endpoint Url สำหรับใช้งานในแต่ละ Environment

• Sandbox : https://sandbox-apipaylink.chillpay.co/api/v1/paylink/search
• Production : https://api-paylink.chillpay.co/api/v1/paylink/search

ตารางที่ 4.1 Request Header Parameters

No.	Parameters Name	Data Type	Length	Mandatory / Optional	Description
1	CHILLPAY-MerchantCode	String	15	M	รหัสร้านค้าที่ออกให้โดยชิวเพย์
2	CHILLPAY-ApiKey	String	100	M	รหัสอ้างอิงที่ออกให้โดยชิวเพย์ใช้ในการเชื่อมต่อระบบ

ตารางที่ 4.2 Request Body Parameters สำหรับส่งค่าผ่าน Method: POST

No.	Parameters Name	Data Type	Length	Mandatory / Optional	Description
1	OrderBy	String	20	O	เรียงตามคอลัมน์PayLinkId : รหัสประจำลิงก์ProductName : ชื่อสินค้าหรือบริการAmount : ค่าสินค้าหรือบริการCreatedDate : วันที่สร้างNumberOfUse : จำนวนที่ทำรายการไปแล้วStatus : สถานะของลิงก์* หากไม่ได้ส่งมาค่าเริ่มต้นคือ PayLinkId
2	OrderDir	String	4	O	ทิศทางการเรียงASC : เรียงจากน้อยไปมากDESC : เรียงจากมากไปน้อย* หากไม่ได้ส่งมาค่าเริ่มต้นคือ DESC
3	PageSize	Number		O	จำนวนรายการต่อหน้า (1-100)* หากไม่ได้ส่งมาค่าเริ่มต้นคือ 10
4	PageNumber	Number		O	เลขหน้า* หากไม่ได้ส่งมาค่าเริ่มต้นคือ 1
5	PayLinkId	Number		O	รหัสประจำลิงก์
6	ProductName	String	255	O	ชื่อสินค้าหรือบริการ
7	Status	String	10	O	สถานะของลิงก์
8	CreatedDateFrom	String	19	O	วันที่สร้างลิงก์ (จาก)[dd/MM/yyyy HH:mm:ss]
9	CreatedDateTo	String	19	O	วันที่สร้างลิงก์ (ถึง)[dd/MM/yyyy HH:mm:ss]
10	Checksum	String	32	M	ผลลัพธ์ที่ได้จากการนำค่าทั้งหมดไปเข้ารหัส MD5

ตัวอย่าง การเรียก Request Search PayLink API (Code ภาษา C# .NET)

var client = new RestClient("https://api-paylink.chillpay.co/api/v1/paylink/search");
var request = new RestRequest(Method.POST);
request.AddHeader("CHILLPAY-MerchantCode", "M000000");
request.AddHeader("CHILLPAY-ApiKey", "IvT3g19J2CfqNJJAXxbWdkXS5jCpo9XntXhCaiiwdu6eW7JviKBwRm02BlMxE773");
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("OrderBy", "");
request.AddParameter("OrderDir", "");
request.AddParameter("PageSize", "");
request.AddParameter("PageNumber", "");
request.AddParameter("PayLinkId", "");
request.AddParameter("ProductName", "");
request.AddParameter("ProductDescription", "");
request.AddParameter("Status", "");
request.AddParameter("CreatedDateFrom", "");
request.AddParameter("CreatedDateTo", "");
request.AddParameter("Checksum", "5d85f1096f37c540b5118a50ed399bcd");
IRestResponse response = client.Execute(request);

ตารางที่ 4.3 Response Message Parameters

No.	Parameters Name	Data Type	Length	Description
1	totalRecord	Number		จำนวนรายการทั้งหมด
2	pageSize	Number		จำนวนรายการต่อหน้า
3	pageNumber	Number		เลขที่หน้า
4	filteredRecord	Number		จำนวนรายการในหน้าปัจจุบัน
5	status	String	5	รหัสสถานะการทำรายการ
6	message	String	255	คำอธิบายสถานะการทำรายการ
7	data.payLinkId	Number		รหัสประจำลิงก์
8	data.productName	String	255	ชื่อสินค้าหรือบริการ
9	data.amount	Decimal	15,2	จำนวนเงินค่าสินค้าหรือบริการ
10	data.currency	String	3	ข้อมูลสกุลเงิน
11	data.createdDate	String	19	วันเวลาที่สร้างลิงก์ [dd/MM/yyyy HH:mm:ss]
12	data.paymentLimit	Number		จำนวนครั้งที่ชำระได้
13	data.numberOfUse	Number		จำนวนที่ทำรายการชำระเงินไปแล้ว
14	data.status	String	10	สถานะของลิงก์

ตัวอย่าง ข้อมูล JSON Response Message ที่ได้รับจากการเรียก Search PayLink API

{
    "totalRecord": 961,
    "pageSize": 5,
    "pageNumber": 1,
    "filteredRecord": 5,
    "status": 200,
    "message": "Success",
    "data": [
        {
            "payLinkId": 21955,
            "productName": "[SIT] Test Create From API Service",
            "amount": 20.00,
            "currency": "THB",
            "createdDate": "01/10/2021 10:15:48",
            "paymentLimit": 10,
            "numberOfUse": 0,
            "status": "Actived"
        },
        {
            "payLinkId": 21954,
            "productName": "[SIT] Test Create From API Service",
            "amount": 20.00,
            "currency": "THB",
            "createdDate": "01/10/2021 10:11:42",
            "paymentLimit": 10,
            "numberOfUse": 0,
            "status": "Actived"
        },
        {
            "payLinkId": 21953,
            "productName": "[SIT] Test Create From API Service",
            "amount": 20.00,
            "currency": "THB",
            "createdDate": "01/10/2021 10:11:15",
            "paymentLimit": 10,
            "numberOfUse": 0,
            "status": "Actived"
        },
        {
            "payLinkId": 21946,
            "productName": "ทดสอบ Success case",
            "amount": 3000.00,
            "currency": "THB",
            "createdDate": "30/09/2021 11:07:17",
            "paymentLimit": 0,
            "numberOfUse": 1,
            "status": "Actived"
        },
        {
            "payLinkId": 21945,
            "productName": "ทดสอบ Success case",
            "amount": 3000.00,
            "currency": "THB",
            "createdDate": "30/09/2021 11:06:05",
            "paymentLimit": 0,
            "numberOfUse": 0,
            "status": "Actived"
        }
    ]
}

PayLink Details API

เป็นเซอร์วิสที่ให้ร้านค้าสามารถเรียกดูข้อมูลรายละเอียดต่างๆ ของรายการ PayLink ที่ร้านค้าเคยสร้างไว้

Endpoint Url สำหรับใช้งานในแต่ละ Environment

• Sandbox : https://sandbox-apipaylink.chillpay.co/api/v1/paylink/details
• Production : https://api-paylink.chillpay.co/api/v1/paylink/details

ตารางที่ 5.1 Request Header Parameters

No.	Parameters Name	Data Type	Length	Mandatory / Optional	Description
1	CHILLPAY-MerchantCode	String	15	M	รหัสร้านค้าที่ออกให้โดยชิวเพย์
2	CHILLPAY-ApiKey	String	100	M	รหัสอ้างอิงที่ออกให้โดยชิวเพย์ใช้ในการเชื่อมต่อระบบ

ตารางที่ 5.2 Request Body Parameters สำหรับส่งค่าผ่าน Method: POST

No.	Parameters Name	Data Type	Length	Mandatory / Optional	Description
1	PayLinkId	Number		M	รหัสประจำลิงก์
2	Checksum	String	32	M	ผลลัพธ์ที่ได้จากการนำค่าทั้งหมดไปเข้ารหัส MD5

ตัวอย่าง การเรียก Request Details PayLink API (Code ภาษา C# .NET)

var client = new RestClient("https://api-paylink.chillpay.co/api/v1/paylink/details");
var request = new RestRequest(Method.POST);
request.AddHeader("CHILLPAY-MerchantCode", "M000000");
request.AddHeader("CHILLPAY-ApiKey", "IvT3g19J2CfqNJJAXxbWdkXS5jCpo9XntXhCaiiwdu6eW7JviKBwRm02BlMxE773");
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("PayLinkId", "20255");
request.AddParameter("Checksum", "a0568a51d7380d5e7db3ed0621075e2e");
IRestResponse response = client.Execute(request);

ตารางที่ 5.3 Response Message Parameters

No.	Parameters Name	Data Type	Length	Description
1	status	String	5	รหัสสถานะการทำรายการ
2	message	String	255	คำอธิบายสถานะการทำรายการ
3	data.payLinkId	Number		รหัสประจำลิงก์
4	data.productImage	String	255	ลิงก์รูปภาพสินค้าหรือบริการ
5	data.productName	String	255	ชื่อสินค้าหรือบริการ
6	data.productDescription	String	255	รายละเอียดสินค้าหรือบริการ
7	data.amount	Decimal	15,2	จำนวนเงินค่าสินค้าหรือบริการ
8	data.currency	String	3	ข้อมูลสกุลเงิน
9	data.createdDate	String	19	วันเวลาที่สร้างลิงก์ [dd/MM/yyyy HH:mm:ss]
10	data.startDate	String	19	วันเวลาที่ลิงก์สามารถเริ่มชำระเงินได้[dd/MM/yyyy HH:mm:ss]
11	data.expiredDate	String	19	วันเวลาที่ลิงก์หมดอายุ [dd/MM/yyyy HH:mm:ss]
12	data.paymentLimit	Number		จำนวนครั้งที่ชำระได้
13	data.numberOfUse	Number		จำนวนที่ทำรายการชำระเงินไปแล้ว
14	data.status	String	10	สถานะของลิงก์
15	data.payLinkToken	String	20	รหัสอ้างอิงลิงก์
16	Data.PaymentUrl	String	255	URL สำหรับชำระเงิน
17	Data.QRImage	String		รูปภาพคิวอาร์สำหรับแสกนเปิดลิงก์* จะส่งข้อมูลในรูปแบบของ string.base64

ตัวอย่าง ข้อมูล JSON Response Message ที่ได้รับจากการเรียก PayLink Details API

{
    "status": 200,
    "message": "Success",
    "data": {
        "payLinkId": 20255,
        "productImage": "",
        "productName": "AirPods Pro",
        "productDescription": "AirPods Pro have been designed to deliver Active Noise Cancellation for immersive sound.",
        "amount": 8992.00,
        "currency": "THB",
        "createdDate": "04/10/2021 15:35:11",
        "startDate": "01/10/2021 11:05:06",
        "expiredDate": "01/10/2022 11:05:06",
        "paymentLimit": 1,
        "numberOfUse": 1,
        "status": "Actived",
        "payLinkToken": "BDKYCT0J4U",
        "paymentUrl": "https://link2.chillpay.co/BDKYCT0J4U",
        "qrImage": "data:image/png;base64,iVBORw0KGgoAAAANSUh..."
    }
}

Search PayLink Transactions API

เป็นเซอร์วิสในการค้นหารายการ PayLink transaction ของร้านค้าที่ชำระเงินผ่าน PayLink ในระบบชิวเพย์

Endpoint Url สำหรับใช้งานในแต่ละ Environment

• Sandbox : https://sandbox-apipaylink.chillpay.co/api/v1/paylinktransaction/search
• Production : https://api-paylink.chillpay.co/api/v1/paylinktransaction/search

ตารางที่ 6.1 Request Header Parameters

No.	Parameters Name	Data Type	Length	Mandatory / Optional	Description
1	CHILLPAY-MerchantCode	String	15	M	รหัสร้านค้าที่ออกให้โดยชิวเพย์
2	CHILLPAY-ApiKey	String	100	M	รหัสอ้างอิงที่ออกให้โดยชิวเพย์ใช้ในการเชื่อมต่อระบบ

ตารางที่ 6.2 Request Body Parameters สำหรับส่งค่าผ่าน Method: POST

No.	Parameters Name	Data Type	Length	Mandatory / Optional	Description
1	OrderBy	String	20	O	เรียงตามคอลัมน์TransactionId : เลขที่อ้างอิงรายการสำหรับร้านค้าTransactionDate : วันที่ทำรายการPaymentDate : วันที่ชำระเงินProductName : ชื่อสินค้าหรือบริการCustomerName : ชื่อลูกค้าCustomerPhoneNumber : เบอร์โทรศัพท์ลูกค้าAmount : ค่าสินค้าหรือบริการFee : ค่าธรรมเนียมDiscount : ส่วนลดNetAmount : ราคาสุทธิPaymentStatus : ผลการชำระเงิน* หากไม่ได้ส่งมาค่าเริ่มต้นคือ TransactionId
2	OrderDir	String	4	O	ทิศทางการเรียงASC : เรียงจากน้อยไปมากDESC : เรียงจากมากไปน้อย* หากไม่ได้ส่งมาค่าเริ่มต้นคือ DESC
3	PageSize	Number		O	จำนวนรายการต่อหน้า (1-100)* หากไม่ได้ส่งมาค่าเริ่มต้นคือ 10
4	PageNumber	Number		O	เลขหน้า* หากไม่ได้ส่งมาค่าเริ่มต้นคือ 1
5	TransactionId	Number		O	เลขที่อ้างอิงรายการสำหรับร้านค้า
6	TransactionDateFrom	String	19	O	วันที่ทำรายการ (จาก)[dd/MM/yyyy HH:mm:ss]
7	TransactionDateTo	String	19	O	วันที่ทำรายการ (ถึง)[dd/MM/yyyy HH:mm:ss]
8	PaymentDateFrom	String	19	O	วันที่ชำระเงิน (จาก)[dd/MM/yyyy HH:mm:ss]
9	PaymentDateTo	String	19	O	วันที่ชำระเงิน (ถึง)[dd/MM/yyyy HH:mm:ss]
10	ProductName	String	255	O	ชื่อสินค้าหรือบริการ
11	CustomerName	String	100	O	ชื่อลูกค้า
12	CustomerPhoneNumber	String	15	O	เบอร์โทรศัพท์ลูกค้า
13	PaymentStatus	String	15	O	ผลการชำระเงิน
14	Checksum	String	32	M	ผลลัพธ์ที่ได้จากการนำค่าทั้งหมดไปเข้ารหัส MD5

ตัวอย่าง การเรียก Request Search PayLink Transactions API (Code ภาษา C# .NET)

var client = new RestClient("https://api-paylink.chillpay.co/api/v1/paylinktransaction/search");
var request = new RestRequest(Method.POST);
request.AddHeader("CHILLPAY-MerchantCode", "M000000");
request.AddHeader("CHILLPAY-ApiKey", "IvT3g19J2CfqNJJAXxbWdkXS5jCpo9XntXhCaiiwdu6eW7JviKBwRm02BlMxE773");
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("OrderBy", "");
request.AddParameter("OrderDir", "");
request.AddParameter("PageSize", "");
request.AddParameter("PageNumber", "");
request.AddParameter("TransactionId", "");
request.AddParameter("TransactionDateFrom", "30/09/2021 00:00:00");
request.AddParameter("TransactionDateTo", "");
request.AddParameter("ProductName", "");
request.AddParameter("CustomerName", "");
request.AddParameter("CustomerPhoneNumber", "");
request.AddParameter("PaymentStatus", "");
request.AddParameter("Checksum", "5d85f1096f37c540b5118a50ed399bcd");
IRestResponse response = client.Execute(request);

ตารางที่ 6.3 Response Message Parameters

No.	Parameters Name	Data Type	Length	Description
1	totalRecord	Number		จำนวนรายการทั้งหมด
2	pageSize	Number		จำนวนรายการต่อหน้า
3	pageNumber	Number		เลขที่หน้า
4	filteredRecord	Number		จำนวนรายการในหน้าปัจจุบัน
5	status	String	5	รหัสสถานะการทำรายการ
6	message	String	255	คำอธิบายสถานะการทำรายการ
7	data.transactionId	Number		เลขที่อ้างอิงรายการสำหรับร้านค้า
8	data.transactionDate	String	19	วันที่ทำรายการ [dd/MM/yyyy HH:mm:ss]
9	data.paymentDate	String	19	วันที่ชำระเงิน [dd/MM/yyyy HH:mm:ss]
10	data.productName	String	255	ชื่อสินค้าหรือบริการ
11	data.customerName	String	100	ชื่อลูกค้า
12	data.customerPhoneNumber	String	15	เบอร์โทรศัพท์ลูกค้า
13	data.amount	Decimal	15,2	ค่าสินค้าหรือบริการ
14	data.fee	Decimal	15,2	ค่าธรรมเนียม
15	data.discount	Decimal	15,2	ส่วนลด
16	data.netAmount	Decimal	15,2	ราคาสุทธิ
17	data.currency	String	3	ข้อมูลสกุลเงิน
18	data.paymentStatus	String	20	ผลการชำระเงิน

ตัวอย่าง ข้อมูล JSON Response Message ที่ได้รับจากการเรียก Search PayLink Transactions Api

{
    "totalRecord": 2,
    "pageSize": 10,
    "pageNumber": 1,
    "filteredRecord": 2,
    "status": 200,
    "message": "Success",
    "data": [
        {
            "transactionId": 139939,
            "transactionDate": "30/09/2021 11:07:29",
            "paymentDate": "30/09/2021 11:08:16",
            "productName": "ทดสอบ Success case",
            "customerName": "Test Payment By ChillPay",
            "customerPhoneNumber": "0826923245",
            "amount": 3000.00,
            "fee": 0.00,
            "discount": 0.00,
            "netAmount": 3000.00,
            "currency": "THB",
            "paymentStatus": "Success"
        },
        {
            "transactionId": 139938,
            "transactionDate": "30/09/2021 11:05:09",
            "paymentDate": "30/09/2021 11:21:01",
            "productName": "กรณีดู API PayLink Detail",
            "customerName": "Test Payment By ChillPay",
            "customerPhoneNumber": "0826923245",
            "amount": 3000.00,
            "fee": 97.50,
            "discount": 0.00,
            "netAmount": 3097.50,
            "currency": "THB",
            "paymentStatus": "Cancel"
        }
    ]
}

PayLink Transactions Details API

เป็นเซอร์วิสที่ให้ร้านค้าสามารถเรียกดูข้อมูลรายละเอียดต่างๆ ของรายการ PayLink Transactions ได้

Endpoint Url สำหรับใช้งานในแต่ละ Environment

• Sandbox : https://sandbox-apipaylink.chillpay.co/api/v1/paylinktransaction/details
• Production : https://api-paylink.chillpay.co/api/v1/paylinktransaction/details

ตารางที่ 7.1 Request Header Parameters

No.	Parameters Name	Data Type	Length	Mandatory / Optional	Description
1	CHILLPAY-MerchantCode	String	15	M	รหัสร้านค้าที่ออกให้โดยชิวเพย์
2	CHILLPAY-ApiKey	String	100	M	รหัสอ้างอิงที่ออกให้โดยชิวเพย์ใช้ในการเชื่อมต่อระบบ

ตารางที่ 7.2 Request Body Parameters สำหรับส่งค่าผ่าน Method: POST

No.	Parameters Name	Data Type	Length	Mandatory / Optional	Description
1	TransactionId	Number		M	เลขที่อ้างอิงรายการสำหรับร้านค้า
2	Checksum	String	32	M	ผลลัพธ์ที่ได้จากการนำค่าทั้งหมดไปเข้ารหัส MD5

ตัวอย่าง การเรียก Request PayLink Transactions Details API (Code ภาษา C# .NET)

var client = new RestClient("https://api-paylink.chillpay.co/api/v1/paylinktransaction/details");
var request = new RestRequest(Method.POST);
request.AddHeader("CHILLPAY-MerchantCode", "M000000");
request.AddHeader("CHILLPAY-ApiKey", "IvT3g19J2CfqNJJAXxbWdkXS5jCpo9XntXhCaiiwdu6eW7JviKBwRm02BlMxE773");
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("TransactionId", "136509");
request.AddParameter("Checksum", "a0568a51d7380d5e7db3ed0621075e2e");
IRestResponse response = client.Execute(request);

ตารางที่ 7.3 Response Message Parameters

No.	Parameters Name	Data Type	Length	Description
1	status	String	5	รหัสสถานะการทำรายการ
2	message	String	255	คำอธิบายสถานะการทำรายการ
3	data.payLinkId	Number		รหัสประจำลิงก์
4	data.productName	String	255	ชื่อสินค้าหรือบริการ
5	data.productDescription	String	255	รายละเอียดสินค้าหรือบริการ
6	data.transactionId	Number		เลขที่อ้างอิงรายการสำหรับร้านค้า
7	data.transactionDate	String	19	วันที่ทำรายการ [dd/MM/yyyy HH:mm:ss]
8	data.paymentDate	String	19	วันที่ชำระเงิน [dd/MM/yyyy HH:mm:ss]
9	data.customerName	String	100	ชื่อลูกค้า
10	data.customerPhoneNumber	String	15	เบอร์โทรศัพท์ลูกค้า
11	data.channelName	String	50	ช่องทางการชำระเงิน
12	data.amount	Decimal	15,2	ค่าสินค้าหรือบริการ
13	data.fee	Decimal	15,2	ค่าธรรมเนียม
14	data.discount	Decimal	15,2	ส่วนลด
15	data.netAmount	Decimal	15,2	ราคาสุทธิ
16	data.currency	String	3	ข้อมูลสกุลเงิน
17	data.paymentStatus	String	15	ผลการชำระเงิน

ตัวอย่าง ข้อมูล JSON Response Message ที่ได้รับจากการเรียก PayLink Transactions Details API

{
    "status": 200,
    "message": "Success",
    "data": {
        "payLinkId": 20916,
        "productName": "[SIT] Test Create From API Service",
        "productDescription": "test create paylink from api service #1",
        "transactionId": 136509,
        "transactionDate": "19/08/2021 14:55:28",
        "paymentDate": "19/08/2021 14:55:49",
        "customerName": "Anucha Kunaroop",
        "customerPhoneNumber": "0822318917",
        "channelName": "Internet Banking (ธ.กรุงเทพ)",
        "amount": 20.00,
        "fee": 0.00,
        "discount": 0.00,
        "netAmount": 20.00,
        "currency": "THB",
        "paymentStatus": "Success"
    }
}

ภาคผนวก

ภาคผนวก ก. รหัสสถานะของลิงก์

No.	Status Message	Description
1	Closed	ลิงก์ถูกปิดการใช้งาน
2	Success	ลิงก์ถูกชำระเงินสำเร็จ
3	Cancelled	ลิงก์ถูกยกเลิก
4	Deleted	ลิงก์ถูกลบ
5	Expired	ลิงก์หมดอายุ
6	Waiting	ลิงก์อยู่ระหว่างดำเนินการ ยังไม่พร้อมใช้งาน
7	Actived	ลิงก์พร้อมใช้งาน

ภาคผนวก ข. รหัสผลของการชำระเงินของลูกค้า (ข้อมูลการชำระเงินจากทางธนาคาร)

No.	Status Message	Description
1	Success	ทำรายการชำระเงินสำเร็จ
2	Fail	ทำรายการชำระเงินไม่สำเร็จ
3	Cancel	ลูกค้ายกเลิกทำรายการชำระเงิน
4	Error	เกิดข้อผิดพลาดระหว่างทำรายการชำระเงิน
5	Transaction Timeout	ลูกค้าไม่ทำรายการในระยะเวลาที่กำหนด
6	Transaction Pending	รอการชำระค่าสินค้า/บริการ
7	Voided	ทำรายการ Void สำเร็จ
8	Refunded	ทำรายการ Refund สำเร็จ
9	Refund Requested	ทำรายการเพื่อขอ Refund
10	Settlement Success	ทำรายการโอนเงินให้ร้านค้าสำเร็จ
11	Void Fail	ทำรายการ Void ไม่สำเร็จ
12	Refund Fail	ทำรายการ Refund ไม่สำเร็จ

ภาคผนวก ค. รหัสผลของการทำรายการส่งข้อมูลกลับไปให้ร้านค้า

Code	Status Message	Description
200	Success	ทำรายการสำเร็จ
1001	Invalid Parameter	ข้อมูลพารามิเตอร์ไม่ถูกต้อง
1002	Invalid MerchantCode	รหัสร้านค้าไม่ถูกต้อง
1003	Invalid PayLinkId	รหัสประจำลิงก์ไม่ถูกต้อง
1004	Invalid ProductName	ชื่อสินค้าหรือบริการไม่ถูกต้อง
1005	Invalid ProductDescription	รายละเอียดสินค้าหรือบริการไม่ถูกต้อง
1006	Invalid StartDate	วันที่ลิงก์สามารถเริ่มชำระเงินได้ไม่ถูกต้อง
1007	Invalid ExpiredDate	วันที่ลิงก์หมดอายุไม่ถูกต้อง
1008	Invalid Currency	สกุลเงินไม่ถูกต้อง
1009	Invalid TransactionId	เลขที่อ้างอิงรายการสำหรับร้านค้าไม่ถูกต้อง
1010	Invalid ApiKey	รหัสอ้างอิงร้านค้าไม่ถูกต้อง
1011	Invalid Checksum	รหัส Checksum ไม่ถูกต้อง
2001	Invalid MerchantCode Data	ข้อมูลรหัสร้านค้าไม่ถูกต้อง
2002	Invalid PayLinkId Data	ข้อมูลรหัสประจำลิงก์ไม่ถูกต้อง
2003	Invalid ProductName Data	ข้อมูลชื่อสินค้าหรือบริการไม่ถูกต้อง
2004	Invalid ProductDescription Data	ข้อมูลรายละเอียดสินค้าหรือบริการไม่ถูกต้อง
2005	Invalid Amount Data	ข้อมูลจำนวนเงินค่าสินค้าหรือบริการไม่ถูกต้อง
2006	Invalid Currency Data	ข้อมูลสกุลเงินไม่ถูกต้อง
2007	Invalid CreatedDate Data	ข้อมูลวันเวลาที่สร้างลิงก์ไม่ถูกต้อง
2008	Invalid StartDate Data	ข้อมูลวันที่ลิงก์สามารถเริ่มชำระเงินได้ไม่ถูกต้อง
2009	Invalid ExpiredDate Data	ข้อมูลวันที่ลิงก์หมดอายุไม่ถูกต้อง
2010	Invalid PaymentLimit Data	ข้อมูลจำนวนครั้งที่ชำระได้ไม่ถูกต้อง
2011	Invalid Status Data	ข้อมูลสถานะของลิงก์ไม่ถูกต้อง
2012	Invalid TransactionId Data	ข้อมูลเลขที่อ้างอิงรายการสำหรับร้านค้าไม่ถูกต้อง
2013	Invalid TransactionDate Data	ข้อมูลวันที่ทำรายการไม่ถูกต้อง
2014	Invalid PaymentDate Data	ข้อมูลวันที่ชำระเงินไม่ถูกต้อง
2015	Invalid CustomerName Data	ข้อมูลชื่อลูกค้าไม่ถูกต้อง
2016	Invalid CustomerPhoneNumber Data	ข้อมูลเบอร์โทรศัพท์ลูกค้าไม่ถูกต้อง
2017	Invalid PaymentStatus Data	ข้อมูลผลการชำระเงินไม่ถูกต้อง
2018	Invalid OrderBy Data	ข้อมูลสำหรับเรียงตามคอลัมน์ไม่ถูกต้อง
2019	Invalid OrderDir Data	ข้อมูลสำหรับทิศทางการเรียงไม่ถูกต้อง
2020	Invalid PageSize Data	ข้อมูลจำนวนรายการต่อหน้าไม่ถูดต้อง
2021	Invalid PageNumber Data	ข้อมูลเลขหน้าไม่ถูกต้อง
2022	Invalid ApiKey Data	ข้อมูลรหัสอ้างอิงร้านค้าไม่ถูกต้อง
2023	Invalid Checksum Data	ข้อมูลรหัส Checksum ไม่ถูกต้อง
2024	Currency Not Support	สกุลเงินไม่รองรับ
2025	Amount Less Than Min	จำนวนเงินค่าสินค้าหรือบริการต่ำกว่าจำนวนเงินขั้นต่ำที่สามารถทำรายการได้
2026	Amount More Than Max	จำนวนเงินค่าสินค้าหรือบริการสูงกว่าจำนวนเงินสูงสุดที่สามารถทำรายการได้
3001	PayLink Create Failed	ไม่สามารถสร้างลิงก์ได้
3002	PayLink Not Found	ไม่เจอรายการลิงก์
3003	PayLink Status Mismatch	สถานะรายการไม่ตรงเงื่อนไข
3004	PayLink Update Failed	ไม่สามารถอัพเดทสถานะของลิงก์ได้
3005	PayLink Transaction Not Found	ไม่เจอรายการชำระเงิน
4001	Account Unauthorized	บัญชีร้านค้ายังไม่ได้รับการอนุมัติ
4002	System Error	ระบบเกิดข้อผิดพลาดไม่สามารถทำรายการได้
4003	System Maintenance Time	อยู่ในระยะเวลาปรับปรุงระบบ
4004	Request Exceeded Limit	การร้องขอเกินจำนวนที่กำหนด