Skip to content

Get merchant account details

Use this request to get details of the merchant account registered in your payment processing system.

Request

The requests must:

  • use HTTP Basic authentication with x as a username and your PSP secret key as a password;
  • have a body with parameters in the JSON or XML formats, or as an HTML form data;
  • have the Content-Type header set to application/json or application/xml depending on the request body format;
  • have the Accept header set to application/json or application/xml depending on the preferred response format;
  • be UTF-8 encoded.

Send a GET request to {YOUR_BACKOFFICE_URL}/api/merchants/{MERCHANT_ID}, where {MERCHANT_ID} is an identifier of the merchant account in the system.

Response

The response contains the following parameters:

Parameter Type Description
merchant object A section of the merchant account details.
id * required
integer An identifier of the merchant account in the system.
name * required
string A name of the merchant.
email * required
string An email of the merchant.

Used as a login to the system backoffice.
enabled * required
boolean A status of the merchant account.

Possible values:
true, if the account is active;
false, if the account is inactive.
company_name * required
string A name of the merchant's company.
country * required
string A country where the merchant's company is registered.

Set in the ISO 3166-1 alpha-2 format.
Response example
{
  "merchant":
  {
    "id":74578,
    "name":"John Doe",
    "email":"john@example.com",
    "enabled":true,
    "company_name":"Demo Company LLC",
    "country": "AZ"
  }
}