Query
Request address
Sandbox : https://sandbox.j-pay.net/pay/merchant/query
Request headers
| Header Name | Required(Y or N) | Description |
|---|---|---|
| Agent-Merchant-Id | Y | Agent merchant ID |
Request parameters
| Parameter Name | Type | Required(Y or N) | Sign(Y or N) | Parameter Description |
|---|---|---|---|---|
| memberid | String | Y | Y | Merchant ID |
| sign | String | Y | N | See MD5 signature example |
Return parameters
| Parameter Name | Type | Parameter Description |
|---|---|---|
| memberid | String | Merchant ID |
| String | ||
| country | String | Country |
| company | Object | Company information |
| business_profile | Object | Business profile |
| documents | Object | Documents |
| bank | Array | Bank accounts |
| persons | Array | Persons |
company
| Parameter Name | Type | Parameter Description |
|---|---|---|
| name | String | Company name |
| tax_id | String | Tax ID |
| phone | String | Phone |
| cert_valid_date | String | Certificate valid date |
| cert_past_date | String | Certificate past date |
| state | String | State / Province |
| city | String | City |
| postal_code | String | Postal code |
| line1 | String | Address line 1 |
| line2 | String | Address line 2 |
business_profile
| Parameter Name | Type | Parameter Description |
|---|---|---|
| mcc | String | MCC |
| url | String | Website URL |
documents
| Parameter Name | Type | Parameter Description |
|---|---|---|
| company_registration | Array | Company registration files (URLs) |
| company_address | Array | Company address proof files (URLs) |
| company_moa | Array | MOA files (URLs) |
| bank_proof | Array | Bank proof files (URLs) |
bank[]
| Parameter Name | Type | Parameter Description |
|---|---|---|
| id | String | Bank record ID |
| type | String | china or other |
| bank_name | String | Bank name |
| swift_code | String | Swift code |
| subbranch | String | Sub-branch |
| account | String | Account number |
| address | String | Bank address |
| remark | String | Remark |
persons[]
| Parameter Name | Type | Parameter Description |
|---|---|---|
| id | String | Person ID |
| id_number | String | ID number |
| first_name | String | First name |
| last_name | String | Last name |
| birthday | String | Birthday |
| phone | String | Phone |
| percent_ownership | String | Percent ownership |
| title | String | Title |
| cert_issue_date | String | Certificate issue date |
| cert_expiration_date | String | Certificate expiration date |
| address | Object | Address |
| documents | Object | Documents |
Example Request
- Javascript
- Php
- Python
import { md5 } from "js-md5";
import axios from "axios";
const KEY = "YOUR_AGENT_API_KEY";
const AGENT_MERCHANT_ID = "10010";
let query = {
memberid: "10130",
};
let signData = [];
Object.keys(query)
.sort()
.forEach((key) => signData.push(`${key}=${query[key]}`));
signData.push(`key=${KEY}`);
Object.assign(query, {
sign: md5(signData.join("&")).toUpperCase(),
});
axios
.request({
url: "https://sandbox.j-pay.net/pay/merchant/query",
method: "post",
headers: {
"Content-Type": "application/x-www-form-urlencoded",
"Agent-Merchant-Id": AGENT_MERCHANT_ID,
},
data: query,
})
.then(({ data }) => {
console.log("success", data);
})
.catch((error) => {
console.log("error", error);
});
Comming soon...
Response example
- Success
- Error
{
"memberid": "10005",
"email": "[email protected]",
"country": "US",
"company": {
"name": "Company Name",
"tax_id": "",
"phone": "",
"cert_valid_date": "",
"cert_past_date": "",
"state": "",
"city": "",
"postal_code": "",
"line1": "",
"line2": ""
},
"business_profile": {
"mcc": "",
"url": ""
},
"documents": {
"company_registration": [],
"company_address": [],
"company_moa": [],
"bank_proof": []
},
"bank": [
{
"id": "uuid",
"type": "other",
"bank_name": "",
"swift_code": "",
"subbranch": "",
"account": "",
"address": "",
"remark": ""
}
],
"persons": [
{
"id": 1,
"id_number": "",
"first_name": "",
"last_name": "",
"birthday": "",
"phone": "",
"percent_ownership": "",
"title": "",
"cert_issue_date": "",
"cert_expiration_date": "",
"address": {
"country": "",
"state": "",
"city": "",
"postal_code": "",
"line1": "",
"line2": ""
},
"documents": {
"company_authorization": [],
"passport": [],
"passport_handing": []
}
}
]
}
{ msg: 'message', status: 'error' }