---
# System prepended metadata

title: HKACS Third Party Payment Gateway

---

[TOC]
### HKACS Third Party Payment Gateway    
##### Brief Description

- After submit the form data
- Browser will redirect to payment gateway page, user input credit card etc.
- After payment procress, it will redirect to the page
- Success page and Fail page set on the CRM backend

##### Request URL
- `/thirdparty_payment_form`
  
##### Request Method
- POST 

##### Form data - Parameters

| Parameter Name | Required | Type   | Sample | Description
|:-------------- |:-------- |:-------|:------------| -|
| amount       | Yes      | string | 10    | HKD|
| reference_number       | Yes      | string | ref-00001    | Partner unique ID|
| bill_to_surname           | No       | string | Sam    |-|
| bill_to_forename           | No       | string | Chan    |-|
| bill_to_address_line1           | No       | string | Hong Kong Island    |-|
| bill_to_address_city           | No       | string | HK    |-|
| bill_to_email           | No       | string | sam.chan@gmail.com    |-|
| app_id           | Yes       | string | sampleapp001    |-|
| app_secret           | No       | string | sampleapppassword    |-|
| lang           | Yes       | string | en    |English - `en`, 中文 - `hk` |


##### Note 

- For more error codes, please refer to the error code description on the homepage.


### GetPaymentStatus

##### Brief Description

- GetPaymentStatus

##### Request URL
- `/api/thirdparty/GetPaymentStatus`
  
##### Request Method
- POST 

##### Request Parameters

| Parameter Name | Required | Type   | Sample | Description
|:-------------- |:-------- |:-------|:------------| -|
| reference_number       | Yes      | string | ref-00001    | Partner unique ID|
| app_id           | Yes       | string | sampleapp001    |-|
| app_secret           | Yes       | string | sampleapppassword    |-|

##### Request

```json
{
    "app_id":"sampleapp001",
    "app_secret":"sampleapppassword",
    "reference_number":"ref-00001"
}
```

##### Respond Parameters

| Parameter Name | Type   | Sample | Description
|:-------------- |:-------|:------------| -|
| reference_number       |  string | ref-00001    | Partner unique ID|
| reply_code           |  string |   100  |100 = Success|
| reply_message           |  string |  -   |-|
| payment_status           |  string |  -   |Success, Failed, Pending|

##### Respond

```json
{
    "reply_code": "100",
    "reply_message": "Request was processed successfully.",
    "payment_status": "Success",
    "reference_number": "53425342534"
}

{
    "reply_code": "476",
    "reply_message": "Payer could not be authenticated.",
    "payment_status": "Failed",
    "reference_number": "654645654"
}

{
    "reply_code": null,
    "reply_message": null,
    "payment_status": "Pending",
    "reference_number": "80000024-8888"
}
```
