Create a merchant account


Use the following requests to create, retrieve or update affiliated merchant accounts:

Authentication

All of the account requests require a partner account API key. This is not the same as a site 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 testapi to api and use the corresponding API key.


Sign up account

POST https://testapi.multisafepay.com/v1/json/signup-account?api_key={your-account-api-key}

Create a new affiliated merchant account.

Request body parameters
Parameter Description
account
object
Contains company information.
account.address1 string The first line of the company address.
Format: Max 64 characters. Optional.
account.address2
string
The second line of the company address.
Format: Max 64 characters. Optional.
account.address3
string
The third line of the company address.
Format: Max 64 characters. Optional.
account.apartment
string
The apartment number of the company address.
Format: Max 9 characters. Optional.
account.city
string
The city of the company address.
Format: Max 50 characters Optional.
account.coc_number
string
The company’s chamber of commerce number.
Format: Max 50 characters. Optional.
account.company_name
string
The unique company name.
Format: Max 200 characters. Required.
account.country
string
The country code of the company
Format: ISO 3166-1 alpha-2, e.g. NL. Required.
account.email
string
The unique company email address to which transaction updates are sent.
Format: Max 100 characters. Required.
account.fax
string
The company’s fax number.
Format: Max 15 characters. Optional.
account.phone
string
The company’s phone number.
Format: Max 15 characters. Optional.
account.vat_number
string
The company’s VAT number.
Format: Max 50 characters. Optional.
account.zipcode
string
The company’s ZIP code.
Format: Max 30 characters. Optional.
user
object
Contains user information.
user.name
string
The full name of the primary user (can be modified later). Required.
user.email
string
The primary user’s unique email address to which the welcome email containing the secure code is sent. Required.
user.password
string
The primary user’s password. Required.
currencies
array
The list of currencies the company wants to process.
Format: Array of strings in ISO-4217 format, e.g. [EUR,USD]. Required.
Response body parameters

The following are in addition to the request body parameters.

Parameter Description
id
string
The affiliated merchant ID. Referred to as {account_id}.
Sample request
curl -X POST "https://testapi.multisafepay.com/v1/json/signup-account?api_key={your-account-api-key}" \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--data-raw '{
  "account": {
    "address1": "Flowerstreet 123",
    "address2": "",
    "address3": "",
    "apartment": "5A",
    "city": "Amsterdam",
    "coc_number": "123456",
    "company_name": "{affiliate-company-name}",
    "country": "NL",
    "email": "{affiliate-email-address}",
    "fax": "00311234567890",
    "phone": "00311234567890",
    "vat_number": "NL999999999B99",
    "zipcode": "1234 ZP"
  },
  "user": {
    "name": "Ad Admin",
    "email": "{affiliate-email-address}",
    "password": "password"
  },
  "currencies": [
    "EUR"
  ]
}'
Sample response
{
  "data": {
    "account": {
      "address1": "Flowerstreet 123",
      "address2": "",
      "address3": "",
      "apartment": "5A",
      "city": "Amsterdam",
      "coc_number": "123456",
      "company_name": "{affiliate-company-name},
      "country": "NL",
      "email": "{affiliate-email-address}",
      "fax": "00311234567890",
      "id": 12345678,
      "phone": "00311234567890",
      "vat_number": "NL999999999B99",
      "zipcode": "1234 ZP"
    },
    "user": {
      "name": "Ad Admin",
      "email": "{affiliate-email-address}",
      "password": "***"
    },
    "currencies": [
      "EUR"
    ]
  },
  "success": true
}

List accounts

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

Retrieve an array of all affiliated merchant accounts.

Response body parameters
Parameter Description
address1 string The first line of the company address.
Format: Max 64 characters.
address2
string
The second line of the company address.
Format: Max 64 characters.
address3
string
The third line of the company address.
Format: Max 64 characters.
apartment
string
The apartment number of the company address.
Format: Max 9 characters.
city
string
The city of the company address.
Format: Max 50 characters.
coc_number
string
The company’s chamber of commerce number.
Format: Max 50 characters.
company_name
string
The unique company name.
Format: Max 200 characters.
country
string
The country code of the company
Format: ISO 3166-1 alpha-2, e.g. NL.
email
string
The unique company email address to which transaction updates are sent.
Format: Max 100 characters.
fax
string
The company’s fax number.
Format: Max 15 characters.
id
string
The affiliated merchant ID. Referred to as {account_id}.
phone
string
The company’s phone number.
Format: Max 15 characters.
vat_number
string
The company’s VAT number.
Format: Max 50 characters.
zipcode
string
The company’s ZIP code.
Format: Max 30 characters.
Sample request
curl -X GET "https://testapi.multisafepay.com/v1/json/accounts?api_key={your-account-api-key}" \
--header "accept: application/json" \

Sample response
{
  "data": [
    {
      "address1": "Flowerstreet 123",
      "address2": "",
      "address3": "",
      "apartment": "5A",
      "city": "Funtown",
      "coc_number": "123456",
      "company_name": "{affiliate-company-name}",
      "country": "NL",
      "email": "{affiliate-email-address}",
      "fax": "00311234567890",
      "id": "12345678",
      "phone": "00311234567890",
      "vat_number": "NL999999999B99",
      "zipcode": "1234 ZP"
    }
  ],
  "success": true
}

Get account

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

Retrieve the account details of a specific affiliated merchant account.

Path parameters

Parameter Description
account_id
string
The affiliated merchant ID.
Format: 8 character string, e.g. 12345678. Required.
Response body parameters
Parameter Description
address1 string The first line of the company address.
Format: Max 64 characters.
address2
string
The second line of the company address.
Format: Max 64 characters.
address3
string
The third line of the company address.
Format: Max 64 characters.
apartment
string
The apartment number of the company address.
Format: Max 9 characters.
city
string
The city of the company address.
Format: Max 50 characters.
coc_number
string
The company’s chamber of commerce number.
Format: Max 50 characters.
company_name
string
The unique company name.
Format: Max 200 characters.
country
string
The country code of the company
Format: ISO 3166-1 alpha-2, e.g. NL.
email
string
The unique company email address to which transaction updates are sent.
Format: Max 100 characters.
fax
string
The company’s fax number.
Format: Max 15 characters.
id
string
The affiliated merchant ID. Referred to as {account_id}.
phone
string
The company’s phone number.
Format: Max 15 characters.
vat_number
string
The company’s VAT number.
Format: Max 50 characters.
zipcode
string
The company’s ZIP code.
Format: Max 30 characters.
Sample request
curl -X GET "https://testapi.multisafepay.com/v1/json/accounts/{affiliate_account_id}?api_key={your-account-api-key}" \
--header "accept: application/json" \

Sample response
{
  "data": {
    "address1": "Flowerstreet 123",
    "address2": "",
    "address3": "",
    "apartment": "5A",
    "city": "Funtown",
    "coc_number": "123456",
    "company_name": "{affiliate-company-name}",
    "country": "NL",
    "email": "{affiliate-email-address}",
    "fax": "00311234567890",
    "id": "12345678",
    "phone": "00311234567890",
    "vat_number": "NL999999999B99",
    "zipcode": "1234 ZP"
  },
  "success": true
}

Update account

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

Update the account details of an affiliated merchant account.

Path parameters

Parameter Description
account_id
string
The affiliated merchant ID.
Format: 8 character string (e.g., 12345678). Required.
Request body parameters
Parameter Description
address1 string The first line of the company address.
Format: Max 64 characters. Optional.
address2
string
The second line of the company address.
Format: Max 64 characters. Optional.
address3
string
The third line of the company address.
Format: Max 64 characters. Optional.
apartment
string
The apartment number of the company address.
Format: Max 9 characters. Optional.
city
string
The city of the company address.
Format: Max 50 characters. Optional.
coc_number
string
The company’s chamber of commerce number.
Format: Max 50 characters. Optional.
company_name
string
The unique company name.
Format: Max 200 characters. Optional.
country
string
The country code of the company
Format: ISO 3166-1 alpha-2, e.g. NL. Optional.
email
string
The unique company email address to which transaction updates are sent.
Format: Max 100 characters. Optional.
fax
string
The company’s fax number.
Format: Max 15 characters. Optional.
phone
string
The company’s phone number.
Format: Max 15 characters. Optional.
vat_number
string
The company’s VAT number.
Format: Max 50 characters. Optional.
zipcode
string
The company’s ZIP code.
Format: Max 30 characters. Optional.
Response body parameters
Parameter Description
address1 string The first line of the company address.
Format: Max 64 characters.
address2
string
The second line of the company address.
Format: Max 64 characters.
address3
string
The third line of the company address.
Format: Max 64 characters.
apartment
string
The apartment number of the company address.
Format: Max 9 characters.
city
string
The city of the company address.
Format: Max 50 characters.
coc_number
string
The company’s chamber of commerce number.
Format: Max 50 characters.
company_name
string
The unique company name.
Format: Max 200 characters.
country
string
The country code of the company
Format: ISO 3166-1 alpha-2, e.g. NL.
email
string
The unique company email address to which transaction updates are sent.
Format: Max 100 characters.
fax
string
The company’s fax number.
Format: Max 15 characters.
id
string
The affiliated merchant ID. Referred to as {account_id}.
phone
string
The company’s phone number.
Format: Max 15 characters.
vat_number
string
The company’s VAT number.
Format: Max 50 characters.
zipcode
string
The company’s ZIP code.
Format: Max 30 characters.
Sample request
curl -X PATCH "https://testapi.multisafepay.com/v1/json/accounts/{affiliate_account_id}?api_key={your-account-api-key}" \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--data-raw '{
  "email" :"[email protected]",
  "zipcode" :"5678 NW"
}'
Sample response
{
  "data": {
    "address1": "Flowerstreet 123",
    "address2": "",
    "address3": "",
    "apartment": "5A",
    "city": "Funtown",
    "coc_number": "123456",
    "company_name": "{affiliate-company-name}",
    "country": "NL",
    "email": "[email protected]",
    "fax": "00311234567890",
    "id": "12345678",
    "phone": "00311234567890",
    "vat_number": "NL999999999B99",
    "zipcode": "5678 NW"
  },
  "success": true
}

Next steps

You have successfully created a merchant account. Now, you can add bank accounts, UBOs, and websites, using the affiliated merchant account ID.

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.