Skip to main content

List

Request address

Sandbox : https://sandbox.j-pay.net/pay/merchant/list

Request headers

Header NameRequired(Y or N)Description
Agent-Merchant-IdYAgent merchant ID

Request parameters

Parameter NameTypeRequired(Y or N)Sign(Y or N)Parameter Description
pageStringNYPage number, default 1
sizeStringNYPage size, default 20
signStringYNSee MD5 signature example

Return parameters

Parameter NameTypeParameter Description
listArrayMerchant list
totalNumberTotal count
pageNumberCurrent page
sizeNumberPage size

Each item in list is a merchant object returned by Merchant Query.

Example Request

import { md5 } from "js-md5";
import axios from "axios";

const KEY = "YOUR_AGENT_API_KEY";
const AGENT_MERCHANT_ID = "10000";

let query = {
page: 1,
size: 20,
};

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/list",
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);
});

Response example

{
"list": [
{
"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": [],
"persons": []
}
],
"total": 1,
"page": 1,
"size": 20
}