Create Merchant

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to The Company

Set the group-level company name / contract owner

string
required
Defaults to HRA 12345

Set the register number (Handelsregisternummer). If the merchant is a small business (Einzelunternehmen) and therefore has no registration number, use "000"

string
required
Defaults to DE123456789

Set the VAT (Umsatzsteuer-ID). If the merchant is a small business (Einzelunternehmen) and therefore has no VAT ID, use "000"

string
enum
required

Set the legal entity

string
required
Defaults to The Company

Set the group-level company tradename

string
enum
Defaults to German

Set your preferred language for business inquiries

Allowed:
string
required
Defaults to Companystreet 102

Set the billing address street

string
required
Defaults to 12345

Set the billing address postalcode

string
required
Defaults to The city

Set the billing address city

string
required
Defaults to DE

Set country code according to ISO Alpha-2 standard. (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

string
enum
required

Set the sales channel. If there are multiple channels you need to create a group for each channel.

Allowed:
string
required
Defaults to 2v&BoUHIm51Z

Your Partner Secret Key provided by your Account Manager. Do not share your Secret Key.

string
required
Defaults to 3f6425cc-57a7-11ec-9b1c-00505697b23f

Your Sugar CRM Partner ID provided by your Account Manager.

string
required
Defaults to 3f6425cc-57a7-11ec-9b1c-00505697b23f

The partner ID is used to link an external Sales Partner to a group.

icc_contacts
array of objects
required

You can add multiple contacts

icc_contacts*
icc_bankaccount
array of objects
required

You can only add one bankaccount

icc_bankaccount*
icc_terminals
array of objects

Needs to be added if the sales channel is "pos". You can add multiple terminals

icc_terminals
icc_opportunity
array of objects
required

You can add only one opportunity

icc_opportunity*
icc_group_members
array of objects
required

You have to create at least one member to your group. You can also add multiple members.

icc_group_members*
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json