Skip to content

Create a merchant shop

You can create a new merchant shop in your payment processing system by following one of the two ways below:

  • in the back office on the Merchants tab page;
  • via the API request described below.

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 POST request to {YOUR_BACKOFFICE_URL}/api/shops/ with the following parameters:
Parameter Type Description
shop object A section of the merchant's shop details.
name * required
 string A name of the merchant's shop.
URL * required
 string A 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.
merchant_id * required
 integer An identifier of the merchant account in the system.
Request example 
{
  "shop":
  {
    "name":"The best wheels",
    "url":"http://wheels.com",
    "contact_email":"info@wheels.com",
    "contact_phone":"+123 555 678",
    "merchant_id": 789
  }
}

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 A 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 * required
 string A secret key of the merchant's shop account.

Used to authorize merchant requests.
enabled * required
 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 * required
 integer An identifier of the merchant account in the system.
Response example 
{
    "shop": {
        "id": 184,
        "name": "The best wheels",
        "url": "http://wheels.com",
        "contact_email": "info@wheels.com",
        "contact_phone": "+123 555 678",
        "secret_key": "28d92e1234e6c4234057031871f2083612dc3b86f4f6c305d5fd0ad974d081ad",
        "enabled": true,
        "merchant_id": 69
    }
}