Get the list of all merchant accounts

Use this request to get the list of all merchant accounts registered in your payment processing system.

Request

The requests must:

• use HTTP Basic authentication with your PSP ID and secret key as a username and a password respectively;
• have the Content-Type header set to application/json;
• have the Accept header set to application/json;
• be UTF-8 encoded.

Send a GET request to {YOUR DWH URL}/api/v1/merchants.

Request example

curl -v "http://boapi.begateway.com/api/v1/merchants" \
    -H "Authorization: Basic MTpwc3BfMV9rZXk=" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" 

Response

The response contains the following parameters:

Parameter	Type	Description
data	array	An array of merchant accounts. Each element represents an object with merchant account details.
company name * required	string	A name of the merchant's company.
enabled * required	boolean	A status of the merchant account. Possible values: true, if the account is active; false, if the account is inactive.
id * required	integer	An identifier of the merchant account in the system.

Info

Array data are sorted by a creation date of a merchant account in the descending order.

Response example

{
  "data": [
    {
      "company_name": "Company C",
      "enabled": false,
      "id": 3
    },
    {
      "company_name": "Company B",
      "enabled": true,
      "id": 2
    },
    {
      "company_name": "Company A",
      "enabled": true,
      "id": 1
    }
  ]
}