List all merchants

Get merchants

GET https://<PayEngine-host>/merchant

Returns a list of accounts connected to your organization.

Query Parameters

Name
Type
Description

size

number

A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.

page

number

Specify the page number that needs to be retrieved

Response

{
    "data": [
        {
            "id": "d6399869-747c-4537-9c04-f81ce2a6c5eb",
            "name": "Merchant 1",
            "email": "[email protected]",
            "status": "editing",
            "created_at": "2022-03-07T16:40:24.213Z",
            "updated_at": "2022-03-07T16:40:24.213Z",
            "mid": "",
            "total_payment_volume": "0.00"
        },
        {
            "id": "03e675d2-ef81-4d1b-a236-cee7f6abee57",
            "name": "Merchant 2",
            "email": "[email protected]",
            "status": "editing",
            "created_at": "2022-03-07T16:35:21.460Z",
            "updated_at": "2022-03-07T16:35:21.460Z",
            "mid": "",
            "total_payment_volume": "0.00"
        },
        {
            "id": "d52d6547-b12e-43f1-a361-58c5f67226b5",
            "name": "Merchant 3",
            "email": "[email protected]",
            "status": "submitted_to_pe",
            "created_at": "2022-03-07T16:08:32.876Z",
            "updated_at": "2022-03-07T16:08:32.876Z",
            "mid": "",
            "total_payment_volume": "0.00"
        }
   ]
}

var config = {
  method: 'get',
  url: 'http://<PayEngine-host>/api/merchant',
  headers: { 
    'accept': 'application/json', 
    'Authorization': 'Basic {{YOUR_API_SECRET}}'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Last updated