Search Payment Transaction
| Service Name: | Search Payment Transaction |
| URL: | [SANDBOX] https://sandbox-api-transaction.chillpay.co/api/v1/payment/search |
| [PROD] https://api-transaction.chillpay.co/api/v1/payment/search | |
| Method: | POST |
| Description: | āđāļāđāļāđāļāļāļĢāđāļ§āļīāļŠāđāļāļāļēāļĢāļāđāļāļŦāļēāļĢāļēāļĒāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ (Payment Transactions) – āļĢāđāļēāļāļāđāļēāļŦāļĨāļąāļāļŠāļēāļĄāļēāļĢāļāļāđāļāļŦāļēāļāđāļāļĄāļđāļĨāļāļāļāļĢāđāļēāļāļāđāļēāļĒāđāļāļĒāđāļāđ – āļĢāđāļēāļāļāđāļēāļĒāđāļāļĒāļŠāļēāļĄāļēāļĢāļāļāđāļāļŦāļēāđāļāđāđāļāļāļēāļ°āļĢāđāļēāļāļāđāļēāļāļāđāļāļāđāļāđāļēāļāļąāđāļ |
āļāļēāļĢāļēāļāļāļĩāđ 1.1 Request Header Parameters
| No. | Parameters Name | Data Type | Length | Mandatory / Optional | Description |
|---|---|---|---|---|---|
| 1 | Content-Type | String | 16 | M | application/json |
| 2 | CHILLPAY-MerchantCode | String | 15 | M | āļĢāļŦāļąāļŠāļĢāđāļēāļāļāđāļēāļāļĩāđāļāļāļāđāļŦāđāđāļāļĒāļāļīāļ§āđāļāļĒāđ |
| 3 | CHILLPAY-ApiKey | String | 100 | M | āļĢāļŦāļąāļŠāļāđāļēāļāļāļīāļāļāļĩāđāļāļāļāđāļŦāđāđāļāļĒāļāļīāļ§āđāļāļĒāđ āđāļāđāđāļāļāļēāļĢāđāļāļ·āđāļāļĄāļāđāļāļĢāļ°āļāļ |
āļāļēāļĢāļēāļāļāļĩāđ 1.2 Request Body Parameters
| No. | Parameters Name | Data Type | Length | Mandatory / Optional | Description |
|---|---|---|---|---|---|
| 1 | OrderBy | String | 20 | O | āđāļĢāļĩāļĒāļāļāļēāļĄāļāļāļĨāļąāļĄāļāđ- TransactionId- TransactionDate- Merchant- Customer- OrderNo- PaymentChannel- PaymentDate- Amount- Fee- Discount- TotalAmount- RouteNo- Status- Settled* āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ ” TransactionId” |
| 2 | OrderDir | String | 4 | O | āļāļēāļĢāđāļĢāļĩāļĒāļāļĨāļģāļāļąāļASC : āđāļĢāļĩāļĒāļāļāļēāļāļāđāļāļĒāđāļāļĄāļēāļDESC : āđāļĢāļĩāļĒāļāļāļēāļāļĄāļēāļāđāļāļāđāļāļĒ* āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ DESC |
| 3 | PageSize | Number | O | āļāļģāļāļ§āļāļĢāļēāļĒāļāļēāļĢāļāđāļāļŦāļāđāļē (1-100)* āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ 10 | |
| 4 | PageNumber | Number | O | āđāļĨāļāļŦāļāđāļē* āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ 1 | |
| 5 | SearchKeyword | String | 255 | O | āļāļģāļŦāļĢāļ·āļāļāđāļāļāļ§āļēāļĄāļāļĩāđāļāđāļāļāļāļēāļĢāļāđāļāļŦāļē |
| 6 | MerchantCode | String | 15 | O | āļĢāļŦāļąāļŠāļĢāđāļēāļāļāđāļēāļāļĩāđāļāđāļāļāļāļēāļĢāļāđāļāļŦāļē* āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ āļĢāđāļēāļāļāđāļēāļāļąāđāļāļŦāļĄāļ |
| 7 | PaymentChannel | String | 30 | O | āļāđāļāļāļāļēāļāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ āļ āļēāļāļāļāļ§āļ āļ. |
| 8 | RouteNo | Number | O | āđāļŠāđāļāļāļēāļāļāļģāļĢāļ°āđāļāļīāļ | |
| 9 | OrderNo | String | 20 | O | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļĢāđāļēāļāļāđāļē |
| 10 | Status | String | 20 | O | āļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ āļ āļēāļāļāļāļ§āļ āļ. |
| 11 | TransactionDateFrom | String | 19 | O | āļ§āļąāļāļāļĩāđāļāļģāļĢāļēāļĒāļāļēāļĢ (āļāļēāļ) [dd/MM/yyyy HH:mm:ss] |
| 12 | TransactionDateTo | String | 19 | O | āļ§āļąāļāļāļĩāđāļāļģāļĢāļēāļĒāļāļēāļĢ (āļāļķāļ) [dd/MM/yyyy HH:mm:ss] |
| 13 | PaymentDateFrom | String | 19 | O | āļ§āļąāļāļāļĩāđāļāļģāļĢāļ°āđāļāļīāļ (āļāļēāļ) [dd/MM/yyyy HH:mm:ss] |
| 14 | PaymentDateTo | String | 19 | O | āļ§āļąāļāļāļĩāđāļāļģāļĢāļ°āđāļāļīāļ (āļāļķāļ) [dd/MM/yyyy HH:mm:ss] |
| 15 | Checksum | String | 32 | M | āļāļĨāļĨāļąāļāļāđāļāļĩāđāđāļāđāļāļēāļāļāļēāļĢāļāļģāļāđāļēāļāļąāđāļāļŦāļĄāļāđāļāđāļāđāļēāļĢāļŦāļąāļŠ |
āļāļąāļ§āļāļĒāđāļēāļ āļāļēāļĢāđāļĢāļĩāļĒāļ Request Search Payment Transaction (Code āļ āļēāļĐāļē C# .NET)
var client = new RestClient("https://api-transaction.chillpay.co/api/v1/payment/search");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("CHILLPAY-MerchantCode", "xxx");
request.AddHeader("CHILLPAY-ApiKey", "xxx");
request.AddHeader("Content-Type", "application/json");
var body = @"{""OrderBy"": ""TransactionId"", ""OrderDir"": ""DESC"", ""PageSize"": null, ""PageNumber"": null, ""SearchKeyword"": null, ""MerchantCode"": null, ""PaymentChannel"": ""Credit Card"", ""RouteNo"": null, ""OrderNo"": null, ""Status"": null, ""TransactionDateFrom"": ""01/02/2021 00:00:00"", ""TransactionDateTo"": null, ""PaymentDateFrom"": null, ""PaymentDateTo"": null, ""Checksum"": ""c3b4619ec90e3d8c09da69262e398d7e""}";
request.AddParameter("application/json", body, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
āļŦāļĄāļēāļĒāđāļŦāļāļļ
- āļāđāļē Checksum āđāļāđāļāļāļēāļĢāļāļģāļāđāļēāļāļēāļ Parameter āļāļēāļĄāļāļēāļĢāļēāļāļāļĩāđ 1.2 (āļāđāļ 1-14) āļĄāļēāđāļĢāļĩāļĒāļāļāđāļāļāļąāļ āđāļĨāđāļ§āļāđāļāļāđāļēāļĒāļāđāļ§āļĒ MD5 Secret Key (āļāļĩāđāđāļāđāļĢāļąāļāļāļēāļāļāļēāļāļāļīāļ§āđāļāļĒāđ) āļāļąāļāļāļĩāđ
- OrderBy + OrderDir + PageSize + PageNumber + SearchKeyword + MerchantCode + PaymentChannel + RouteNo + OrderNo + Status + TransactionDateFrom + TransactionDateTo + PaymentDateFrom + PaymentDateTo + MD5 Secret Key
- āļāļēāļāļāļąāđāļāļāļģāļāđāļāļĄāļđāļĨāļāļĩāđāđāļĢāļĩāļĒāļāļāļąāļāļāļąāđāļāļŦāļĄāļāļāļĩāđāđāļāđāļāđāļēāļĢāļŦāļąāļŠāļāđāļ§āļĒāļāļąāļāļāđāļāļąāđāļ MD5 Hashing āļāļķāļāļāļ°āđāļāđāđāļāđāļāļāđāļē Checksum
- āļāļąāļ§āļāļĒāđāļēāļ āļāļēāļĢāļāļģāļāđāļāļĄāļđāļĨāļĄāļēāđāļĢāļĩāļĒāļāļāđāļāļāļąāļāđāļāļ·āđāļāđāļāđāļēāļāļąāļāļāđāļāļąāđāļ MD5TransactionIdDESCCredit
- Card01/02/2021 00:00:00AAABBBCCCDDD
āļāļēāļĢāļēāļāļāļĩāđ 1.3 Response Message Parameters
| No. | Parameters Name | Data Type | Description |
|---|---|---|---|
| 1 | totalRecord | Number | āļāļģāļāļ§āļāļĢāļēāļĒāļāļēāļĢāļāļąāđāļāļŦāļĄāļ |
| 2 | pageSize | Number | āļāļģāļāļ§āļāļĢāļēāļĒāļāļēāļĢāļāđāļāļŦāļāđāļē |
| 3 | pageNumber | Number | āđāļĨāļāļŦāļāđāļē |
| 4 | filteredRecord | Number | āļāļģāļāļ§āļāļĢāļēāļĒāļāļēāļĢāđāļāļŦāļāđāļēāļāļąāļāļāļļāļāļąāļ |
| 5 | status | String | āļĢāļŦāļąāļŠāļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļēāļĒāļāļēāļĢ āļ āļēāļāļāļāļ§āļ āļ. |
| 6 | message | String | āļāļģāļāļāļīāļāļēāļĒāļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļēāļĒāļāļēāļĢ |
| 7 | data[].transactionId | Number | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļāļīāļ§āđāļāļĒāđ |
| 8 | data[].transactionDate | String | āļ§āļąāļāļāļĩāđāļāļģāļĢāļēāļĒāļāļēāļĢ [dd/MM/yyyy HH:mm:ss] |
| 9 | data[].merchant | String | āļāļ·āđāļāļĢāđāļēāļāļāđāļē |
| 10 | data[].customer | String | āļĢāļŦāļąāļŠāļāđāļēāļāļāļīāļāļŦāļĢāļ·āļāļāļ·āđāļāļĨāļđāļāļāđāļē |
| 11 | data[].orderNo | String | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļĢāđāļēāļāļāđāļē |
| 12 | data[].paymentChannel | String | āļāđāļāļāļāļēāļāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ |
| 13 | data[].paymentDate | String | āļ§āļąāļāļāļĩāđāļāļģāļĢāļ°āđāļāļīāļ [dd/MM/yyyy HH:mm:ss] |
| 14 | data[].amount | String | āļāđāļēāļŠāļīāļāļāđāļēāļŦāļĢāļ·āļāļāļĢāļīāļāļēāļĢ [#,##0.00] |
| 15 | data[].fee | String | āļāđāļēāļāļĢāļĢāļĄāđāļāļĩāļĒāļĄ [#,##0.00] |
| 16 | data[].discount | String | āļŠāđāļ§āļāļĨāļ [#,##0.00] |
| 17 | data[].totalAmount | String | āļĢāļēāļāļēāļĢāļ§āļĄ [#,##0.00] |
| 18 | data[].currency | String | āļŠāļāļļāļĨāđāļāļīāļ |
| 19 | data[].routeNo | Number | āđāļŠāđāļāļāļēāļāļāļģāļĢāļ°āđāļāļīāļ |
| 20 | data[].status | String | āļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ |
| 21 | data[].settled | Boolean | āļŠāļāļēāļāļ°āļāļēāļĢāđāļāļāđāļāļīāļāđāļŦāđāļĢāđāļēāļāļāđāļē [True, False] |
āļāļąāļ§āļāļĒāđāļēāļ āļāđāļāļĄāļđāļĨ JSON Response Message āļāļĩāđāđāļāđāļĢāļąāļāļāļēāļāļāļēāļĢāđāļĢāļĩāļĒāļ API
{
"totalRecord": 264,
"pageSize": 10,
"pageNumber": 1,
"filteredRecord": 10,
"status": 200,
"message": "Success",
"data": [
{
"transactionId": 115309,
"transactionDate": "03/03/2022 15:27:53",
"merchant": "Bank Industries",
"customer": "AA",
"orderNo": "O1",
"paymentChannel": "Credit Card",
"paymentDate": "03/03/2022 15:28:11",
"amount": "5,000.00",
"fee": "15.00",
"discount": "0.00",
"totalAmount": "5,015.00",
"currency": "THB",
"routeNo": 3,
"status": "Fail",
"settled": false
},
...
]
}
Search Settlement Transaction
| Service Name: | Search Settlement Transaction |
| URL: | [SANDBOX] https://sandbox-api-transaction.chillpay.co/api/v1/settlement/search |
| [PROD] https://api-transaction.chillpay.co/api/v1/settlement/search | |
| Method: | POST |
| Description: | āđāļāđāļāđāļāļāļĢāđāļ§āļīāļŠāđāļāļāļēāļĢāļāđāļāļŦāļēāļĢāļēāļĒāļāļēāļĢāđāļāļāđāļāļīāļāļāļ·āļāļĢāđāļēāļāļāđāļē (Settlement Transactions) – āļĢāļēāļĒāļāļēāļĢāļāļĩāđāļāļ°āđāļŠāļāļāļŠāļđāļāļŠāļļāļāļāļ·āļāļĢāļēāļĒāļāļēāļĢāļāļāļāļ§āļąāļāļāļąāļāļāļļāļāļąāļ -1 – āļĢāđāļēāļāļāđāļēāļŦāļĨāļąāļāļŠāļēāļĄāļēāļĢāļāļāđāļāļŦāļēāļāđāļāļĄāļđāļĨāļāļāļāļĢāđāļēāļāļāđāļēāļĒāđāļāļĒāđāļāđ – āļĢāđāļēāļāļāđāļēāļĒāđāļāļĒāļŠāļēāļĄāļēāļĢāļāļāđāļāļŦāļēāđāļāđāđāļāļāļēāļ°āļĢāđāļēāļāļāđāļēāļāļāđāļāļāđāļāđāļēāļāļąāđāļ |
āļāļēāļĢāļēāļāļāļĩāđ 2.1 Request Header Parameters
| No. | Parameters Name | Data Type | Length | Mandatory / Optional | Description |
| 1 | Content-Type | String | 16 | M | application/json |
| 2 | CHILLPAY-MerchantCode | String | 15 | M | āļĢāļŦāļąāļŠāļĢāđāļēāļāļāđāļēāļāļĩāđāļāļāļāđāļŦāđāđāļāļĒāļāļīāļ§āđāļāļĒāđ |
| 3 | CHILLPAY-ApiKey | String | 100 | M | āļĢāļŦāļąāļŠāļāđāļēāļāļāļīāļāļāļĩāđāļāļāļāđāļŦāđāđāļāļĒāļāļīāļ§āđāļāļĒāđ āđāļāđāđāļāļāļēāļĢāđāļāļ·āđāļāļĄāļāđāļāļĢāļ°āļāļ |
āļāļēāļĢāļēāļāļāļĩāđ 2.2 Request Body Parameters
| No. | Parameters Name | Data Type | Length | Mandatory / Optional | Description |
| 1 | OrderBy | String | 20 | O | āđāļĢāļĩāļĒāļāļāļēāļĄāļāļāļĨāļąāļĄāļāđ- TransactionId- TransactionDate- PaymentDate- Merchant- Customer- OrderNo- PaymentChannel- Amount- Fee- NetAmount- ExchangeRate- Settled- Discount- RouteNo* āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ TransactionId |
| 2 | OrderDir | String | 4 | O | āļāļēāļĢāđāļĢāļĩāļĒāļāļĨāļģāļāļąāļASC : āđāļĢāļĩāļĒāļāļāļēāļāļāđāļāļĒāđāļāļĄāļēāļDESC : āđāļĢāļĩāļĒāļāļāļēāļāļĄāļēāļāđāļāļāđāļāļĒ* āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ DESC |
| 3 | PageSize | Number | O | āļāļģāļāļ§āļāļĢāļēāļĒāļāļēāļĢāļāđāļāļŦāļāđāļē (1-100)* āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ 10 | |
| 4 | PageNumber | Number | O | āđāļĨāļāļŦāļāđāļē* āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ 1 | |
| 5 | SearchKeyword | String | 255 | O | āļāļģāļŦāļĢāļ·āļāļāđāļāļāļ§āļēāļĄāļāļĩāđāļāđāļāļāļāļēāļĢāļāđāļāļŦāļē |
| 6 | MerchantCode | String | 15 | O | āļĢāļŦāļąāļŠāļĢāđāļēāļāļāđāļēāļāļĩāđāļāđāļāļāļāļēāļĢāļāđāļāļŦāļē* āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ āļĢāđāļēāļāļāđāļēāļāļąāđāļāļŦāļĄāļ |
| 7 | PaymentChannel | String | 30 | O | āļāđāļāļāļāļēāļāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ āļ āļēāļāļāļāļ§āļ āļ. |
| 8 | RouteNo | Number | O | āđāļŠāđāļāļāļēāļāļāļģāļĢāļ°āđāļāļīāļ | |
| 9 | OrderNo | String | 20 | O | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļĢāđāļēāļāļāđāļē |
| 10 | Settled | Boolean | O | āļŠāļāļēāļāļ°āļāļēāļĢāđāļāļāđāļāļīāļāđāļŦāđāļĢāđāļēāļāļāđāļē [True, False] | |
| 11 | TransactionDateFrom | String | 19 | O | āļ§āļąāļāļāļĩāđāļāļģāļĢāļēāļĒāļāļēāļĢ (āļāļēāļ) [dd/MM/yyyy HH:mm:ss] |
| 12 | TransactionDateTo | String | 19 | O | āļ§āļąāļāļāļĩāđāļāļģāļĢāļēāļĒāļāļēāļĢ (āļāļķāļ) [dd/MM/yyyy HH:mm:ss] |
| 13 | PaymentDateFrom | String | 19 | O | āļ§āļąāļāļāļĩāđāļāļģāļĢāļ°āđāļāļīāļ (āļāļēāļ) [dd/MM/yyyy HH:mm:ss] |
| 14 | PaymentDateTo | String | 19 | O | āļ§āļąāļāļāļĩāđāļāļģāļĢāļ°āđāļāļīāļ (āļāļķāļ) [dd/MM/yyyy HH:mm:ss] |
| 15 | Checksum | String | 32 | M | āļāļĨāļĨāļąāļāļāđāļāļĩāđāđāļāđāļāļēāļāļāļēāļĢāļāļģāļāđāļēāļāļąāđāļāļŦāļĄāļāđāļāđāļāđāļēāļĢāļŦāļąāļŠ |
āļāļąāļ§āļāļĒāđāļēāļ āļāļēāļĢāđāļĢāļĩāļĒāļ Request Search Settlement Transaction (Code āļ āļēāļĐāļē C# .NET)
var client = new RestClient("https://api-transaction.chillpay.co/api/v1/settlement/search");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("CHILLPAY-MerchantCode", "xxx");
request.AddHeader("CHILLPAY-ApiKey", "xxx");
request.AddHeader("Content-Type", "application/json");
var body = @"{""OrderBy"": ""TransactionId"", ""OrderDir"": ""DESC"", ""PageSize"": null, ""PageNumber"": null, ""SearchKeyword"": null, ""MerchantCode"": null, ""PaymentChannel"": null, ""RouteNo"": null, ""OrderNo"": null, ""Settled"": true, ""TransactionDateFrom"": null, ""TransactionDateTo"": null, ""PaymentDateFrom"": null, ""PaymentDateTo"": null, ""Checksum"": ""380eb9dff5f97b1c705030ee922959e6""}";
request.AddParameter("application/json", body, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
āļŦāļĄāļēāļĒāđāļŦāļāļļ
- āļāđāļē Checksum āđāļāđāļāļāļēāļĢāļāļģāļāđāļēāļāļēāļ Parameter āļāļēāļĄāļāļēāļĢāļēāļāļāļĩāđ 2.2 (āļāđāļ 1-14) āļĄāļēāđāļĢāļĩāļĒāļāļāđāļāļāļąāļ āđāļĨāđāļ§āļāđāļāļāđāļēāļĒāļāđāļ§āļĒ MD5 Secret Key (āļāļĩāđāđāļāđāļĢāļąāļāļāļēāļāļāļēāļāļāļīāļ§āđāļāļĒāđ) āļāļąāļāļāļĩāđ
- OrderBy + OrderDir + PageSize + PageNumber + SearchKeyword + MerchantCode + PaymentChannel + RouteNo + OrderNo + Settled + TransactionDateFrom + TransactionDateTo + PaymentDateFrom + PaymentDateTo + MD5 Secret Key
- āļāļēāļāļāļąāđāļāļāļģāļāđāļāļĄāļđāļĨāļāļĩāđāđāļĢāļĩāļĒāļāļāļąāļāļāļąāđāļāļŦāļĄāļāļāļĩāđāđāļāđāļāđāļēāļĢāļŦāļąāļŠāļāđāļ§āļĒāļāļąāļāļāđāļāļąāđāļ MD5 Hashing āļāļķāļāļāļ°āđāļāđāđāļāđāļāļāđāļē Checksum
- āļāļąāļ§āļāļĒāđāļēāļ āļāļēāļĢāļāļģāļāđāļāļĄāļđāļĨāļĄāļēāđāļĢāļĩāļĒāļāļāđāļāļāļąāļāđāļāļ·āđāļāđāļāđāļēāļāļąāļāļāđāļāļąāđāļ MD5
- TransactionIdDESCTrueAAABBBCCCDDD
- āļāļĢāļāļĩāļĢāđāļēāļāļāđāļēāļāđāļāļāļāļēāļĢāļŠāđāļāļāđāļē Settled āļāļ°āļĄāļĩāđāļāļ·āđāļāļāđāļāļāļąāļāļāļĩāđ
- – āļŦāļēāļāđāļāđāļ True āđāļŦāđāļāļģāļŦāļāļāļāđāļēāļāļāļāļŦāļē Checksum āđāļāđāļ âTrueâ
- – āļŦāļēāļāđāļāđāļ False āđāļŦāđāļāļģāļŦāļāļāļāđāļēāļāļāļāļŦāļē Checksum āđāļāđāļ âFalseâ
āļāļēāļĢāļēāļāļāļĩāđ 2.3 Response Message Parameters
| No. | Parameters Name | Data Type | Description |
|---|---|---|---|
| 1 | totalRecord | Number | āļāļģāļāļ§āļāļĢāļēāļĒāļāļēāļĢāļāļąāđāļāļŦāļĄāļ |
| 2 | pageSize | Number | āļāļģāļāļ§āļāļĢāļēāļĒāļāļēāļĢāļāđāļāļŦāļāđāļē |
| 3 | pageNumber | Number | āđāļĨāļāļŦāļāđāļē |
| 4 | filteredRecord | Number | āļāļģāļāļ§āļāļĢāļēāļĒāļāļēāļĢāđāļāļŦāļāđāļēāļāļąāļāļāļļāļāļąāļ |
| 5 | status | String | āļĢāļŦāļąāļŠāļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļēāļĒāļāļēāļĢ āļ āļēāļāļāļāļ§āļ āļ. |
| 6 | message | String | āļāļģāļāļāļīāļāļēāļĒāļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļēāļĒāļāļēāļĢ |
| 7 | data[].transactionId | Number | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļāļīāļ§āđāļāļĒāđ |
| 8 | data[].transactionDate | String | āļ§āļąāļāļāļĩāđāļāļģāļĢāļēāļĒāļāļēāļĢ [dd/MM/yyyy HH:mm:ss] |
| 9 | data[].paymentDate | String | āļ§āļąāļāļāļĩāđāļāļģāļĢāļ°āđāļāļīāļ [dd/MM/yyyy HH:mm:ss] |
| 10 | data[].merchant | String | āļāļ·āđāļāļĢāđāļēāļāļāđāļē |
| 11 | data[].customer | String | āļĢāļŦāļąāļŠāļāđāļēāļāļāļīāļāļŦāļĢāļ·āļāļāļ·āđāļāļĨāļđāļāļāđāļē |
| 12 | data[].orderNo | String | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļĢāđāļēāļāļāđāļē |
| 13 | data[].paymentChannel | String | āļāđāļāļāļāļēāļāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ |
| 14 | data[].routeNo | Number | āđāļŠāđāļāļāļēāļāļāļģāļĢāļ°āđāļāļīāļ |
| 15 | data[].amount | String | āļāđāļēāļŠāļīāļāļāđāļēāļŦāļĢāļ·āļāļāļĢāļīāļāļēāļĢ [#,##0.00] |
| 16 | data[].fee | String | āļāđāļēāļāļĢāļĢāļĄāđāļāļĩāļĒāļĄ [#,##0.00] |
| 17 | data[].totalAmount | String | āļĢāļēāļāļēāļĢāļ§āļĄ [#,##0.00] |
| 18 | data[].currency | String | āļŠāļāļļāļĨāđāļāļīāļ |
| 19 | data[].exchangeRate | String | āļāļąāļāļĢāļēāđāļĨāļāđāļāļĨāļĩāđāļĒāļ [#,##0.00] |
| 20 | data[].discount | String | āļŠāđāļ§āļāļĨāļ [#,##0.00] |
| 21 | data[].netAmount | String | āļĢāļēāļāļēāļŠāļļāļāļāļī [#,##0.00] |
| 22 | data[].serviceAmount | String | āļāđāļēāļāļĢāļīāļāļēāļĢ [#,##0.00] |
| 23 | data[].serviceVAT | String | āļ āļēāļĐāļĩāļāđāļēāļāļĢāļīāļāļēāļĢ [#,##0.00] |
| 24 | data[].serviceWHT | String | āļ āļēāļĐāļĩāļŦāļąāļ āļ āļāļĩāđāļāđāļēāļĒ [#,##0.00] |
| 25 | data[].settleAmount | String | āļĒāļāļāđāļāļīāļāđāļāļāđāļŦāđāļĢāđāļēāļāļāđāļē [#,##0.00] |
| 26 | data[].settled | Boolean | āļŠāļāļēāļāļ°āļāļēāļĢāđāļāļāđāļāļīāļāđāļŦāđāļĢāđāļēāļāļāđāļē [True, False] |
āļāļąāļ§āļāļĒāđāļēāļ āļāđāļāļĄāļđāļĨ JSON Response Message āļāļĩāđāđāļāđāļĢāļąāļāļāļēāļāļāļēāļĢāđāļĢāļĩāļĒāļ API
{
"totalRecord": 106,
"pageSize": 10,
"pageNumber": 1,
"filteredRecord": 10,
"status": 200,
"message": "Success",
"data": [
{
"transactionId": 114705,
"transactionDate": "17/01/2022 15:00:46",
"paymentDate": "17/01/2022 15:01:44",
"merchant": "Bank Industries",
"customer": "cus100005",
"orderNo": "order20211216101345",
"paymentChannel": "Credit Card",
"routeNo": 3,
"amount": "3,500.00",
"fee": "15.00",
"totalAmount": "3,515.00",
"currency": "THB",
"exchangeRate": "1.00",
"discount": "0.00",
"netAmount": "3,515.00",
"serviceAmount": "113.75",
"serviceVAT": "7.96",
"serviceWHT": "3.41",
"settleAmount": "3,381.70",
"settled": false
},
...
]
}
Search Void Transaction
| Service Name: | Search Void Transaction |
| URL: | [SANDBOX] https://sandbox-api-transaction.chillpay.co/api/v1/void/search |
| [PROD] https://api-transaction.chillpay.co/api/v1/void/search | |
| Method: | POST |
| Description: | āđāļāđāļāđāļāļāļĢāđāļ§āļīāļŠāđāļāļāļēāļĢāļāđāļāļŦāļēāļĢāļēāļĒāļāļēāļĢāļĒāļāđāļĨāļīāļ (Void Transactions) – āļĢāđāļēāļāļāđāļēāļŦāļĨāļąāļāļŠāļēāļĄāļēāļĢāļāļāđāļāļŦāļēāļāđāļāļĄāļđāļĨāļāļāļāļĢāđāļēāļāļāđāļēāļĒāđāļāļĒāđāļāđ – āļĢāđāļēāļāļāđāļēāļĒāđāļāļĒāļŠāļēāļĄāļēāļĢāļāļāđāļāļŦāļēāđāļāđāđāļāļāļēāļ°āļĢāđāļēāļāļāđāļēāļāļāđāļāļāđāļāđāļēāļāļąāđāļ |
āļāļēāļĢāļēāļāļāļĩāđ 3.1 Request Header Parameters
| No. | Parameters Name | Data Type | Length | Mandatory / Optional | Description |
|---|---|---|---|---|---|
| 1 | Content-Type | String | 16 | M | application/json |
| 2 | CHILLPAY-MerchantCode | String | 15 | M | āļĢāļŦāļąāļŠāļĢāđāļēāļāļāđāļēāļāļĩāđāļāļāļāđāļŦāđāđāļāļĒāļāļīāļ§āđāļāļĒāđ |
| 3 | CHILLPAY-ApiKey | String | 100 | M | āļĢāļŦāļąāļŠāļāđāļēāļāļāļīāļāļāļĩāđāļāļāļāđāļŦāđāđāļāļĒāļāļīāļ§āđāļāļĒāđ āđāļāđāđāļāļāļēāļĢāđāļāļ·āđāļāļĄāļāđāļāļĢāļ°āļāļ |
āļāļēāļĢāļēāļāļāļĩāđ 3.2 Request Body Parameters
| No. | Parameters Name | Data Type | Length | Mandatory / Optional | Description |
|---|---|---|---|---|---|
| 1 | OrderBy | String | 20 | O | āđāļĢāļĩāļĒāļāļāļēāļĄāļāļāļĨāļąāļĄāļāđ- TransactionId- TransactionDate- Merchant- Customer- OrderNo- PaymentChannel- PaymentDate- Amount- Fee- TotalAmount- RouteNo- Status* āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ TransactionId |
| 2 | OrderDir | String | 4 | O | āļāļēāļĢāđāļĢāļĩāļĒāļāļĨāļģāļāļąāļASC : āđāļĢāļĩāļĒāļāļāļēāļāļāđāļāļĒāđāļāļĄāļēāļ DESC : āđāļĢāļĩāļĒāļāļāļēāļāļĄāļēāļāđāļāļāđāļāļĒ * āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ DESC |
| 3 | PageSize | Number | O | āļāļģāļāļ§āļāļĢāļēāļĒāļāļēāļĢāļāđāļāļŦāļāđāļē (1-100) * āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ 10 | |
| 4 | PageNumber | Number | O | āđāļĨāļāļŦāļāđāļē * āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ 1 | |
| 5 | SearchKeyword | String | 255 | O | āļāļģāļŦāļĢāļ·āļāļāđāļāļāļ§āļēāļĄāļāļĩāđāļāđāļāļāļāļēāļĢāļāđāļāļŦāļē |
| 6 | MerchantCode | String | 15 | O | āļĢāļŦāļąāļŠāļĢāđāļēāļāļāđāļēāļāļĩāđāļāđāļāļāļāļēāļĢāļāđāļāļŦāļē |
| 7 | OrderNo | String | 20 | O | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļĢāđāļēāļāļāđāļē |
| 8 | Status | String | 20 | O | āļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ āļ āļēāļāļāļāļ§āļ āļ. |
| 9 | TransactionDateFrom | String | 19 | O | āļ§āļąāļāļāļĩāđāļāļģāļĢāļēāļĒāļāļēāļĢ (āļāļēāļ) [dd/MM/yyyy HH:mm:ss] |
| 10 | TransactionDateTo | String | 19 | O | āļ§āļąāļāļāļĩāđāļāļģāļĢāļēāļĒāļāļēāļĢ (āļāļķāļ) [dd/MM/yyyy HH:mm:ss] |
| 11 | Checksum | String | 32 | M | āļāļĨāļĨāļąāļāļāđāļāļĩāđāđāļāđāļāļēāļāļāļēāļĢāļāļģāļāđāļēāļāļąāđāļāļŦāļĄāļāđāļāđāļāđāļēāļĢāļŦāļąāļŠ |
āļāļąāļ§āļāļĒāđāļēāļ āļāļēāļĢāđāļĢāļĩāļĒāļ Request Search Void Transaction (Code āļ āļēāļĐāļē C# .NET)
var client = new RestClient("https://api-transaction.chillpay.co/api/v1/void/search");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("CHILLPAY-MerchantCode", "xxx");
request.AddHeader("CHILLPAY-ApiKey", "xxx");
request.AddHeader("Content-Type", "application/json");
var body = @"{""OrderBy"": ""TransactionId"", ""OrderDir"": ""DESC"", ""PageSize"": null, ""PageNumber"": null, ""SearchKeyword"": null, ""MerchantCode"": null, ""OrderNo"": null, ""Status"": null, ""TransactionDateFrom"": null, ""TransactionDateTo"": null, ""Checksum"": ""380eb9dff5f97b1c705030ee922959e6""}";
request.AddParameter("application/json", body, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
āļŦāļĄāļēāļĒāđāļŦāļāļļ
- āļāđāļē Checksum āđāļāđāļāļāļēāļĢāļāļģāļāđāļēāļāļēāļ Parameter āļāļēāļĄāļāļēāļĢāļēāļāļāļĩāđ 3.2 (āļāđāļ 1-10) āļĄāļēāđāļĢāļĩāļĒāļāļāđāļāļāļąāļ āđāļĨāđāļ§āļāđāļāļāđāļēāļĒāļāđāļ§āļĒ MD5 Secret Key (āļāļĩāđāđāļāđāļĢāļąāļāļāļēāļāļāļēāļāļāļīāļ§āđāļāļĒāđ) āļāļąāļāļāļĩāđ
- OrderBy + OrderDir + PageSize + PageNumber + SearchKeyword + MerchantCode + OrderNo + Status + TransactionDateFrom + TransactionDateTo + MD5 Secret Key
- āļāļēāļāļāļąāđāļāļāļģāļāđāļāļĄāļđāļĨāļāļĩāđāđāļĢāļĩāļĒāļāļāļąāļāļāļąāđāļāļŦāļĄāļāļāļĩāđāđāļāđāļāđāļēāļĢāļŦāļąāļŠāļāđāļ§āļĒāļāļąāļāļāđāļāļąāđāļ MD5 Hashing āļāļķāļāļāļ°āđāļāđāđāļāđāļāļāđāļē Checksum
- āļāļąāļ§āļāļĒāđāļēāļ āļāļēāļĢāļāļģāļāđāļāļĄāļđāļĨāļĄāļēāđāļĢāļĩāļĒāļāļāđāļāļāļąāļāđāļāļ·āđāļāđāļāđāļēāļāļąāļāļāđāļāļąāđāļ MD5
- TransactionIdDESCAAABBBCCCDDD
āļāļēāļĢāļēāļāļāļĩāđ 3.3 Response Message Parameters
| No. | Parameters Name | Data Type | Description |
|---|---|---|---|
| 1 | totalRecord | Number | āļāļģāļāļ§āļāļĢāļēāļĒāļāļēāļĢāļāļąāđāļāļŦāļĄāļ |
| 2 | pageSize | Number | āļāļģāļāļ§āļāļĢāļēāļĒāļāļēāļĢāļāđāļāļŦāļāđāļē |
| 3 | pageNumber | Number | āđāļĨāļāļŦāļāđāļē |
| 4 | filteredRecord | Number | āļāļģāļāļ§āļāļĢāļēāļĒāļāļēāļĢāđāļāļŦāļāđāļēāļāļąāļāļāļļāļāļąāļ |
| 5 | status | String | āļĢāļŦāļąāļŠāļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļēāļĒāļāļēāļĢ āļ āļēāļāļāļāļ§āļ āļ. |
| 6 | message | String | āļāļģāļāļāļīāļāļēāļĒāļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļēāļĒāļāļēāļĢ |
| 7 | data[].transactionId | Number | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļāļīāļ§āđāļāļĒāđ |
| 8 | data[].transactionDate | String | āļ§āļąāļāļāļĩāđāļāļģāļĢāļēāļĒāļāļēāļĢ [dd/MM/yyyy HH:mm:ss] |
| 9 | data[].merchant | String | āļāļ·āđāļāļĢāđāļēāļāļāđāļē |
| 10 | data[].customer | String | āļĢāļŦāļąāļŠāļāđāļēāļāļāļīāļāļŦāļĢāļ·āļāļāļ·āđāļāļĨāļđāļāļāđāļē |
| 11 | data[].orderNo | String | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļĢāđāļēāļāļāđāļē |
| 12 | data[].paymentChannel | String | āļāđāļāļāļāļēāļāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ |
| 13 | data[].paymentDate | String | āļ§āļąāļāļāļĩāđāļāļģāļĢāļ°āđāļāļīāļ [dd/MM/yyyy HH:mm:ss] |
| 14 | data[].amount | String | āļāđāļēāļŠāļīāļāļāđāļēāļŦāļĢāļ·āļāļāļĢāļīāļāļēāļĢ [#,##0.00] |
| 15 | data[].fee | String | āļāđāļēāļāļĢāļĢāļĄāđāļāļĩāļĒāļĄ [#,##0.00] |
| 16 | data[].totalAmount | String | āļĢāļēāļāļēāļĢāļ§āļĄ [#,##0.00] |
| 17 | data[].currency | String | āļŠāļāļļāļĨāđāļāļīāļ |
| 18 | data[].routeNo | Number | āđāļŠāđāļāļāļēāļāļāļģāļĢāļ°āđāļāļīāļ |
| 19 | data[].serviceFee | String | āļāđāļēāļāļĢāļīāļāļēāļĢ [#,##0.00] |
| 20 | data[].status | String | āļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ |
āļāļąāļ§āļāļĒāđāļēāļ āļāđāļāļĄāļđāļĨ JSON Response Message āļāļĩāđāđāļāđāļĢāļąāļāļāļēāļāļāļēāļĢāđāļĢāļĩāļĒāļ API
{
"totalRecord": 1,
"pageSize": 10,
"pageNumber": 1,
"filteredRecord": 1,
"status": 200,
"message": "Success",
"data": [
{
"transactionId": 115006,
"transactionDate": "03/02/2022 11:50:39",
"merchant": "Bank Industries",
"customer": "cus100005",
"orderNo": "order20211216101345",
"paymentChannel": "Credit Card",
"paymentDate": "04/03/2022 16:10:31",
"amount": "3,500.00",
"fee": "15.00",
"totalAmount": "3,515.00",
"currency": "THB",
"routeNo": 3,
"serviceFee": "0.00",
"status": "Void Requested"
}
]
}
Search Refund Transaction
| Service Name: | Search Refund Transaction |
| URL: | [SANDBOX] https://sandbox-api-transaction.chillpay.co/api/v1/refund/search |
| [PROD] https://api-transaction.chillpay.co/api/v1/refund/search | |
| Method: | POST |
| Description: | āđāļāđāļāđāļāļāļĢāđāļ§āļīāļŠāđāļāļāļēāļĢāļāđāļāļŦāļēāļĢāļēāļĒāļāļēāļĢāļāļāļāļ·āļāđāļāļīāļ (Refund Transactions)- āļĢāđāļēāļāļāđāļēāļŦāļĨāļąāļāļŠāļēāļĄāļēāļĢāļāļāđāļāļŦāļēāļāđāļāļĄāļđāļĨāļāļāļāļĢāđāļēāļāļāđāļēāļĒāđāļāļĒāđāļāđ- āļĢāđāļēāļāļāđāļēāļĒāđāļāļĒāļŠāļēāļĄāļēāļĢāļāļāđāļāļŦāļēāđāļāđāđāļāļāļēāļ°āļĢāđāļēāļāļāđāļēāļāļāđāļāļāđāļāđāļēāļāļąāđāļ |
āļāļēāļĢāļēāļāļāļĩāđ 4.1 Request Header Parameters
| No. | Parameters Name | Data Type | Length | Mandatory / Optional | Description |
|---|---|---|---|---|---|
| 1 | Content-Type | String | 16 | M | application/json |
| 2 | CHILLPAY-MerchantCode | String | 15 | M | āļĢāļŦāļąāļŠāļĢāđāļēāļāļāđāļēāļāļĩāđāļāļāļāđāļŦāđāđāļāļĒāļāļīāļ§āđāļāļĒāđ |
| 3 | CHILLPAY-ApiKey | String | 100 | M | āļĢāļŦāļąāļŠāļāđāļēāļāļāļīāļāļāļĩāđāļāļāļāđāļŦāđāđāļāļĒāļāļīāļ§āđāļāļĒāđ āđāļāđāđāļāļāļēāļĢāđāļāļ·āđāļāļĄāļāđāļāļĢāļ°āļāļ |
āļāļēāļĢāļēāļāļāļĩāđ 4.2 Request Body Parameters
| No. | Parameters Name | Data Type | Data Type | Mandatory / Optional | Description |
|---|---|---|---|---|---|
| 1 | OrderBy | String | 20 | O | āđāļĢāļĩāļĒāļāļāļēāļĄāļāļāļĨāļąāļĄāļāđ- TransactionId- TransactionDate- Merchant- Customer- OrderNo- PaymentChannel- PaymentDate- Amount- Fee- TotalAmount- RouteNo- Status* āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ TransactionId |
| 2 | OrderDir | String | 4 | O | āļāļēāļĢāđāļĢāļĩāļĒāļāļĨāļģāļāļąāļASC : āđāļĢāļĩāļĒāļāļāļēāļāļāđāļāļĒāđāļāļĄāļēāļDESC : āđāļĢāļĩāļĒāļāļāļēāļāļĄāļēāļāđāļāļāđāļāļĒ* āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ DESC |
| 3 | PageSize | Number | O | āļāļģāļāļ§āļāļĢāļēāļĒāļāļēāļĢāļāđāļāļŦāļāđāļē (1-100)* āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ 10 | |
| 4 | PageNumber | Number | O | āđāļĨāļāļŦāļāđāļē* āļŦāļēāļāđāļĄāđāđāļāđāļŠāđāļāļĄāļēāļāđāļēāđāļĢāļīāđāļĄāļāđāļāļāļ·āļ 1 | |
| 5 | SearchKeyword | String | 255 | O | āļāļģāļŦāļĢāļ·āļāļāđāļāļāļ§āļēāļĄāļāļĩāđāļāđāļāļāļāļēāļĢāļāđāļāļŦāļē |
| 6 | MerchantCode | String | 15 | O | āļĢāļŦāļąāļŠāļĢāđāļēāļāļāđāļēāļāļĩāđāļāđāļāļāļāļēāļĢāļāđāļāļŦāļē |
| 7 | OrderNo | String | 20 | O | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļĢāđāļēāļāļāđāļē |
| 8 | Status | String | 20 | O | āļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ āļ āļēāļāļāļāļ§āļ āļ. |
| 9 | TransactionDateFrom | String | 19 | O | āļ§āļąāļāļāļĩāđāļāļģāļĢāļēāļĒāļāļēāļĢ (āļāļēāļ) [dd/MM/yyyy HH:mm:ss] |
| 10 | TransactionDateTo | String | 19 | O | āļ§āļąāļāļāļĩāđāļāļģāļĢāļēāļĒāļāļēāļĢ (āļāļķāļ) [dd/MM/yyyy HH:mm:ss] |
| 11 | Checksum | String | 32 | M | āļāļĨāļĨāļąāļāļāđāļāļĩāđāđāļāđāļāļēāļāļāļēāļĢāļāļģāļāđāļēāļāļąāđāļāļŦāļĄāļāđāļāđāļāđāļēāļĢāļŦāļąāļŠ |
āļāļąāļ§āļāļĒāđāļēāļ āļāļēāļĢāđāļĢāļĩāļĒāļ Request Search Refund Transaction (Code āļ āļēāļĐāļē C# .NET)
var client = new RestClient("https://api-transaction.chillpay.co/api/v1/refund/search");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("CHILLPAY-MerchantCode", "xxx");
request.AddHeader("CHILLPAY-ApiKey", "xxx");
request.AddHeader("Content-Type", "application/json");
var body = @"{""OrderBy"": ""TransactionId"", ""OrderDir"": ""DESC"", ""PageSize"": null, ""PageNumber"": null, ""SearchKeyword"": null, ""MerchantCode"": null, ""OrderNo"": null, ""Status"": null, ""TransactionDateFrom"": null, ""TransactionDateTo"": null, ""Checksum"": ""3ca662ef331497e7cce6b00dc3f783c1""}";
request.AddParameter("application/json", body, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
āļŦāļĄāļēāļĒāđāļŦāļāļļ
- āļāđāļē Checksum āđāļāđāļāļāļēāļĢāļāļģāļāđāļēāļāļēāļ Parameter āļāđāļēāļ āđ āļāļēāļĄāļāļēāļĢāļēāļāļāļĩāđ 4.2 (āļāđāļ 1 â10) āļĄāļēāđāļĢāļĩāļĒāļāļāđāļāļāļąāļ āđāļĨāđāļ§āļāđāļāļāđāļēāļĒāļāđāļ§āļĒ MD5 Secret Key (āļāļĩāđāđāļāđāļĢāļąāļāļāļēāļāļāļēāļāļāļīāļ§āđāļāļĒāđ) āļāļąāļāļāļĩāđ
- OrderBy + OrderDir + PageSize + PageNumber + SearchKeyword + MerchantCode + OrderNo + Status + TransactionDateFrom + TransactionDateTo + MD5 Secret Key
- āļāļēāļāļāļąāđāļāļāļģāļāđāļāļĄāļđāļĨāļāļĩāđāđāļĢāļĩāļĒāļāļāļąāļāļāļąāđāļāļŦāļĄāļāļāļĩāđāđāļāđāļāđāļēāļĢāļŦāļąāļŠāļāđāļ§āļĒāļāļąāļāļāđāļāļąāđāļ MD5 Hashing āļāļķāļāļāļ°āđāļāđāđāļāđāļāļāđāļē Checksum
- āļāļąāļ§āļāļĒāđāļēāļ āļāļēāļĢāļāļģāļāđāļāļĄāļđāļĨāļĄāļēāđāļĢāļĩāļĒāļāļāđāļāļāļąāļāđāļāļ·āđāļāđāļāđāļēāļāļąāļāļāđāļāļąāđāļ MD5
- TransactionIdDESCAAABBBCCCDDD
āļāļēāļĢāļēāļāļāļĩāđ 4.3 Response Message Parameters
| No. | Parameters Name | Data Type | Description |
|---|---|---|---|
| 1 | totalRecord | Number | āļāļģāļāļ§āļāļĢāļēāļĒāļāļēāļĢāļāļąāđāļāļŦāļĄāļ |
| 2 | pageSize | Number | āļāļģāļāļ§āļāļĢāļēāļĒāļāļēāļĢāļāđāļāļŦāļāđāļē |
| 3 | pageNumber | Number | āđāļĨāļāļŦāļāđāļē |
| 4 | filteredRecord | Number | āļāļģāļāļ§āļāļĢāļēāļĒāļāļēāļĢāđāļāļŦāļāđāļēāļāļąāļāļāļļāļāļąāļ |
| 5 | status | String | āļĢāļŦāļąāļŠāļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļēāļĒāļāļēāļĢ āļ āļēāļāļāļāļ§āļ āļ. |
| 6 | message | String | āļāļģāļāļāļīāļāļēāļĒāļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļēāļĒāļāļēāļĢ |
| 7 | data[].transactionId | Number | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļāļīāļ§āđāļāļĒāđ |
| 8 | data[].transactionDate | String | āļ§āļąāļāļāļĩāđāļāļģāļĢāļēāļĒāļāļēāļĢ [dd/MM/yyyy HH:mm:ss] |
| 9 | data[].merchant | String | āļāļ·āđāļāļĢāđāļēāļāļāđāļē |
| 10 | data[].customer | String | āļĢāļŦāļąāļŠāļāđāļēāļāļāļīāļāļŦāļĢāļ·āļāļāļ·āđāļāļĨāļđāļāļāđāļē |
| 11 | data[].orderNo | String | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļĢāđāļēāļāļāđāļē |
| 12 | data[].paymentChannel | String | āļāđāļāļāļāļēāļāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ |
| 13 | data[].paymentDate | String | āļ§āļąāļāļāļĩāđāļāļģāļĢāļ°āđāļāļīāļ [dd/MM/yyyy HH:mm:ss] |
| 14 | data[].amount | String | āļāđāļēāļŠāļīāļāļāđāļēāļŦāļĢāļ·āļāļāļĢāļīāļāļēāļĢ [#,##0.00] |
| 15 | data[].fee | String | āļāđāļēāļāļĢāļĢāļĄāđāļāļĩāļĒāļĄ [#,##0.00] |
| 16 | data[].totalAmount | String | āļĢāļēāļāļēāļĢāļ§āļĄ [#,##0.00] |
| 17 | data[].currency | String | āļŠāļāļļāļĨāđāļāļīāļ |
| 18 | data[].routeNo | Number | āđāļŠāđāļāļāļēāļāļāļģāļĢāļ°āđāļāļīāļ |
| 19 | data[].serviceFee | String | āļāđāļēāļāļĢāļīāļāļēāļĢ [#,##0.00] |
| 20 | data[].status | String | āļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ |
āļāļąāļ§āļāļĒāđāļēāļ āļāđāļāļĄāļđāļĨ JSON Response Message āļāļĩāđāđāļāđāļĢāļąāļāļāļēāļāļāļēāļĢāđāļĢāļĩāļĒāļ API
{
"totalRecord": 6,
"pageSize": 10,
"pageNumber": 1,
"filteredRecord": 6,
"status": 200,
"message": "Success",
"data": [
{
"transactionId": 41613,
"transactionDate": "24/09/2020 19:58:01",
"merchant": "Bank Industries",
"customer": "TEST",
"orderNo": "21",
"paymentChannel": "Credit Card",
"paymentDate": "24/09/2020 19:58:55",
"amount": "20,000.00",
"fee": "650.00",
"totalAmount": "20,650.00",
"currency": "THB",
"routeNo": 1,
"serviceFee": "650.00",
"status": "Refund Requested"
},
...
]
}
Get Payment Transaction Details
| Service Name: | Get Payment Transaction Details |
| URL: | [SANDBOX] https://sandbox-api-transaction.chillpay.co/api/v1/payment/details |
| [PROD] https://api-transaction.chillpay.co/api/v1/payment/details | |
| Method: | POST |
| Description: | āđāļāđāļāđāļāļāļĢāđāļ§āļīāļŠāđāļāļāļēāļĢāđāļĢāļĩāļĒāļāļāļđāļĢāļēāļĒāļĨāļ°āđāļāļĩāļĒāļāļĢāļēāļĒāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ (Payment Transaction) – āļĢāđāļēāļāļāđāļēāļŦāļĨāļąāļāļŠāļēāļĄāļēāļĢāļāļāļđāļāđāļāļĄāļđāļĨāļāļāļāļĢāđāļēāļāļāđāļēāļĒāđāļāļĒāđāļāđ – āļĢāđāļēāļāļāđāļēāļĒāđāļāļĒāļŠāļēāļĄāļēāļĢāļāļāđāļāļŦāļēāđāļāđāđāļāļāļēāļ°āļĢāđāļēāļāļāđāļēāļāļāđāļāļāđāļāđāļēāļāļąāđāļ |
āļāļēāļĢāļēāļāļāļĩāđ 5.1 Request Header Parameters
| No. | Parameters Name | Data Type | Length | Mandatory / Optional | Description |
|---|---|---|---|---|---|
| 1 | Content-Type | String | 16 | M | application/json |
| 2 | CHILLPAY-MerchantCode | String | 15 | M | āļĢāļŦāļąāļŠāļĢāđāļēāļāļāđāļēāļāļĩāđāļāļāļāđāļŦāđāđāļāļĒāļāļīāļ§āđāļāļĒāđ |
| 3 | CHILLPAY-ApiKey | String | 100 | M | āļĢāļŦāļąāļŠāļāđāļēāļāļāļīāļāļāļĩāđāļāļāļāđāļŦāđāđāļāļĒāļāļīāļ§āđāļāļĒāđ āđāļāđāđāļāļāļēāļĢāđāļāļ·āđāļāļĄāļāđāļāļĢāļ°āļāļ |
āļāļēāļĢāļēāļāļāļĩāđ 5.2 Request Body Parameters
| No. | Parameters Name | Data Type | Length | Mandatory / Optional | Description |
|---|---|---|---|---|---|
| 1 | TransactionId | Number | M | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļāļīāļ§āđāļāļĒāđ | |
| 2 | Checksum | String | 32 | M | āļāļĨāļĨāļąāļāļāđāļāļĩāđāđāļāđāļāļēāļāļāļēāļĢāļāļģāļāđāļēāļāļąāđāļāļŦāļĄāļāđāļāđāļāđāļēāļĢāļŦāļąāļŠ |
āļāļąāļ§āļāļĒāđāļēāļ āļāļēāļĢāđāļĢāļĩāļĒāļ Request Get Payment Transaction Details (Code āļ āļēāļĐāļē C# .NET)
var client = new RestClient("https://api-transaction.chillpay.co/api/v1/payment/details");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("CHILLPAY-MerchantCode", "xxx");
request.AddHeader("CHILLPAY-ApiKey", "xxx");
request.AddHeader("Content-Type", "application/json");
var body = @"{""TransactionId"": 115006, ""Checksum"": ""75db12ab69411c40e74ff40ae09fcca8""}";
request.AddParameter("application/json", body, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
āļŦāļĄāļēāļĒāđāļŦāļāļļ
- āļāđāļē Checksum āđāļāđāļāļāļēāļĢāļāļģāļāđāļēāļāļēāļ Parameter āļāļēāļĄāļāļēāļĢāļēāļāļāļĩāđ 5.2 (āļāđāļ 1) āļĄāļēāļāđāļāļāđāļēāļĒāļāđāļ§āļĒ MD5 Secret Key (āļāļĩāđāđāļāđāļĢāļąāļāļāļēāļāļāļēāļāļāļīāļ§āđāļāļĒāđ) āļāļąāļāļāļĩāđ
- TransactionId + MD5 Secret Key
- āļāļēāļāļāļąāđāļāļāļģāļāđāļāļĄāļđāļĨāļāļĩāđāđāļĢāļĩāļĒāļāļāļąāļāļāļąāđāļāļŦāļĄāļāļāļĩāđāđāļāđāļāđāļēāļĢāļŦāļąāļŠāļāđāļ§āļĒāļāļąāļāļāđāļāļąāđāļ MD5 Hashing āļāļķāļāļāļ°āđāļāđāđāļāđāļāļāđāļē Checksum
- āļāļąāļ§āļāļĒāđāļēāļ āļāļēāļĢāļāļģāļāđāļāļĄāļđāļĨāļĄāļēāđāļĢāļĩāļĒāļāļāđāļāļāļąāļāđāļāļ·āđāļāđāļāđāļēāļāļąāļāļāđāļāļąāđāļ MD5
- 115006AAABBBCCCDDD
āļāļēāļĢāļēāļāļāļĩāđ 5.3 Response Message Parameters
| No. | Parameters Name | Data Type | Description |
|---|---|---|---|
| 1 | status | String | āļĢāļŦāļąāļŠāļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļēāļĒāļāļēāļĢ āļ āļēāļāļāļāļ§āļ āļ. |
| 2 | message | String | āļāļģāļāļāļīāļāļēāļĒāļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļēāļĒāļāļēāļĢ |
| 3 | data[].transactionId | Number | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļāļīāļ§āđāļāļĒāđ |
| 4 | data[].merchant | String | āļāļ·āđāļāļĢāđāļēāļāļāđāļē |
| 5 | data[].paymentChannel | String | āļāđāļāļāļāļēāļāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ |
| 6 | data[].amount | String | āļāđāļēāļŠāļīāļāļāđāļēāļŦāļĢāļ·āļāļāļĢāļīāļāļēāļĢ [#,##0.00] |
| 7 | data[].fee | String | āļāđāļēāļāļĢāļĢāļĄāđāļāļĩāļĒāļĄ [#,##0.00] |
| 8 | data[].discount | String | āļŠāđāļ§āļāļĨāļ [#,##0.00] |
| 9 | data[].totalAmount | String | āļĢāļēāļāļēāļĢāļ§āļĄ [#,##0.00] |
| 10 | data[].orderNo | String | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļĢāđāļēāļāļāđāļē |
| 11 | data[].customer | String | āļĢāļŦāļąāļŠāļāđāļēāļāļāļīāļāļŦāļĢāļ·āļāļāļ·āđāļāļĨāļđāļāļāđāļē |
| 12 | data[].phoneNumber | String | āđāļāļāļĢāđāđāļāļĢāļĻāļąāļāļāđāļĄāļ·āļāļāļ·āļāļāļāļāļĨāļđāļāļāđāļē |
| 13 | data[].languageCode | String | āļĢāļŦāļąāļŠāļ āļēāļĐāļē |
| 14 | data[].status | String | āļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ |
| 15 | data[].currency | String | āļŠāļāļļāļĨāđāļāļīāļ |
| 16 | data[].ipAddress | String | āļāđāļāļĄāļđāļĨāđāļāļāļĩāļāļāļāļĨāļđāļāļāđāļē |
| 17 | data[].merchantResponseCode | String | āļĢāļŦāļąāļŠāļāļāļāļāļĨāļąāļāļāļēāļāļāļēāļāļĢāđāļēāļāļāđāļē |
| 18 | data[].merchantResponseMessage | String | āļāđāļāļāļ§āļēāļĄāļāļāļāļāļĨāļąāļāļāļēāļāļāļēāļāļĢāđāļēāļāļāđāļē |
| 19 | data[].paymentDate | String | āļ§āļąāļāļāļĩāđāļāļģāļĢāļ°āđāļāļīāļ [dd/MM/yyyy HH:mm:ss] |
| 20 | data[].transactionDate | String | āļ§āļąāļāļāļĩāđāļāļģāļĢāļēāļĒāļāļēāļĢ [dd/MM/yyyy HH:mm:ss] |
| 21 | data[].description | String | āļĢāļēāļĒāļĨāļ°āđāļāļĩāļĒāļāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ |
| 22 | data[].settled | Boolean | āļŠāļāļēāļāļ°āļāļēāļĢāđāļāļāđāļāļīāļāđāļŦāđāļĢāđāļēāļāļāđāļē [True, False] |
āļāļąāļ§āļāļĒāđāļēāļ āļāđāļāļĄāļđāļĨ JSON Response Message āļāļĩāđāđāļāđāļĢāļąāļāļāļēāļāļāļēāļĢāđāļĢāļĩāļĒāļ API
{
"status": 200,
"message": "Success",
"data": {
"transactionId": 115006,
"merchant": "Bank Industries",
"paymentChannel": "Credit Card",
"amount": "3,500.00",
"fee": "15.00",
"discount": "0.00",
"totalAmount": "3,515.00",
"orderNo": "order20211216101345",
"customer": "cus100005",
"phoneNumber": "0822318917",
"languageCode": "TH",
"status": "Void Requested",
"currency": "THB",
"ipAddress": "171.103.196.214",
"merchantResponseCode": "200",
"merchantResponseMessage": "Send data to merchant completed",
"paymentDate": "04/03/2022 16:10:31",
"transactionDate": "03/02/2022 11:50:39",
"description": " ",
"settled": false
}
}
Request Void Transaction
| Service Name: | Request Void Transaction |
| URL: | [SANDBOX] https://sandbox-api-transaction.chillpay.co/api/v1/void/request |
| [PROD] https://api-transaction.chillpay.co/api/v1/void/request | |
| Method: | POST |
| Description: | āđāļāđāļāđāļāļāļĢāđāļ§āļīāļŠāļŠāļģāļŦāļĢāļąāļāļĢāđāļāļāļāļāļĒāļāđāļĨāļīāļāļĢāļēāļĒāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ āļāļĢāļāļĩāļāļĩāđāļĢāļēāļĒāļāļēāļĢāļāļąāđāļāļĒāļąāļāđāļĄāđ Settled – āļĢāđāļēāļāļāđāļēāļŦāļĨāļąāļāļŠāļēāļĄāļēāļĢāļāļĢāđāļāļāļāļāļĒāļāđāļĨāļīāļāļĢāļēāļĒāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļāļāļāļāļĢāđāļēāļāļāđāļēāļĒāđāļāļĒāđāļāđ – āļĢāđāļēāļāļāđāļēāļĒāđāļāļĒāļŠāļēāļĄāļēāļĢāļāļĢāđāļāļāļāļāļĒāļāđāļĨāļīāļāļĢāļēāļĒāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļāđāļāđāđāļāļāļēāļ°āļĢāđāļēāļāļāđāļēāļāļāđāļāļāđāļāđāļēāļāļąāđāļ |
āļāļēāļĢāļēāļāļāļĩāđ 6.1 Request Header Parameters
| No. | Parameters Name | Data Type | Length | Mandatory / Optional | Description |
|---|---|---|---|---|---|
| 1 | Content-Type | String | 16 | M | application/json |
| 2 | CHILLPAY-MerchantCode | String | 15 | M | āļĢāļŦāļąāļŠāļĢāđāļēāļāļāđāļēāļāļĩāđāļāļāļāđāļŦāđāđāļāļĒāļāļīāļ§āđāļāļĒāđ |
| 3 | CHILLPAY-ApiKey | String | 100 | M | āļĢāļŦāļąāļŠāļāđāļēāļāļāļīāļāļāļĩāđāļāļāļāđāļŦāđāđāļāļĒāļāļīāļ§āđāļāļĒāđ āđāļāđāđāļāļāļēāļĢāđāļāļ·āđāļāļĄāļāđāļāļĢāļ°āļāļ |
āļāļēāļĢāļēāļāļāļĩāđ 6.2 Request Body Parameters
| No. | Parameters Name | Data Type | Length | Mandatory / Optional | Description |
|---|---|---|---|---|---|
| 1 | TransactionId | Number | M | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļāļīāļ§āđāļāļĒāđ | |
| 2 | Checksum | String | 32 | M | āļāļĨāļĨāļąāļāļāđāļāļĩāđāđāļāđāļāļēāļāļāļēāļĢāļāļģāļāđāļēāļāļąāđāļāļŦāļĄāļāđāļāđāļāđāļēāļĢāļŦāļąāļŠ |
āļāļąāļ§āļāļĒāđāļēāļ āļāļēāļĢāđāļĢāļĩāļĒāļ Request Request Void Transaction (Code āļ āļēāļĐāļē C# .NET)
var client = new RestClient("https://api-transaction.chillpay.co/api/v1/void/request");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("CHILLPAY-MerchantCode", "xxx");
request.AddHeader("CHILLPAY-ApiKey", "xxx");
request.AddHeader("Content-Type", "application/json");
var body = @"{""TransactionId"": 115006, ""Checksum"": ""75db12ab69411c40e74ff40ae09fcca8""}";
request.AddParameter("application/json", body, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
āļŦāļĄāļēāļĒāđāļŦāļāļļ
- āļāđāļē Checksum āđāļāđāļāļāļēāļĢāļāļģāļāđāļēāļāļēāļ Parameter āļāđāļēāļ āđ āļāļēāļĄāļāļēāļĢāļēāļāļāļĩāđ 6.2 (āļāđāļ 1) āļĄāļēāđāļĢāļĩāļĒāļāļāđāļāļāļąāļ āđāļĨāđāļ§āļāđāļāļāđāļēāļĒāļāđāļ§āļĒ MD5 Secret Key (āļāļĩāđāđāļāđāļĢāļąāļāļāļēāļāļāļēāļāļāļīāļ§āđāļāļĒāđ) āļāļąāļāļāļĩāđ
- TransactionId + MD5 Secret Key
- āļāļēāļāļāļąāđāļāļāļģāļāđāļāļĄāļđāļĨāļāļĩāđāđāļĢāļĩāļĒāļāļāļąāļāļāļąāđāļāļŦāļĄāļāļāļĩāđāđāļāđāļāđāļēāļĢāļŦāļąāļŠāļāđāļ§āļĒāļāļąāļāļāđāļāļąāđāļ MD5 Hashing āļāļķāļāļāļ°āđāļāđāđāļāđāļāļāđāļē Checksum
- āļāļąāļ§āļāļĒāđāļēāļ āļāļēāļĢāļāļģāļāđāļāļĄāļđāļĨāļĄāļēāđāļĢāļĩāļĒāļāļāđāļāļāļąāļāđāļāļ·āđāļāđāļāđāļēāļāļąāļāļāđāļāļąāđāļ MD5
- 115006AAABBBCCCDDD
āļāļēāļĢāļēāļāļāļĩāđ 6.3 Response Message Parameters
| No. | Parameters Name | Data Type | Description |
|---|---|---|---|
| 1 | status | String | āļĢāļŦāļąāļŠāļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļēāļĒāļāļēāļĢ āļ āļēāļāļāļāļ§āļ āļ. |
| 2 | message | String | āļāļģāļāļāļīāļāļēāļĒāļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļēāļĒāļāļēāļĢ |
| 3 | data.transactionId | Number | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļāļīāļ§āđāļāļĒāđ |
| 4 | data.transactionDate | String | āļ§āļąāļāļāļĩāđāļāļģāļĢāļēāļĒāļāļēāļĢ [dd/MM/yyyy HH:mm:ss] |
| 5 | data.merchant | String | āļāļ·āđāļāļĢāđāļēāļāļāđāļē |
| 6 | data.customer | String | āļĢāļŦāļąāļŠāļāđāļēāļāļāļīāļāļŦāļĢāļ·āļāļāļ·āđāļāļĨāļđāļāļāđāļē |
| 7 | data.orderNo | String | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļĢāđāļēāļāļāđāļē |
| 8 | data.paymentChannel | String | āļāđāļāļāļāļēāļāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ |
| 9 | data.paymentDate | String | āļ§āļąāļāļāļĩāđāļāļģāļĢāļ°āđāļāļīāļ [dd/MM/yyyy HH:mm:ss] |
| 10 | data.amount | String | āļāđāļēāļŠāļīāļāļāđāļēāļŦāļĢāļ·āļāļāļĢāļīāļāļēāļĢ [#,##0.00] |
| 11 | data.fee | String | āļāđāļēāļāļĢāļĢāļĄāđāļāļĩāļĒāļĄ [#,##0.00] |
| 12 | data.totalAmount | String | āļĢāļēāļāļēāļĢāļ§āļĄ [#,##0.00] |
| 13 | data.currency | String | āļŠāļāļļāļĨāđāļāļīāļ |
| 14 | data.routeNo | Number | āđāļŠāđāļāļāļēāļāļāļģāļĢāļ°āđāļāļīāļ |
| 15 | data.serviceFee | String | āļāđāļēāļāļĢāļīāļāļēāļĢ [#,##0.00] |
| 16 | data.status | String | āļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ |
āļāļąāļ§āļāļĒāđāļēāļ āļāđāļāļĄāļđāļĨ JSON Response Message āļāļĩāđāđāļāđāļĢāļąāļāļāļēāļāļāļēāļĢāđāļĢāļĩāļĒāļ API
{
"status": 200,
"message": "Success",
"data": {
"transactionId": 115006,
"transactionDate": "03/02/2022 11:50:39",
"merchant": "Bank Industries",
"customer": "cus100005",
"orderNo": "order20211216101345",
"paymentChannel": "Credit Card",
"paymentDate": "10/03/2022 12:22:54",
"amount": "3,500.00",
"fee": "15.00",
"totalAmount": "3,515.00",
"currency": "THB",
"routeNo": 3,
"serviceFee": "0.00",
"status": "Void Requested"
}
}
Request Refund Transaction
| Service Name: | Request Refund Transaction |
| URL: | [SANDBOX] https://sandbox-api-transaction.chillpay.co/api/v1/refund/request |
| [PROD] https://api-transaction.chillpay.co/api/v1/refund/request | |
| Method: | POST |
| Description: | āđāļāđāļāđāļāļāļĢāđāļ§āļīāļŠāļŠāļģāļŦāļĢāļąāļāļĢāđāļāļāļāļāļāļēāļĢāļāļ·āļāđāļāļīāļ āļāļĢāļāļĩāļāļĩāđāļĢāļēāļĒāļāļēāļĢāļāļąāđāļāļāļđāļ Settled āđāļĨāđāļ§ – āļĢāđāļēāļāļāđāļēāļŦāļĨāļąāļāļŠāļēāļĄāļēāļĢāļāļĢāđāļāļāļāļāļĒāļāđāļĨāļīāļāļĢāļēāļĒāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļāļāļāļāļĢāđāļēāļāļāđāļēāļĒāđāļāļĒāđāļāđ – āļĢāđāļēāļāļāđāļēāļĒāđāļāļĒāļŠāļēāļĄāļēāļĢāļāļĢāđāļāļāļāļāļĒāļāđāļĨāļīāļāļĢāļēāļĒāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļāđāļāđāđāļāļāļēāļ°āļĢāđāļēāļāļāđāļēāļāļāđāļāļāđāļāđāļēāļāļąāđāļ |
āļāļēāļĢāļēāļāļāļĩāđ 7.1 Request Header Parameters
| No. | Parameters Name | Data Type | Length | Mandatory / Optional | Description |
|---|---|---|---|---|---|
| 1 | Content-Type | String | 16 | M | application/json |
| 2 | CHILLPAY-MerchantCode | String | 15 | M | āļĢāļŦāļąāļŠāļĢāđāļēāļāļāđāļēāļāļĩāđāļāļāļāđāļŦāđāđāļāļĒāļāļīāļ§āđāļāļĒāđ |
| 3 | CHILLPAY-ApiKey | String | 100 | M | āļĢāļŦāļąāļŠāļāđāļēāļāļāļīāļāļāļĩāđāļāļāļāđāļŦāđāđāļāļĒāļāļīāļ§āđāļāļĒāđ āđāļāđāđāļāļāļēāļĢāđāļāļ·āđāļāļĄāļāđāļāļĢāļ°āļāļ |
āļāļēāļĢāļēāļāļāļĩāđ 7.2 Request Body Parameters
| No. | Parameters Name | Data Type | Length | Mandatory / Optional | Description |
|---|---|---|---|---|---|
| 1 | TransactionId | Number | M | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļāļīāļ§āđāļāļĒāđ | |
| 2 | Checksum | String | 32 | M | āļāļĨāļĨāļąāļāļāđāļāļĩāđāđāļāđāļāļēāļāļāļēāļĢāļāļģāļāđāļēāļāļąāđāļāļŦāļĄāļāđāļāđāļāđāļēāļĢāļŦāļąāļŠ |
āļāļąāļ§āļāļĒāđāļēāļ āļāļēāļĢāđāļĢāļĩāļĒāļ Request Request Refund Transaction (Code āļ āļēāļĐāļē C# .NET)
var client = new RestClient("https://sandbox-api-transaction.chillpay.co/api/v1/refund/request");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("CHILLPAY-MerchantCode", "xxx");
request.AddHeader("CHILLPAY-ApiKey", "xxx");
request.AddHeader("Content-Type", "application/json");
var body = @"{""TransactionId"": 115007, ""Checksum"": ""75db12ab69411c40e74ff40ae09fcca8""}";
request.AddParameter("application/json", body, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
āļŦāļĄāļēāļĒāđāļŦāļāļļ
- āļāđāļē Checksum āđāļāđāļāļāļēāļĢāļāļģāļāđāļēāļāļēāļ Parameter āļāļēāļĄāļāļēāļĢāļēāļāļāļĩāđ 7.2 (āļāđāļ 1) āļĄāļēāļāđāļāļāđāļēāļĒāļāđāļ§āļĒ MD5 Secret Key (āļāļĩāđāđāļāđāļĢāļąāļāļāļēāļāļāļēāļāļāļīāļ§āđāļāļĒāđ) āļāļąāļāļāļĩāđ
- TransactionId + MD5 Secret Key
- āļāļēāļāļāļąāđāļāļāļģāļāđāļāļĄāļđāļĨāļāļĩāđāđāļĢāļĩāļĒāļāļāļąāļāļāļąāđāļāļŦāļĄāļāļāļĩāđāđāļāđāļāđāļēāļĢāļŦāļąāļŠāļāđāļ§āļĒāļāļąāļāļāđāļāļąāđāļ MD5 Hashing āļāļķāļāļāļ°āđāļāđāđāļāđāļāļāđāļē Checksum
- āļāļąāļ§āļāļĒāđāļēāļ āļāļēāļĢāļāļģāļāđāļāļĄāļđāļĨāļĄāļēāđāļĢāļĩāļĒāļāļāđāļāļāļąāļāđāļāļ·āđāļāđāļāđāļēāļāļąāļāļāđāļāļąāđāļ MD5
- 115007AAABBBCCCDDD
āļāļēāļĢāļēāļāļāļĩāđ 7.3 Response Message Parameters
| No. | Parameters Name | Data Type | Description |
|---|---|---|---|
| 1 | status | String | āļĢāļŦāļąāļŠāļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļēāļĒāļāļēāļĢ āļ āļēāļāļāļāļ§āļ āļ. |
| 2 | message | String | āļāļģāļāļāļīāļāļēāļĒāļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļēāļĒāļāļēāļĢ |
| 3 | data.transactionId | Number | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļāļīāļ§āđāļāļĒāđ |
| 4 | data.transactionDate | String | āļ§āļąāļāļāļĩāđāļāļģāļĢāļēāļĒāļāļēāļĢ [dd/MM/yyyy HH:mm:ss] |
| 5 | data.merchant | String | āļāļ·āđāļāļĢāđāļēāļāļāđāļē |
| 6 | data.customer | String | āļĢāļŦāļąāļŠāļāđāļēāļāļāļīāļāļŦāļĢāļ·āļāļāļ·āđāļāļĨāļđāļāļāđāļē |
| 7 | data.orderNo | String | āđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļĢāđāļēāļāļāđāļē |
| 8 | data.paymentChannel | String | āļāđāļāļāļāļēāļāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ |
| 9 | data.paymentDate | String | āļ§āļąāļāļāļĩāđāļāļģāļĢāļ°āđāļāļīāļ [dd/MM/yyyy HH:mm:ss] |
| 10 | data.amount | String | āļāđāļēāļŠāļīāļāļāđāļēāļŦāļĢāļ·āļāļāļĢāļīāļāļēāļĢ [#,##0.00] |
| 11 | data.fee | String | āļāđāļēāļāļĢāļĢāļĄāđāļāļĩāļĒāļĄ [#,##0.00] |
| 12 | data.totalAmount | String | āļĢāļēāļāļēāļĢāļ§āļĄ [#,##0.00] |
| 13 | data.currency | String | āļŠāļāļļāļĨāđāļāļīāļ |
| 14 | data.routeNo | Number | āđāļŠāđāļāļāļēāļāļāļģāļĢāļ°āđāļāļīāļ |
| 15 | data.serviceFee | String | āļāđāļēāļāļĢāļīāļāļēāļĢ [#,##0.00] |
| 16 | data.status | String | āļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ |
āļāļąāļ§āļāļĒāđāļēāļ āļāđāļāļĄāļđāļĨ JSON Response Message āļāļĩāđāđāļāđāļĢāļąāļāļāļēāļāļāļēāļĢāđāļĢāļĩāļĒāļ API
{
"status": 200,
"message": "Success",
"data": {
"transactionId": 115007,
"transactionDate": "03/02/2022 11:50:39",
"merchant": "Bank Industries",
"customer": "cus100005",
"orderNo": "order20211216101345",
"paymentChannel": "Credit Card",
"paymentDate": "04/03/2022 16:10:31",
"amount": "3,500.00",
"fee": "15.00",
"totalAmount": "3,515.00",
"currency": "THB",
"routeNo": 3,
"serviceFee": "113.75",
"status": "Refund Requested"
}
}
āļ āļēāļāļāļāļ§āļ
āļ āļēāļāļāļāļ§āļ āļ. Payment Transaction Status
| No. | Text | Description |
|---|---|---|
| 1 | Success | āļāļģāļĢāļēāļĒāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļāļŠāļģāđāļĢāđāļ |
| 2 | Fail | āļāļģāļĢāļēāļĒāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļāđāļĄāđāļŠāļģāđāļĢāđāļ |
| 3 | Cancel | āļĨāļđāļāļāđāļēāļĒāļāđāļĨāļīāļāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ |
| 4 | Error | āđāļāļīāļāļāđāļāļāļīāļāļāļĨāļēāļāļĢāļ°āļŦāļ§āđāļēāļāļāļģāļĢāļēāļĒāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ |
| 5 | Request | āļĢāļāļāļēāļĢāļāļģāļĢāļ°āļāđāļēāļŠāļīāļāļāđāļē/āļāļĢāļīāļāļēāļĢ |
| 6 | Void Requested | āļāļģāļĢāļēāļĒāļāļēāļĢāļĢāđāļāļāļāļāļāļēāļĢāļĒāļāđāļĨāļīāļāļĢāļēāļĒāļāļēāļĢāļŠāļģāđāļĢāđāļ |
| 7 | Voided | āļāļģāļĢāļēāļĒāļāļēāļĢāļĒāļāđāļĨāļīāļāļĢāļēāļĒāļāļēāļĢāļŠāļģāđāļĢāđāļ |
| 8 | Refund Requested | āļāļģāļĢāļēāļĒāļāļēāļĢāļĢāđāļāļāļāļāļāļēāļĢāļāļ·āļāđāļāļīāļāļŠāļģāđāļĢāđāļ |
| 9 | Refunded | āļāļģāļĢāļēāļĒāļāļēāļĢāļāļ·āļāđāļāļīāļāļŠāļģāđāļĢāđāļ |
āļ āļēāļāļāļāļ§āļ āļ. Payment Channel
| No. | Text | Description |
|---|---|---|
| 1 | CREDIT CARD | āļāļąāļāļĢāđāļāļĢāļāļīāļāđāļĨāļ°āđāļāļāļīāļ |
| 2 | INSTALLMENT KBANK | āļāđāļāļāļāļģāļĢāļ°āļāļąāļāļĢāļāļāļēāļāļēāļĢāļāļŠāļīāļāļĢ |
| 3 | KTC FLEXI | āļāđāļāļāļāļģāļĢāļ°āļāļąāļāļĢāļāļĢāļļāļāđāļāļĒ |
| 4 | INSTALLMENT KRUNGSRI | āļāđāļāļāļāļģāļĢāļ°āļāļąāļāļĢāđāļāđāļāļĢāļ·āļāļāļāļēāļāļēāļĢāļāļĢāļļāļāļĻāļĢāļĩāļŊ |
| 5 | INSTALLMENT SCB | āļāđāļāļāļāļģāļĢāļ°āļāļąāļāļĢāļāļāļēāļāļēāļĢāđāļāļĒāļāļēāļāļīāļāļĒāđ |
| 6 | FIRST CHOICE | āļāđāļāļāļāļģāļĢāļ°āļāļąāļāļĢāļāļĢāļļāļāļĻāļĢāļĩāđāļāļīāļĢāđāļŠāļāđāļāļĒāļŠāđ |
| 7 | KTC FOREVER | āđāļĨāļāļāļ°āđāļāļāļāļąāļāļĢāļāļĢāļļāļāđāļāļĒ |
| 8 | BAY | āļāļāļēāļāļēāļĢāļāļĢāļļāļāļĻāļĢāļĩāļāļĒāļļāļāļĒāļē |
| 9 | BBL | āļāļāļēāļāļēāļĢāļāļĢāļļāļāđāļāļ |
| 10 | SCB | āļāļāļēāļāļēāļĢāđāļāļĒāļāļēāļāļīāļāļĒāđ |
| 11 | KTB | āļāļāļēāļāļēāļĢāļāļĢāļļāļāđāļāļĒ |
| 12 | TBANK | āļāļāļēāļāļēāļĢāļāļāļāļēāļ |
| 13 | TTB | āļāļāļēāļāļēāļĢāļāļŦāļēāļĢāđāļāļĒāļāļāļāļēāļ |
| 14 | KPLUS | āļāļāļēāļāļēāļĢāļāļŠāļīāļāļĢ (K PLUS) |
| 15 | SCB EASY APP | āļāļāļēāļāļēāļĢāđāļāļĒāļāļēāļāļīāļāļĒāđ (SCB Easy App) |
| 16 | KMA APP | āļāļāļēāļāļēāļĢāļāļĢāļļāļāļĻāļĢāļĩāļāļĒāļļāļāļĒāļē (KMA App) |
| 17 | QRCODE | āļāļīāļ§āļāļēāļĢāđ āļāļĢāđāļāļĄāđāļāļĒāđ |
| 18 | ALIPAY | āļāļēāļĨāļĩāđāļāļĒāđ |
| 19 | WECHATPAY | āļ§āļĩāđāļāļāđāļāļĒāđ |
| 20 | LINEPAY | āđāļĢāļāļāļīāļ āđāļĨāļāđ āđāļāļĒāđ |
| 21 | TRUEMONEY | āļāļĢāļđāļĄāļąāļāļāļĩāđ āļ§āļāļĨāđāļĨāđāļ |
| 22 | SHOPEEPAY | āļāđāļāļāļāļĩāđāđāļāļĒāđ |
| 23 | CENPAY | āđāļāđāļāđāļāļĒāđ |
| 24 | BIGC | āļāļīāđāļāļāļĩ |
| 25 | BOONTERM | āļāļļāļāđāļāļīāļĄ |
āļ āļēāļāļāļāļ§āļ āļ. Response Message
| Code | Status Message | Description |
|---|---|---|
| 200 | Success | āļāļģāļĢāļēāļĒāļāļēāļĢāļŠāļģāđāļĢāđāļ |
| 1001 | InvalidParameter | āļāļēāļĢāļēāļĄāļīāđāļāļāļĢāđāđāļĄāđāļāļđāļāļāđāļāļ |
| 1002 | InvalidMerchantCode | āļĢāļŦāļąāļŠāļĢāđāļēāļāļāđāļēāđāļĄāđāļāļđāļāļāđāļāļ |
| 1003 | InvalidApiKey | āļĢāļŦāļąāļŠāļāđāļēāļāļāļīāļāļĢāđāļēāļāļāđāļēāđāļĄāđāļāļđāļāļāđāļāļ |
| 1004 | InvalidChecksum | āļĢāļŦāļąāļŠ Checksum āđāļĄāđāļāļđāļāļāđāļāļ |
| 2001 | InvalidMerchantCodeData | āļāđāļāļĄāļđāļĨāļĢāļŦāļąāļŠāļĢāđāļēāļāļāđāļēāđāļĄāđāļāļđāļāļāđāļāļ |
| 2002 | InvalidApiKeyData | āļāđāļāļĄāļđāļĨāļĢāļŦāļąāļŠāļāđāļēāļāļāļīāļāļĢāđāļēāļāļāđāļēāđāļĄāđāļāļđāļāļāđāļāļ |
| 2003 | InvalidOrderByData | āļāđāļāļĄāļđāļĨāļŠāļģāļŦāļĢāļąāļāđāļĢāļĩāļĒāļāļāļēāļĄāļāļāļĨāļąāļĄāļāđāđāļĄāđāļāļđāļāļāđāļāļ |
| 2004 | InvalidOrderDirData | āļāđāļāļĄāļđāļĨāļŠāļģāļŦāļĢāļąāļāļāļīāļĻāļāļēāļāļāļēāļĢāđāļĢāļĩāļĒāļāđāļĄāđāļāļđāļāļāđāļāļ |
| 2005 | InvalidPageSizeData | āļāđāļāļĄāļđāļĨāļāļģāļāļ§āļāļĢāļēāļĒāļāļēāļĢāļāđāļāļŦāļāđāļēāđāļĄāđāļāļđāļāļāđāļāļ |
| 2006 | InvalidPageNumberData | āļāđāļāļĄāļđāļĨāđāļĨāļāļŦāļāđāļēāđāļĄāđāļāļđāļāļāđāļāļ |
| 2007 | InvalidSearchKeywordData | āļāđāļāļĄāļđāļĨāļāļģāļŦāļĢāļ·āļāļāđāļāļāļ§āļēāļĄāļāļĩāđāļāđāļāļāļāļēāļĢāļāđāļāļŦāļēāđāļĄāđāļāļđāļāļāđāļāļ |
| 2008 | InvalidPaymentChannelData | āļāđāļāļĄāļđāļĨāļāđāļāļāļāļēāļāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļāđāļĄāđāļāļđāļāļāđāļāļ |
| 2009 | InvalidOrderNoData | āļāđāļāļĄāļđāļĨāđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāļāļāļāļāļēāļāļĢāđāļēāļāļāđāļēāđāļĄāđāļāļđāļāļāđāļāļ |
| 2010 | InvalidStatusData | āļāđāļāļĄāļđāļĨāļŠāļāļēāļāļ°āļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļāđāļĄāđāļāļđāļāļāđāļāļ |
| 2011 | InvalidTransactionDateData | āļāđāļāļĄāļđāļĨāļ§āļąāļāļāļĩāđāļāļģāļĢāļēāļĒāļāļēāļĢāđāļĄāđāļāļđāļāļāđāļāļ |
| 2012 | InvalidPaymentDateData | āļāđāļāļĄāļđāļĨāļ§āļąāļāļāļĩāđāļāļģāļĢāļ°āđāļāļīāļāđāļĄāđāļāļđāļāļāđāļāļ |
| 2013 | InvalidTransactionIdData | āļāđāļāļĄāļđāļĨāđāļĨāļāļāļĩāđāļāđāļēāļāļāļīāļāļĢāļēāļĒāļāļēāļĢāđāļĄāđāļāļđāļāļāđāļāļ |
| 2014 | InvalidChecksumData | āļāđāļāļĄāļđāļĨāļĢāļŦāļąāļŠ Checksum āđāļĄāđāļāļđāļāļāđāļāļ |
| 3001 | SearchFailed | āļāļēāļĢāļāđāļāļŦāļēāļĨāđāļĄāđāļŦāļĨāļ§ |
| 3002 | TransactionNotFound | āđāļĄāđāđāļāļāļĢāļēāļĒāļāļēāļĢāļāļģāļĢāļ°āđāļāļīāļ |
| 3003 | VoidFailed | āđāļĄāđāļŠāļēāļĄāļēāļĢāļāļāļģāļāļēāļĢāļĒāļāđāļĨāļīāļāļĢāļēāļĒāļāļēāļĢāđāļāđ |
| 3004 | RefundFailed | āđāļĄāđāļŠāļēāļĄāļēāļĢāļāļāļģāļĢāļēāļĒāļāļēāļĢāļāļāļāļ·āļāđāļāļīāļāđāļāđ |
| 4001 | AccountUnauthorized | āļāļąāļāļāļĩāļĢāđāļēāļāļāđāļēāļĒāļąāļāđāļĄāđāđāļāđāļĢāļąāļāļāļēāļĢāļāļāļļāļĄāļąāļāļī |
| 4002 | SystemError | āļĢāļ°āļāļāđāļāļīāļāļāđāļāļāļīāļāļāļĨāļēāļāđāļĄāđāļŠāļēāļĄāļēāļĢāļāļāļģāļĢāļēāļĒāļāļēāļĢāđāļāđ |
| 4003 | SystemMaintenanceTime | āļāļĒāļđāđāđāļāļĢāļ°āļĒāļ°āđāļ§āļĨāļēāļāļĢāļąāļāļāļĢāļļāļāļĢāļ°āļāļ |
| 4004 | RequestExceededLimit | āļāļēāļĢāļĢāđāļāļāļāļāđāļāļīāļāļāļģāļāļ§āļāļāļĩāđāļāļģāļŦāļāļ |