Create a merchant account


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

  1. Signup account: create a new merchant account
  2. List accounts: retrieve a list of all merchant accounts
  3. Get account: retrieve a single merchant account
  4. Update account: update a merchant account

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 perform our know your customer checks, we may need optional parameters to be supplied.

Authentication

All four account requests require a partner account API key. This is not the same as a website 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.


Signup account

POST https://testapi.multisafepay.com/v1/json/signup-account

Create a new affiliated merchant account.

Query parameters

Key Description
account
object
This object holds company information
account.address1
string
First line of company address
Format: max 64 characters. Optional.
account.address2
string
Second line of company address
Format: max 64 characters. Optional.
account.address3
string
Third line of company address
Format: max 64 characters. Optional.
account.apartment
string
Apartment number of company address
Format: max 9 characters. Optional.
account.city
string
City of company address
Format: max 50 characters Optional.
account.coc_number
string
Chamber of commerce number
Format: max 50 characters. Optional.
account.company_name
string
Name of company
Format: max 200 characters. Required.
account.country
string
Country code of company
Format: ISO 3166-1 alpha-2 (e.g., NL). Required.
account.email
string
Company email address. Transaction updates are sent to this address.
Format: max 100 characters. Required.
account.fax
string
Company fax number
Format: max 15 characters. Optional.
account.phone
string
Company phone number
Format: max 15 characters. Optional.
account.vat_number
string
Company VAT number
Format: max 50 characters. Optional.
account.zipcode
string
Company ZIP Code
Format: max 30 characters. Optional.
user
object
This object holds user information
user.name
string
Full name of the primary user. The name can be modified later. Required.
user.email
string
Email address of the primary user. The welcome email with secure code is sent to this address. Required.
user.password
string
Password of the primary user. Required.
currencies
array
List of currencies the company wishes to process
Format: array of strings in ISO-4217 format (e.g., [EUR,USD]). Required.
Sample request
curl -X POST "https://testapi.multisafepay.com/v1/json/signup-account" \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "api_key: <your-account-api-key>" \
--data-raw '{
  "account": {
    "address1": "Flowerstreet 123",
    "address2": "",
    "address3": "",
    "apartment": "5A",
    "city": "Amsterdam",
    "coc_number": "123456",
    "company_name": "Fun B.V.",
    "country": "NL",
    "email": "[email protected]",
    "fax": "00311234567890",
    "phone": "00311234567890",
    "vat_number": "NL999999999B99",
    "zipcode": "1234 ZP"
  },
  "user": {
    "name": "Ad Admin",
    "email": "[email protected]",
    "password": "password"
  },
  "currencies": [
    "EUR"
  ]
}'
Sample response
{
  "data": {
    "account": {
      "address1": "Flowerstreet 123",
      "address2": "",
      "address3": "",
      "apartment": "5A",
      "city": "Amsterdam",
      "coc_number": "123456",
      "company_name": "Fun B.V.",
      "country": "NL",
      "email": "[email protected]",
      "fax": "00311234567890",
      "id": 12345678,
      "phone": "00311234567890",
      "vat_number": "NL999999999B99",
      "zipcode": "1234 ZP"
    },
    "user": {
      "name": "Ad Admin",
      "email": "[email protected]",
      "password": "***"
    },
    "currencies": [
      "EUR"
    ]
  },
  "success": true
}

account.id → the account ID


List accounts

GET https://testapi.multisafepay.com/v1/json/accounts

Retrieve an array of all merchant accounts affiliated to your partner account.

Parameters

This request doesn’t require any parameters.

Sample request
curl -X GET "https://testapi.multisafepay.com/v1/json/accounts" \
--header "accept: application/json" \
--header "api_key: <your-account-api-key>"

Sample response
{
  "data": [
    {
      "address1": "Flowerstreet 123",
      "address2": "",
      "address3": "",
      "apartment": "5A",
      "city": "Funtown",
      "coc_number": "123456",
      "company_name": "Fun B.V.",
      "country": "NL",
      "email": "[email protected]",
      "fax": "00311234567890",
      "id": "12345678",
      "phone": "00311234567890",
      "vat_number": "NL999999999B99",
      "zipcode": "1234 ZP"
    }
  ],
  "success": true
}

account.id → the account ID


Get account

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

Retrieve the account details of a specific affiliated merchant account.

Path parameters

Parameter 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" \
--header "accept: application/json" \
--header "api_key: <your-account-api-key>"

Sample response
{
  "data": {
    "address1": "Flowerstreet 123",
    "address2": "",
    "address3": "",
    "apartment": "5A",
    "city": "Funtown",
    "coc_number": "123456",
    "company_name": "Fun B.V.",
    "country": "NL",
    "email": "[email protected]",
    "fax": "00311234567890",
    "id": "12345678",
    "phone": "00311234567890",
    "vat_number": "NL999999999B99",
    "zipcode": "1234 ZP"
  },
  "success": true
}

id → the account ID


Update account

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

Update the account details of an affiliated merchant account.

Path parameters

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

Query parameters

Key Description
address1
string
First line of company address
Format: max 64 characters. Optional.
address2
string
Second line of company address
Format: max 64 characters. Optional.
address3
string
Third line of company address
Format: max 64 characters. Optional.
apartment
string
Apartment number of company address
Format: max 9 characters. Optional.
city
string
City of company address
Format: max 50 characters Optional.
coc_number
string
Chamber of commerce number
Format: max 50 characters. Optional.
company_name
string
Name of company
Format: max 200 characters. Optional.
country
string
Country code of company
Format: ISO 3166-1 alpha-2 (e.g., NL). Optional.
email
string
Company email address
Format: max 100 characters. Optional.
fax
string
Company fax number
Format: max 15 characters. Optional.
phone
string
Company phone number
Format: max 15 characters. Optional.
vat_number
string
Company VAT number
Format: max 50 characters. Optional.
zipcode
string
Company ZIP Code
Format: max 30 characters. Optional.
Sample request
curl -X PATCH "https://testapi.multisafepay.com/v1/json/accounts/12345678" \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "api_key: <your-account-api-key>" \
--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": "Fun B.V.",
    "country": "NL",
    "email": "[email protected]",
    "fax": "00311234567890",
    "id": "12345678",
    "phone": "00311234567890",
    "vat_number": "NL999999999B99",
    "zipcode": "5678 NW"
  },
  "success": true
}

id → the account ID


Next steps

You have successfully created a merchant account. Now, you can add bank accounts, UBOs, and websites, using the unique 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.