Payer Add
API Information
- Path:
/api/v1/acct/addPayer - Method: POST
- Content-Type: application/json
Business Description
- Add payer (supports corporate/individual information under merchant dimension)
- Can add corporate and individual payer information, distinguished by subEntityType
Request Parameters
Headers
Request Headers
| Parameter | Value | Required | Description |
|---|---|---|---|
| Content-Type | application/json | Yes | Request body type |
Request Body
Main Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| merchantNo | integer | Merchant Number | M |
| companyNameEn | string | Company English Name (Required for Corporate) | C |
| companyName | string | Company Name (Required for Corporate) | C |
| country | string | Country | M |
| addressEn1 | string | Address | M |
| addressEn2 | string | Registration Address 2 | |
| addressEn3 | string | Registration Address 3 | |
| registerNo | string | Registration Number | M |
| registerDate | string | Registration Date | M |
| postcode | string | Postal Code | M |
| string | M | ||
| areaCode | string | Area Code | M |
| phoneNumber | string | Phone Number | M |
| state | string | State/Province | M |
| city | string | City | M |
| subEntityType | string | Type: "0" Company "1" Individual | C |
| firstName | string | First Name (Required for Individual) | C |
| lastName | string | Last Name (Required for Individual) | C |
| idType | string | ID Type: 0: NRIC, 1: PASSPORT, 2: CORPORATE_REGISTRATION_NUMBER | M |
| idNumber | string | ID Number | M |
| birthDate | string | Date of Birth | M |
| idValidDateFrom | string | ID Valid From Date | C |
| idValidDateTo | string | ID Valid To Date | M |
| sign | string | Signature | M |
Request Example
json
{
"merchantNo": "800149",
"country": "HK",
"addressEn1": "Nanshan Science & Technology Park, Shenzhen",
"addressEn2": "2all",
"addressEn3": "3",
"postcode": "518057",
"status": 0,
"email": "1@qq.com",
"areaCode": "+86",
"phoneNumber": "15072871023",
"state": "hubei",
"city": "wuhan",
"subEntityType": "0",
"companyNameEn": "test companyname814",
"companyName": "测试企业名称814",
"idType": "2",
"registerNo": "37132819841",
"registerDate": "2024-10-04",
"idValidDateFrom": "2006-08-04",
"idValidDateTo": "2046-08-04",
"sign" : "AD121231231231231231"
}Response
Response Headers
| Parameter | Value | Required | Description |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | Yes | Response body type |
Response Parameters
Response Fields
| Parameter | Type | Description |
|---|---|---|
| respCode | string | Response Code |
| respMsg | string | Response Message |
| data | object | Response Data |
| └─Integer | Payer ID |
Response Example
json
{
"respCode": "",
"respMsg": "",
"data": 1912390988777680897
}