Create a merchant account
You can create a new merchant account 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.
Info
For better experience while creating a merchant in the back office, refer to The beGateway PSP back office manual.
Request
The requests must:
- use HTTP Basic authentication with
xas 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-Typeheader set toapplication/jsonorapplication/xmldepending on the request body format; - have the
Acceptheader set toapplication/jsonorapplication/xmldepending on the preferred response format; - be UTF-8 encoded.
Send a POST request to {YOUR_BACKOFFICE_URL}/api/merchants/ with the following parameters:
| Parameter | Type | Description |
|---|---|---|
| merchant | object | A section of the merchant account details. |
| name * required | string | A name of the merchant. |
| email * required | string | An email of the merchant. Used as a login to the system back office. |
| password * required | string | A password that the merchant will use to log into the system back office. |
| 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. |
| city * required | string | A city where the merchant's company is registered. |
Request example
{ "merchant": { "name": "Demo Merchant", "email": "test@example.com", "password": "1234test", "company_name": "Demo Inc", "country": "IT", "city": "Milan" }}
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 created 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 back office. |
| enabled * required | boolean | A status of the created 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": 1, "name": "Demo Merchant", "email": "test@example.com", "enabled": true, "company_name": "Demo Inc", "country": "IT" }}