Merchant User Operations
Merchant Login
Live URL : https://reportingapi.openpaydpsp.com.com/api/v3/merchant/user/login
Test URL : https://psp-reportingapi-test.openpaydpsp.com/api/v3/merchant/user/login
| Parameter name | Details | Example | Type |
|---|---|---|---|
| Email address of merchant user. | [email protected] | Char(128) | |
| password | Password | 123456 | Char(32) |
Successful Response
{
token : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudFVzZXJJZCI6MSwicm9sZSI6ImFkbWluIiwibWVyY2hhbnRJZCI6MSwic3ViTWVyY2hhbnRJZHMiOltdLCJ0aW1lc3RhbXAiOjE0NDQzODk4ODB9.zPxVu4fkRqIy1uG2fO3X2RbxiI4otK_HG7M4MMTB298",
status : "APPROVED"
}The parameter 'token' in response is important because token is required for all API requests.
Please bear in mind that you need to use this token in every API endpoint request as a header parameter.
Mandatory Header parameter per API request
| Name | Details | Example | Type |
|---|---|---|---|
| Authorization | JWT token generated in merchant login. | eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFu dFVzZXJJZCI6MSwicm9sZ SI6ImFkbWluIiw | Text |
Token is valid for 10 minutes.
Merchant Detail
Live URL : https://reportingapi.openpaydpsp.com.com/api/v3/merchant/get
Test URL : https://psp-reportingapi-test.openpaydpsp.com/api/v3/merchant/get
Post parameters
| Post parameters | Details | Example | Type |
|---|---|---|---|
| id | The merchant identifier. | 1 | int |
Successful Response
{
status : "APPROVED",
message : "Approved",
merchant : {
id : 3,
parentId : null,
name : "Dev-Merchant",
3dStatus : "ALL",
mcc : "6012",
ipnUrl : "",
apiKey : "b5c946997663e1356542fd966167bbae",
cpgKey : null,
type : "ECOM",
descriptor : "descriptor2",
secretKey : "1234",
comType : "API"
}
}Merchant User :: Create
Live URL : https://reportingapi.openpaydpsp.com.com/api/v3/merchant/user/create
Test URL : https://psp-reportingapi-test.openpaydpsp.com/api/v3/merchant/user/create
Post parameters
| Parameter name | Details | Example | Type | Is Required |
|---|---|---|---|---|
| merchantId | The merchant identifier. | 1 | Int | ✔ |
| subMerchantId | The sub merchant identifier. | 1✔ | Int | |
| name | Merchant user name. | Pluto | Char(64) | ✔ |
| password | Merchant user password. | 12345 | Char(32) | ✔ |
| Email address. | [email protected] | Char(32) | ✔ |
Successful Response
{
status: "APPROVED",
message: "Merchant User Created",
id: 59
}Merchant User :: Update
Live URL : https://reportingapi.openpaydpsp.com.com/api/v3/merchant/user/update
Test URL : https://psp-reportingapi-test.openpaydpsp.com/api/v3/merchant/user/update
Post parameters
| Parameter name | Details | Example | Type | Is Required |
|---|---|---|---|---|
| id | Merchant user identifier. | 1 | Int | ✔ |
| name | Merchant user name. | john | Char(64) | ✔ |
| Email address. | [email protected] | Char(64) | ✔ | |
| role | Merchant user role (admin/user) | admin | Char(64) | ✔ |
Successful Response
{
status: "APPROVED",
message: "Merchant User Updated"
}Merchant User :: Show
Live URL : https://reportingapi.openpaydpsp.com.com/api/v3/merchant/user/show
Test URL : https://psp-reportingapi-test.openpaydpsp.com/api/v3/merchant/user/show
Post parameters
| Parameter name | Details | Example | Type |
|---|---|---|---|
| id | Merchant user identifier. | 1 | int |
Successful Response
{
status: "APPROVED",
merchantUser: {
id: 59,
role: "admin",
email: "[email protected]",
name: "Demo User 2",
merchantId: 3,
secretKey : null
}
}Merchant User :: Info
Live URL : https://reportingapi.openpaydpsp.com.com/api/v3/merchant/user/info
Test URL : https://psp-reportingapi-test.openpaydpsp.com/api/v3/merchant/user/info
Post parameters
| Parameter name | Details | Example | Type |
|---|---|---|---|
| merchantUserId | Merchant user identifier. | 1 | Int |
Successful Response
{
id: 53,
name: "Merchant",
role: "admin",
email: "[email protected]",
merchantId: 1,
secretKey : null,
status: "APPROVED"
}Merchant User :: Change Password
Live URL : https://reportingapi.openpaydpsp.com.com/api/v3/merchant/user/changePassword
Test URL : https://psp-reportingapi-test.openpaydpsp.com/api/v3/merchant/user/changePassword
Post parameters
| Parameter name | Details | Example | Type |
|---|---|---|---|
| merchantId | The merchant identifier. | 1 | Int |
| id | Merchant user identifier. | 1 | Int |
| password | New password. | 12345 | Char(64) |
Successful Response
{
status: "APPROVED",
message: "Merchant User Password Updated",
id: 59
}Non-Successful Response
{
code: 0,
status: "DECLINED",
message: "Merchant no privileges"
}Merchant User :: List
Live URL : https://reportingapi.openpaydpsp.com.com/api/v3/merchant/sub/getList
Test URL : https://psp-reportingapi-test.openpaydpsp.com/api/v3/merchant/sub/getList
Post parameters
| Parameter name | Details | Example | Type | Is Required |
|---|---|---|---|---|
| merchantId | The merchant identifier. | 1 | Int | ✔ |
| subMerchantId | The sub merchant identifier. | 1 | Int |
Successful Response
{
status: "APPROVED",
message: "Merchant User List Download",
merchantUsers:[
{
id: 6,
name: "John Doe",
email: "[email protected]",
password: "$2y$10$0U4yw5dDFFrCJ3hwdOc3P.Way0Od4maaJ.rwkTa8gnb7k0rEeXUpq",
role: "admin",
merchantId: 3,
secretKey: ""
},
{id: 53, name: "John Doe", email: "[email protected]",
password:"$2y$10$h8iwV1/MtaG7RnZV1alDmu4F5ifCsE1c9b9juh0pa6kC6W…",…},
{id: 59, name: "Demo User 2", email: "[email protected]",
password:"$2y$10$MzboGDzIcEev97pzSTfUaOJZBoxBzLNiYdQocgXzeoL1Tgv/7Qxbq",…}
]
}Merchant User :: Delete
Live URL : https://reportingapi.openpaydpsp.com.com/api/v3/merchant/user/delete
Test URL : https://psp-reportingapi-test.openpaydpsp.com/api/v3/merchant/user/delete
Post parameters
| Parameter name | Details | Example | Type |
|---|---|---|---|
| id | Merchant user identifier. | 1 | int |
Successful Response
{
status: "APPROVED",
message: "Merchant User Deleted",
id: "56"
}Updated about 1 year ago