Add websites


Use the following requests to add, retrieve, or update websites linked to an affiliated merchant account:

Authentication

All of the website requests require a partner account API key. For more information, email your partner manager.

All URLs on this page are directed to our test API. To use the live API, change the subdomain in the URL from testapi to api and use the corresponding API key.


Add a website

POST https://testapi.multisafepay.com/v1/json/accounts/{affiliate_account_id}/sites

Add a website to an affiliated merchant account.

Path parameters

Parameter Description
affiliate_account_id
string
The affiliated merchant ID.
Format: 8 character string, e.g. 12345678. Required.
Request body parameters
Parameter Description
name
string
Name of the website.
Format: Max 120 characters. Required.
notification_url
string
The webhook endpoint for the website.
Format: URL (max 150 characters). Optional.
price_from
integer
The expected minimum order value for credit card transactions.
Format: Unsigned integer. Optional.
price_till
integer
The expected maximum order value for credit card transactions.
Format: Unsigned integer. Optional.
support_email
string
The website’s customer support email address.
Format: Email address (max 100 characters). Optional.
support_phone
string
The customer support phone number for the website.
Format: Phone number (max 100 characters). Optional.
URL
string
The URL of the website.
Format: URL (max 150 characters). Required.
Response body parameters

The following are in addition to the request body parameters.

Parameter Description
account_id
string
The affiliated merchant ID.
Format: 8 character string, e.g. 12345678.
api_key
string
The API key for the website.
Format: 40 character string, e.g. 4192937dffd72a34bcaef4e4f589beb74188d0fa.
id
integer
The unique identifier of the website.
Format: 5-digit integer, e.g. 12345.
Sample request
curl -X POST "https://testapi.multisafepay.com/v1/json/accounts/{affiliate_account_id}/sites?api_key={your-account-api-key}" \
--header "accept: application/json" 
--header "Content-Type: application/json" \
--data-raw '{
  "name":"Funcompany",
  "notification_url":"https://funcompany.com/transactionhook",
  "price_from":50,
  "price_till":500,
  "support_email":"[email protected]",
  "support_phone":"0123456789",
  "url":"https://funcompany.com"
}'
Sample response
{
  "data": {
    "account_id": {affiliate_account_id},
    "api_key": "4192937dffd72a34bcaef4e4f589beb74188d0fa",
    "id": 12345,
    "name": "Funcompany",
    "notification_url": "https://funcompany.com/transactionhook",
    "price_from": 50,
    "price_till": 500,
    "support_email": "[email protected]",
    "support_phone": "0123456789",
    "url": "https://funcompany.com"
  },
  "success": true
}

List websites

GET https://testapi.multisafepay.com/v1/json/accounts/{affiliate_account_id}/sites?api_key={your-account-api-key}

Retrieve an array of all websites linked to a merchant account.

Path parameters

Parameter Description
affiliate_account_id
string
The affiliated merchant ID.
Format: 8 character string, e.g. 12345678. Required.
Response body parameters
Parameter Description
account_id
string
The affiliated merchant ID.
Format: 8 character string, e.g. 12345678.
api_key
string
The API key for the website.
Format: 40 character string, e.g. 4192937dffd72a34bcaef4e4f589beb74188d0fa.
id
integer
The unique identifier of the website. Referred to as site_id.
Format: 5-digit integer, e.g. 12345.
name
string
The name of the website.
Format: Max 120 characters.
notification_url
string
The webhook endpoint for the website.
Format: URL (max 150 characters).
price_from
integer
The expected minimum order value for credit card transactions.
Format: Unsigned integer.
price_till
integer
The expected maximum order value for credit card transactions.
Format: Unsigned integer.
support_email
string
The website’s customer support email address.
Format: Email address (max 100 characters).
support_phone
string
The customer support phone number for the website.
Format: Phone number (max 100 characters).
URL
string
The URL of the website.
Format: URL (max 150 characters).
Sample request
curl -X GET "https://testapi.multisafepay.com/v1/json/accounts/{affiliate_account_id}/sites?api_key={your-account-api-key}" \
--header "accept: application/json" \
Sample response
{
  "data": [
    {
      "account_id": {affiliate_account_id},
      "api_key": "4192937dffd72a34bcaef4e4f589beb74188d0fa",
      "id": 12345,
      "name": "Funcompany",
      "notification_url": "https://funcompany.com/transactionhook",
      "price_from": 50,
      "price_till": 500,
      "support_email": "[email protected]",
      "support_phone": "0123456789",
      "url": "https://funcompany.com"
    }
  ],
  "page": {
    "total": 1
  },
  "success": true
}

Get website

GET https://testapi.multisafepay.com/v1/json/sites/{site_id}?api_key={your-account-api-key}

Retrieve information about a specific website.

Path parameters

Parameter Description
site_id
integer
The unique identifier of the website.
Format: 5-digit integer, e.g. 12345. Required.

The site_id is returned as id in the add a website and list websites requests.
Response body parameters
Parameter Description
account_id
string
The affiliated merchant ID.
Format: 8 character string, e.g. 12345678.
api_key
string
The API key for the website.
Format: 40 character string, e.g. 4192937dffd72a34bcaef4e4f589beb74188d0fa.
id
integer
The unique identifier of the website. Referred to as site_id. Format: 5-digit integer, e.g. 12345.
name
string
Name of the website.
Format: Max 120 characters.
notification_url
string
The webhook endpoint for the website.
Format: URL (max 150 characters).
price_from
integer
The expected minimum order value for credit card transactions.
Format: Unsigned integer.
price_till
integer
The expected maximum order value for credit card transactions.
Format: Unsigned integer.
support_email
string
The website’s customer support email address.
Format: Email address (max 100 characters).
support_phone
string
The customer support phone number for the website.
Format: Phone number (max 100 characters).
URL
string
The URL of the website.
Format: URL (max 150 characters).
Sample request
curl -X GET "https://testapi.multisafepay.com/v1/json/accounts/sites/{site_id}?api_key={your-account-api-key}" \
--header "accept: application/json" \
Sample response
{
  "data": {
    "account_id": {affiliate_account_id},
    "api_key": "4192937dffd72a34bcaef4e4f589beb74188d0fa",
    "id": {site_id},
    "name": "Funcompany",
    "notification_url": "https://funcompany.com/transactionhook",
    "price_from": 50,
    "price_till": 500,
    "support_email": "[email protected]",
    "support_phone": "0123456789",
    "url": "https://funcompany.com"
  },
  "success": true
}

Update website

PATCH https://testapi.multisafepay.com/v1/json/sites/{site_id}?api_key={your-account-api-key}

Update information about an existing website.

Path parameters

Parameter Description
site_id
integer
The unique identifier of the website.
Format: 5-digit integer, e.g. 12345. Required.

The site_id is returned as id in the add a website and list websites requests.
Request body parameters
Parameter Description
name
string
The name of the website.
Format: Max 120 characters. Optional.
notification_url
string
The webhook endpoint for the website.
Format: URL (max 150 characters). Optional.
price_from
integer
The expected minimum order value for credit card transactions.
Format: Unsigned integer. Optional.
price_till
integer
The expected maximum order value for credit card transactions.
Format: Unsigned integer. Optional.
support_email
string
The website’s customer support email address.
Format: Email address (max 100 characters). Optional.
support_phone
string
The customer support phone number for the website.
Format: Phone number (max 100 characters). Optional.
URL
string
The URL of the website.
Format: URL (max 150 characters). Optional.
Response body parameters
Parameter Description
account_id
string
The affiliated merchant ID.
Format: 8 character string, e.g. 12345678.
api_key
string
The API key for the website.
Format: 40 character string, e.g. 4192937dffd72a34bcaef4e4f589beb74188d0fa.
id
integer
The unique identifier of the website. Referred to as site_id. Format: 5-digit integer, e.g. 12345.
name
string
The name of the website.
Format: max 120 characters.
notification_url
string
The webhook endpoint for the website.
Format: URL (max 150 characters).
price_from
integer
The expected minimum order value for credit card transactions.
Format: Unsigned integer.
price_till
integer
The expected maximum order value for credit card transactions.
Format: Unsigned integer.
support_email
string
The website’s customer support email address.
Format: Email address (max 100 characters).
support_phone
string
The customer support phone number for the website.
Format: Phone number (max 100 characters).
URL
string
The URL of the website.
Format: URL (max 150 characters).
Sample request
curl -X PATCH "https://testapi.multisafepay.com/v1/json/sites/{site_id}?api_key={your-account-api-key}" \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--data-raw '{
  "notification_url": "https://funcompany.com/newhook"
}'
Sample response
{
  "data": {
    "account_id": {affiliate_account_id},
    "api_key": "4192937dffd72a34bcaef4e4f589beb74188d0fa",
    "id": {site_id},
    "name": "Funcompany",
    "notification_url": "https://funcompany.com/newhook",
    "price_from": 50,
    "price_till": 500,
    "support_email": "[email protected]",
    "support_phone": "0123456789",
    "url": "https://funcompany.com"
  },
  "success": true
}

That’s it!

You’ve successfully created an affiliated merchant account and added the associated bank accounts, UBOs, and websites. Next, we will perform checks on the provided information. Once those checks have passed successfully, the newly created account is ready to process payments.

Feedback

Propose a change on GitHubexternal-link-icon or
send an email to [email protected]

Other languages

For an explanation in another language, contact your account manager.