Add websites


Use the following requests to add, retrieve or update websites linked to a merchant account affiliated with your partner account:

  1. Add a website: Add a website to a merchant account.
  2. List websites: Retrieve all websites for a merchant account.
  3. Get website: Retrieve a single website by its identifier.
  4. Update website: Update a website.

About parameters

For every parameter, we specify whether it’s required or optional. However, this label refers only to the technical requirements for valid API requests. To process credit card transactions with the website API key, expected minimum and maximum order values need to be supplied. Furthermore, the notification URL is required to receive transaction status updates. However, this information may also be provided at a later time.

Authentication

All four 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/{account_id}/sites

Add a website to an affiliated merchant account.

Path parameters

Key Description
account_id
string
account ID.
Format: 8 character string (e.g., 12345678). Required.

Query parameters

Key Description
name
string
Name of the website.
Format: max 120 characters. Required.
URL
string
URL of the website.
Format: URL (max 150 characters). Required..
notification_url
string
Notification URL of the website.
Format: URL (max 150 characters). Optional.
price_from
integer
Expected minimum order value for credit card transactions.
Format: unsigned integer. Optional.
price_till
integer
Expected maximum order value for credit card transactions.
Format: unsigned integer. Optional.
support_email
string
Email address used to support the website’s customers.
Format: email address (max 100 characters). Optional.
support_phone
string
Phone number used to support the website’s customers.
Format: phone number (max 100 characters). Optional.
Sample request
curl -X POST "https://testapi.multisafepay.com/v1/json/accounts/12345678/sites" \
--header "accept: application/json" 
--header "Content-Type: application/json" \
--header "api_key: <your-account-api-key>" \
--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": 12345678,
    "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
}

account_id → the account ID of the associated merchant account
api_key → the API key of the linked website
id → the site ID of the linked website


List websites

GET https://testapi.multisafepay.com/v1/json/accounts/{account_id}/sites

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

Path parameters

Key Description
account_id
string
Merchant ID.
Format: 8 character string (e.g., 12345678). Required.
Sample request
curl -X GET "https://testapi.multisafepay.com/v1/json/accounts/12345678/sites" \
--header "accept: application/json" \
--header "api_key: <your-account-api-key>" 
Sample response
{
  "data": [
    {
      "account_id": 12345678,
      "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
}

account_id → the account ID of the associated merchant account
api_key → the API key of the linked website
id → the site ID of the linked website


Get website

GET https://testapi.multisafepay.com/v1/json/sites/{site_id}

Retrieve a single website by its identifier.

Path parameters

Key Description
site_id
string
Site ID.
Format: 5 character string (e.g., 12345). Required.
Sample request
curl -X GET "https://testapi.multisafepay.com/v1/json/accounts/sites/12345" \
--header "accept: application/json" \
--header "api_key: <your-account-api-key>" 
Sample response
{
  "data": {
    "account_id": 12345678,
    "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
}

account_id → the account ID of the associated merchant account
api_key → the API key of the linked website
id → the site ID of the linked website


Update website

PATCH https://testapi.multisafepay.com/v1/json/sites/{site_id}

Update information about an existing website.

Path parameters

Key Description
account_id
string
Merchant ID.
Format: 8 character string (e.g., 12345678). Required.

Query parameters

Key Description
name
string
Name of the website.
Format: max 120 characters. Optional.
URL
string
URL of the website.
Format: URL (max 150 characters). Optional.
notification_url
string
Notification URL of the website.
Format: URL (max 150 characters). Optional.
price_from
integer
Expected minimum order value for credit card transactions.
Format: unsigned integer. Optional.
price_till
integer
Expected maximum order value for credit card transactions.
Format: unsigned integer. Optional.
support_email
string
Email address used to support the website’s customers.
Format: email address (max 100 characters). Optional.
support_phone
string
Phone number used to support the website’s customers.
Format: phone number (max 100 characters). Optional.
Sample request
curl -X PATCH "https://testapi.multisafepay.com/v1/json/sites/12345" \
--header "accept: application/json" \
--header "api_key: <your-account-api-key>" \
--header "Content-Type: application/json" \
--data-raw '{
  "notification_url": "https://funcompany.com/newhook"
}'
Sample response
{
  "data": {
    "account_id": 12345678,
    "api_key": "4192937dffd72a34bcaef4e4f589beb74188d0fa",
    "id": 12345,
    "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
}

account_id → the account ID of the associated merchant account
api_key → the API key of the linked website
id → the site ID of the linked website


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 been 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.