Skip to content
English
Customer portal
eComCharge Blog
  • There are no suggestions because the search field is empty.

Get shop details

Use this request to get the details of the merchant's shop.

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/shops/{SHOP_ID}, where {SHOP_ID} is an identifier of the merchant's shop account in the system.

Response

The response contains the following parameters:

Parameter Type Description
shop object A section of the merchant's shop details.
id * required integer An identifier of the merchant's shop account.

Used to authorize merchant requests.
name * required string A name of the merchant's shop.
URL * required string An URL of the merchant's shop.
contact_email * required string An email of the merchant's shop.

Indicated as contact information in transaction receipts.
contact_phone * required string A phone number of the merchant's shop.
Indicated as contact information in transaction receipts.
secret_key string A secret key of the merchant's shop account.

Used to authorize merchant requests.
enabled boolean A status of the merchant's shop account.

Possible values:
true, if the shop is active;
false, if the shop is inactive.
merchant_id integer An identifier of the merchant account in the system.

Response example 

{
  "shop":{
    "id":49,
    "name":"Audi cars",
    "url":"http://audi.com",
    "contact_email":"info@audi.com",
    "contact_phone":"551199",
    "secret_key":"4153d3c6c8c99b1d0e16182e864861c1162a75b236d9237acf468926c29cc6b0",
    "enabled":true,
    "merchant_id":79
  }
}