User Tools

Site Tools


Translations of this page:
en:reseller:api:newmerchant

Report a new merchant

This function allows the reporting of a new merchant to GiroSolution AG.

Request

URL: «SERVER»/girocheckout/api/v2/reseller/addmerchant

Name Mandatory Type Description
affiliateId Yes Integer Affiliate-ID from your access data
merchantEmail Yes String(254) Unique E-Mail Address
merchantLanguage Optional String(2) Language for the user interface
de = German (default)
en = English
merchantCompanyType Optional Integer Organization type ID
merchantOrganisationName Yes String(128) Company name
merchantAddress1 Yes String(128) Street and number
merchantAddress2 Optional String(128) Additional address info
merchantPostcode Yes String(128) Postal code
merchantCity Yes String(128) City
merchantCountry Optional String(2) Country code ISO 3166
DE = Germany (default)
merchantUrl Optional String(250) Company Homepage
merchantUstId Optional String(14) VAT-ID with country code
merchantTaxNumber Optional String(20) Tax Number
merchantRegisterNumber Optional String(100) Registry number (e.g. commercial register)
merchantBranche Optional Integer Branch Id
merchantShopsystem Optional Integer Shopsystem Id
personFirstname Yes String(255) First name of the contact person
personLastname Yes String(255) Last name of the contact person
personGender Optional String Gender, possible values:
männlich (male)
weiblich (female)
personEmail Yes String(255) E-Mail Address of the contact person
personPhone1 Optional String(32) Phone number of the contact person
personPhone2 Optional String(32) Additional phone number of the contact person
forecastTxMonth Optional Integer Forecast: Number of transactions per month
forecastTxAverage Optional Integer Forecast: Average shopping cart in EUR
products Optional String Comma separated list of the desired products (see List of payment methods)
Example for giropay, direct debit with locking file and credit card:
1,11,7
giropaypsp Optional Integer PSP ID
salesTag Optional String(255) ID of sales partner
ccTypes Optional String Comma separated list of the desired credit card types. Possible values:
V = Visa
M = Mastercard
A = Amex
Example for Visa and Mastercard: V,M
subId Optional String(50) ID of a sales partner that the new merchant is to be assigned to. These IDs are defined by GiroSolution AG and are only to be used with permission.
hash Yes String(32) HMAC-MD5 check sum

Example

curl -d "affiliateId=350000" \
     -d "merchantEmail=1373527619-test@test.de" \
     -d "merchantLanguage=de" \
     -d "merchantCompanyType=8" \
     -d "merchantOrganisationName=Testfirma" \
     -d "merchantAddress1=Adresse" \
     -d "merchantAddress2=Adresszusatz" \
     -d "merchantPostcode=12345" \
     -d "merchantCity=Musterhausen" \
     -d "merchantCountry=DE" \
     -d "merchantUrl=http://www.testmerchant.de" \
     -d "merchantUstId=UstId 0815" \
     -d "merchantTaxNumber=Steuernummer" \
     -d "merchantRegisterNumber=HRB 4711" \
     -d "merchantBranche=19" \
     -d "merchantShopsystem=606" \
     -d "personFirstname=Max" \
     -d "personLastname=Mustermann" \
     -d "personGender=männlich" \
     -d "personEmail=max.mustermann@test.de" \
     -d "personPhone1=Telefon 1" \
     -d "personPhone2=Telefon 2" \
     -d "forecastTxMonth=10000" \
     -d "forecastTxAverage=150" \
     -d "products=1,11,7" \
     -d "hash=c29656b1648ef7935b3d05a7009116d4" \
     http://dev.girosolution/girocheckout/api/v2/reseller/addmerchant

Response

A JSON object is returned as response.
In case of error, rc contains one of these error codes.
In case of success, rc = 0 and the field merchantId is set.

Example with Success

{
   "merchantId":"12345678",
   "rc":"0",
   "msg":"",
}

Example with Error

{
   "merchantId":"",
   "rc":"5000",
   "msg":"",
}

Appendices

List of organization types

ID Organization type
1 AG
2 e.K. (Eingetragener Kaufmann)
3 eG
4 e.V.
5 Einzelunternehmen
6 GbR
7 GmbH
8 GmbH & Co. KG
9 KG
10 OHG
11 UG
12 Others

Branch List

ID Branch
1 Antiques & Art
2 Audio & Hi-Fi
3 Car & Motorcycle
4 Baby
5 Beauty & Health
6 Books
7 Office supplies & Stationery
8 Business & Industry
10 Gourmets
11 Movies & DVDs
12 Photographic & Camera equipment
13 Garden
14 Mobile phone & Organizers
15 Household appliances
16 Handymen
17 Real Estate
18 Clothing & Accessories
19 Lottery & Bets
20 Furniture & Living
21 Modelling
22 Coins
24 Music
25 Musical instruments
26 Online games
27 PC- & Video games
28 Prepaid
29 Software
30 Toys
31 Sports
32 Tickets
33 Animals
34 TV, Video & Electronics
35 Watches & Jewelry
36 Vacation & Travel
37 - Others -

Shopsystem List

ID Shopsystem Supported?
8363 1&1 E-Shop No
8364 004 Shop-System No
80284 Afterbuy Yes
8365 Awinta Yes
8366 Bigware No
8367 Continue (FUTURE web market) No
8368 DataBecker (shop to date) No
606 Drupal / Ubercart Yes
9154 DR-WebShop Yes
8369 e.pages No
8370 ESHOP2 PRO (econdoo) No
651 Gambio Yes
8371 GlobeCharge No
8372 Hybris No
8373 JTL Shop Yes
650 Magento Yes
8374 Mallux No
8375 Mauve Mailorder Software No
653 modified Shopsoftware (xtcModified)Yes
8376 Mondo Shop No
4730 OpenCart Yes
655 osCommerce 2 Yes
648 OXID eSales Yes
8377 plentymarkets No
658 PrestaShop Yes
5940 SEOshop Yes
8378 ShopFactory No
649 Shopware 3 Yes
6445 Shopware 4 Yes
8379 Shopodia No
8716 Sonstiges Yes
8380 store systems No
8381 Strato-Shop No
8382 SchulverpflegungPlus Yes
654 VirtueMart (Joomla) Yes
8383 Websale No
10771 WooCommerce (Wordpress) Yes
656 xtCommerce 3 Yes
657 xtCommerce 4 / Veyton Yes
8384 Zen Shop No
2032 Own development Yes
8386 GiroSpende Yes

List of payment methods

ID Payment method
1 giropay
2 EPS
4 Käufersiegel
6 Lastschrift (direct debit)
7 Lastschrift mit Sperrdatei (direct debit with lock file)
8 Garantierte Lastschrift (guaranteed direct debit)
11 Credit card
12 iDEAL
14 PayPal
16 giropay-ID
17 giropay-ID + giropay
18 giropay mit Zahlungsbestätigung (giropay with payment confirmation)
19 giropay Spende (giropay donation)
20 GiroCode RE
23 Paydirekt
24 GiroCode QR
25 GiroCode ÜW
26 Blue Code
32 Payment Page
33 Maestro

List of PSPs

ID Description
3752 Adyen
3536 Computop
2307 EOS Payment
2599 Expercash
4 GiroSolution AG
6211 heidelpay
4944 ICEPAY
6212 LogPay
6214 mPay24
4732 Ogone
2469 Omba Pay
5732 PAY.ON
2283 PAYONE
6213 PayUnity
6216 RBS WorldPay
6170 SIX Payment Services
6215 Smart2Pay
6225 Others
3241 TeleCash
2330 VöB ZVD

List of error codes

ID Description
0 OK
5000 Authentication failed
5001 No permission
5002 invalid hash
5003 At least one mandatory field not given
5009 Invalid E-Mail Address
5010 Invalid language
5011 Invalid country
5012 Invalid branch
5013 Invalid shop system
5014 Invalid gender
5015 Invalid product
5016 Invalid organization type
5017 Merchant already exists
5018 Invalid giropay PSP
5019 Invalid Credit card type
9999 Internal error
en/reseller/api/newmerchant.txt · Last modified: 2021/04/12 14:33

Page Tools