User Tools

Site Tools


en:reseller:api:newmerchant

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
en:reseller:api:newmerchant [2016/03/29 09:18]
michaelheumann created
en:reseller:api:newmerchant [2021/04/12 14:33] (current)
Line 1: Line 1:
-====== Neuen Händler melden ====== +====== Report a new merchant ====== 
-Mit dieser Funktion kann ein neuer Händler an die GiroSolution AG gemeldet werden.+This function allows the reporting of a new merchant to GiroSolution AG.
  
-==== Anfrage ====+==== Request ====
 **URL:** <<SERVER>>/girocheckout/api/v2/reseller/addmerchant **URL:** <<SERVER>>/girocheckout/api/v2/reseller/addmerchant
-^Name                     ^Pflicht  ^Type        ^Beschreibung   ^ +^Name                     ^Mandatory  ^Type        ^Description   ^ 
-|affiliateId              |Ja       |Integer     |Affiliate-ID aus den Zugangsdaten +|affiliateId              |Yes       |Integer     |Affiliate-ID from your access data 
-|merchantEmail            |Ja       |String(254) |Eindeutige E-Mail Adresse +|merchantEmail            |Yes       |String(254) |Unique E-Mail Address 
-|merchantLanguage         |Optional |String(2)   |Sprache für die Oberfläche\\ de = deutsch (default)\\ en = englisch+|merchantLanguage         |Optional |String(2)   |Language for the user interface\\ de = German (default)\\ en = English
-|merchantCompanyType      |Optional |Integer     |[[#liste_der_organisationstypen|Id des Organisationstypes]] | +|merchantCompanyType      |Optional |Integer     |[[#List_of_organization_types|Organization type ID]] | 
-|merchantOrganisationName |Ja       |String(128) |Firmenname +|merchantOrganisationName |Yes       |String(128) |Company name 
-|merchantAddress1         |Ja       |String(128) |Straße und Hausnummer +|merchantAddress1         |Yes       |String(128) |Street and number 
-|merchantAddress2         |Optional |String(128) |Adresszusatz +|merchantAddress2         |Optional |String(128) |Additional address info 
-|merchantPostcode         |Ja       |String(128) |Postleitzahl +|merchantPostcode         |Yes       |String(128) |Postal code 
-|merchantCity             |Ja       |String(128) |Ort +|merchantCity             |Yes       |String(128) |City 
-|merchantCountry          |Optional |String(2)   |Ländercode ISO 3166\\ DE = Deutschland (default) | +|merchantCountry          |Optional |String(2)   |Country code ISO 3166\\ DE = Germany (default) | 
-|merchantUrl              |Optional |String(250) |Homepage des Unternehmens +|merchantUrl              |Optional |String(250) |Company Homepage | 
-|merchantUstId            |Optional |String(14)  |Umsatzsteuer-ID mit Ländercode +|merchantUstId            |Optional |String(14)  |VAT-ID with country code 
-|merchantTaxNumber        |Optional |String(20)  |Steuernummer +|merchantTaxNumber        |Optional |String(20)  |Tax Number 
-|merchantRegisterNumber   |Optional |String(100) |Registernummer (z.BHandelsregister) | +|merchantRegisterNumber   |Optional |String(100) |Registry number (e.gcommercial register) | 
-|merchantBranche          |Optional |Integer     |[[#liste_der_branchen|Id der Branche]]| +|merchantBranche          |Optional |Integer     |[[#branch_list|Branch Id]]| 
-|merchantShopsystem       |Optional |Integer     |[[#liste_der_shopsysteme|Id des Shopsystems]]| +|merchantShopsystem       |Optional |Integer     |[[#shopsystem_list|Shopsystem Id]]| 
-|personFirstname          |Ja       |String(255) |Vorname des Ansprechpartners +|personFirstname          |Yes       |String(255) |First name of the contact person 
-|personLastname           |Ja       |String(255) |Nachname des Anpsrechpartners +|personLastname           |Yes       |String(255) |Last name of the contact person 
-|personGender             |Optional |String      |Mögliche Werte:\\ männlich\\ weiblich| +|personGender             |Optional |String      |Gender, possible values: \\ männlich (male)\\ weiblich (female)
-|personEmail              |Ja       |String(255) |E-Mail Adresse des Anpsrechpartners +|personEmail              |Yes      |String(255) |E-Mail Address of the contact person 
-|personPhone1             |Optional |String(32)  |Telefonnummer des Ansprechpartners +|personPhone1             |Optional |String(32)  |Phone number of the contact person 
-|personPhone2             |Optional |String(32)  |Zusätzliche Telefonnummer des Ansprechpartners +|personPhone2             |Optional |String(32)  |Additional phone number of the contact person 
-|forecastTxMonth          |Optional |Integer     |Anzahl Transaktionen im Monat +|forecastTxMonth          |Optional |Integer     |Forecast: Number of transactions per month 
-|forecastTxAverage        |Optional |Integer     |Dutchschnittlicher Warenkorbin EUR | +|forecastTxAverage        |Optional |Integer     |Forecast: Average shopping cart in EUR | 
-|products                 |Optional |String      |Kommaseparierte List der gewünschten Produkte (siehe [[#liste_der_zahlungsmethoden|Liste der Zahlungsmethoden]])\\ Beispiel für giropay, Lastschrift mit Sperrdatei und Kreditkarte:\\ 1,11,7 | +|products                 |Optional |String      |Comma separated list of the desired products (see [[#list_of_payment_methods|List of payment methods]])\\ Example for giropay, direct debit with locking file and credit card:\\ 1,11,7 | 
-|giropaypsp               |Optional |Integer     |[[#liste_der_psps|Id des PSP]]| +|giropaypsp               |Optional |Integer     |[[#list_of_psps|PSP ID]]| 
-|salesTag                 |Optional |String(255) |Vertriebspartner-Kennzeichen +|salesTag                 |Optional |String(255) |ID of sales partner 
-|ccTypes                  |Optional |String      |Kommaseparierte List der gewünschten KreditkartentypenMögliche Werte:\\ V = Visa \\ M = Mastercard \\ A = Amex \\ Beispiel für Visa und Mastercard: V,M| +|ccTypes                  |Optional |String      |Comma separated list of the desired credit card typesPossible values:\\ V = Visa \\ M = Mastercard \\ A = Amex \\ Example for Visa and Mastercard: V,M| 
-|subId                    |Optional |String(50)  |Kennzeichen eines Vertriebspartners, dem der neue Händler zugeordnet werden sollDie Kennzeichen werden von der GiroSolution AG vergeben und sind nur nach Rücksprache zu verwenden. | +|subId                    |Optional |String(50)  |ID of a sales partner that the new merchant is to be assigned toThese IDs are defined by GiroSolution AG and are only to be used with permission. | 
-|hash                     |Ja       |String(32)  |HMAC-MD5 Checksumme |+|hash                     |Yes       |String(32)  |HMAC-MD5 check sum |
  
-=== Beispiel ===+=== Example ===
 <code> <code>
 curl -d "affiliateId=350000" \ curl -d "affiliateId=350000" \
Line 67: Line 67:
 </code> </code>
  
-==== Antwort ==== +==== Response ==== 
-Als Antwort wird ein JSON Objekt zurückgeliefert.\\ +JSON object is returned as response.\\ 
-Im Fehlerfall enthält rc einen dieser [[#liste_der_fehlercodes|Fehlercodes]].\\ +In case of error, rc contains one of these [[#list_of_error_codes|error codes]].\\ 
-Im Erfolgsfall is rc = 0 und das Feld merchantId ist gesetzt.+In case of success, rc = 0 and the field merchantId is set.
  
-=== Beispiel bei Erfolg ===+=== Example with Success ===
  
 <code> <code>
Line 82: Line 82:
 </code> </code>
  
-=== Beispiel bei Fehler ===+=== Example with Error ===
  
 <code> <code>
Line 91: Line 91:
 } }
 </code> </code>
-====== Anlagen ====== 
  
-==== Liste der Organisationstypen ==== +====== Appendices ====== 
-^ID          ^Organisationstyp              ^+ 
 +==== List of organization types ==== 
 +^ID          ^Organization type             ^
 |1           |AG                            | |1           |AG                            |
 |2           |e.K. (Eingetragener Kaufmann) | |2           |e.K. (Eingetragener Kaufmann) |
Line 106: Line 107:
 |10          |OHG                           | |10          |OHG                           |
 |11          |UG                            | |11          |UG                            |
-|12          |Sonstige                      |+|12          |Others                        |
  
-==== Liste der Branchen ==== +==== Branch List ==== 
-^ID          ^Branche                    +^ID          ^Branch                     
-|1           |Antiquitäten Kunst       |+|1           |Antiques Art             |
 |2           |Audio & Hi-Fi              | |2           |Audio & Hi-Fi              |
-|3           |Auto Motorrad            |+|3           |Car Motorcycle           |
 |4           |Baby                       | |4           |Baby                       |
-|5           |Beauty & Gesundheit        +|5           |Beauty & Health            
-|6           |Bücher                     +|6           |Books                      
-|7           |Büro Schreibwaren        | +|7           |Office supplies Stationery        | 
-|8           |Business & Industrie       +|8           |Business & Industry        
-|10          |Feinschmecker              +|10          |Gourmets                   
-|11          |Filme & DVDs               +|11          |Movies & DVDs              
-|12          |Foto Camcorder           +|12          |Photographic Camera equipment     
-|13          |Garten                     | +|13          |Garden                     | 
-|14          |Handy Organizer          +|14          |Mobile phone Organizers  
-|15          |Haushaltsgeräte            +|15          |Household appliances       
-|16          |Heimwerker                 +|16          |Handymen                   
-|17          |Immobilien                 +|17          |Real Estate                
-|18          |Kleidung Accessoires     | +|18          |Clothing Accessories     | 
-|19          |Lotterien Wetten         +|19          |Lottery Bets             
-|20          |Möbel Wohnen             +|20          |Furniture Living         
-|21          |Modellbau                  | +|21          |Modelling                  | 
-|22          |Münzen                     +|22          |Coins                      
-|24          |Musik                      | +|24          |Music                      | 
-|25          |Musikinstrumente           +|25          |Musical instruments        
-|26          |Onlinespiele               | +|26          |Online games               | 
-|27          |PC- & Videospiele          |+|27          |PC- & Video games          |
 |28          |Prepaid                    | |28          |Prepaid                    |
 |29          |Software                   | |29          |Software                   |
-|30          |Spielzeug                  +|30          |Toys                       
-|31          |Sport                      |+|31          |Sports                     |
 |32          |Tickets                    | |32          |Tickets                    |
-|33          |Tierwelt                   +|33          |Animals                    
-|34          |TV, Video & Elektronik     +|34          |TV, Video & Electronics    
-|35          |Uhren Schmuck            +|35          |Watches Jewelry          
-|36          |Urlaub Reisen            +|36          |Vacation Travel          
-|37          |- Sonstige               |+|37          |- Others                 |
  
-==== Liste der Shopsysteme ==== +==== Shopsystem List ==== 
-^ID          ^Shopsystem                   ^Unterstützt? ^ +^ID          ^Shopsystem                   ^Supported? ^ 
-|8363        |1&1 E-Shop                   |Nein +|8363        |1&1 E-Shop                   |No 
-|8364        |004 Shop-System              |Nein +|8364        |004 Shop-System              |No | 
-|8365        |Awinta                       |Ja +|80284       |Afterbuy                     |Yes 
-|8366        |Bigware                      |Nein +|8365        |Awinta                       |Yes 
-|8367        |Continue (FUTURE web market) |Nein +|8366        |Bigware                      |No 
-|8368        |DataBecker (shop to date)    |Nein +|8367        |Continue (FUTURE web market) |No 
-|606         |Drupal / Ubercart            |Ja +|8368        |DataBecker (shop to date)    |No 
-|9154        |DR-WebShop                   |Ja +|606         |Drupal / Ubercart            |Yes 
-|8369        |e.pages                      |Nein +|9154        |DR-WebShop                   |Yes 
-|8370        |ESHOP2 PRO (econdoo)         |Nein +|8369        |e.pages                      |No 
-|651         |Gambio                       |Ja +|8370        |ESHOP2 PRO (econdoo)         |No 
-|8371        |GlobeCharge                  |Nein +|651         |Gambio                       |Yes 
-|8372        |Hybris                       |Nein +|8371        |GlobeCharge                  |No 
-|8373        |JTL Shop                     |Ja +|8372        |Hybris                       |No 
-|650         |Magento                      |Ja +|8373        |JTL Shop                     |Yes 
-|8374        |Mallux                       |Nein +|650         |Magento                      |Yes 
-|8375        |Mauve Mailorder Software     |Nein +|8374        |Mallux                       |No 
-|8376        |Mondo Shop                   |Nein +|8375        |Mauve Mailorder Software     |No | 
-|4730        |OpenCart                     |Ja +|653         |modified Shopsoftware (xtcModified)|Yes 
-|655         |osCommerce 2                 |Ja +|8376        |Mondo Shop                   |No 
-|648         |OXID eSales                  |Ja +|4730        |OpenCart                     |Yes 
-|8377        |plentymarkets                |Nein +|655         |osCommerce 2                 |Yes 
-|658         |PrestaShop                   |Ja +|648         |OXID eSales                  |Yes 
-|5940        |SEOshop                      |Ja +|8377        |plentymarkets                |No 
-|8378        |ShopFactory                  |Nein +|658         |PrestaShop                   |Yes 
-|649         |Shopware 3                   |Ja +|5940        |SEOshop                      |Yes 
-|6445        |Shopware 4                   |Ja +|8378        |ShopFactory                  |No 
-|8379        |Shopodia                     |Nein +|649         |Shopware 3                   |Yes 
-|8716        |Sonstiges                    |Ja +|6445        |Shopware 4                   |Yes 
-|8380        |store systems                |Nein +|8379        |Shopodia                     |No 
-|8381        |Strato-Shop                  |Nein +|8716        |Sonstiges                    |Yes 
-|8382        |SchulverpflegungPlus         |Ja +|8380        |store systems                |No 
-|654         |VirtueMart (Joomla)          |Ja +|8381        |Strato-Shop                  |No 
-|8383        |Websale                      |Nein +|8382        |SchulverpflegungPlus         |Yes 
-|653         |modified Shopsoftware (xtcModified)|Ja +|654         |VirtueMart (Joomla)          |Yes 
-|656         |xtCommerce 3                 |Ja +|8383        |Websale                      |No 
-|657         |xtCommerce 4 / Veyton        |Ja +|10771       |WooCommerce (Wordpress     |Yes 
-|8384        |Zen Shop                     |Nein +|656         |xtCommerce 3                 |Yes 
-|2032        |Eigenentwicklung             |Ja +|657         |xtCommerce 4 / Veyton        |Yes 
-|8386        |GiroSpende                   |Ja |+|8384        |Zen Shop                     |No 
 +|2032        |Own development              |Yes 
 +|8386        |GiroSpende                   |Yes |
  
-==== Liste der Zahlungsmethoden ==== +==== List of payment methods ==== 
-^ID          ^Zahlungsmethode            ^+^ID          ^Payment method             ^
 |1           |giropay                    | |1           |giropay                    |
 |2           |EPS                        | |2           |EPS                        |
 |4           |Käufersiegel               | |4           |Käufersiegel               |
-|6           |Lastschrift                +|6           |Lastschrift  (direct debit)              
-|7           |Lastschrift mit Sperrdatei | +|7           |Lastschrift mit Sperrdatei (direct debit with lock file) 
-|8           |Garantierte Lastschrift    +|8           |Garantierte Lastschrift (guaranteed direct debit)   
-|11          |Kreditkarte                |+|11          |Credit card                |
 |12          |iDEAL                      | |12          |iDEAL                      |
 |14          |PayPal                     | |14          |PayPal                     |
 |16          |giropay-ID                 | |16          |giropay-ID                 |
 |17          |giropay-ID + giropay       | |17          |giropay-ID + giropay       |
-|18          |giropay mit Zahlungsbestätigung | +|18          |giropay mit Zahlungsbestätigung (giropay with payment confirmation) 
-|19          |giropay Spende             +|19          |giropay Spende (giropay donation)            
-|20          |GiroCode Premium           |+|20          |GiroCode RE                |
 |23          |Paydirekt                  | |23          |Paydirekt                  |
-|24          |GiroCode Basic             +|24          |GiroCode QR                
-|25          |GiroCode Klassic           |+|25          |GiroCode ÜW                |
 |26          |Blue Code                  | |26          |Blue Code                  |
-==== Liste der PSPs ==== +|32          |Payment Page               | 
-^ID          ^Beschreibung               ^+|33          |Maestro                    | 
 +==== List of PSPs ==== 
 +^ID          ^Description                ^
 |3752        |Adyen                      | |3752        |Adyen                      |
 |3536        |Computop                   | |3536        |Computop                   |
Line 228: Line 233:
 |6170        |SIX Payment Services       | |6170        |SIX Payment Services       |
 |6215        |Smart2Pay                  | |6215        |Smart2Pay                  |
-|6225        |Sonstige                   |+|6225        |Others                     |
 |3241        |TeleCash                   | |3241        |TeleCash                   |
 |2330        |VöB ZVD                    | |2330        |VöB ZVD                    |
-==== Liste der Fehlercodes ==== + 
-^ID          ^Beschreibung               ^+==== List of error codes ==== 
 +^ID          ^Description                ^
 |0           |OK                         | |0           |OK                         |
-|5000        |Authentifizierung fehlgeschlagen +|5000        |Authentication failed      
-|5001        |Keine Berechtigung         +|5001        |No permission              
-|5002        |ungültiger hash            +|5002        |invalid hash               
-|5003        |Mindestens ein Pflichtfeld nicht angegeben +|5003        |At least one mandatory field not given 
-|5009        |Ungültige E-Mail Adresse   +|5009        |Invalid E-Mail Address     
-|5010        |Ungültige Sprache          +|5010        |Invalid language           
-|5011        |Ungültiges Land            | +|5011        |Invalid country            | 
-|5012        |Ungültige Branche          +|5012        |Invalid branch             
-|5013        |Ungültiges Shopsystem      +|5013        |Invalid shop system        
-|5014        |Ungültiges Geschlecht      +|5014        |Invalid gender             
-|5015        |Ungültiges Produkt         +|5015        |Invalid product            
-|5016        |Organisationstyp ungültig  | +|5016        |Invalid organization type  | 
-|5017        |Händler existiert bereits  +|5017        |Merchant already exists    
-|5018        |giropay PSP ungültig       +|5018        |Invalid giropay PSP        
-|5019        |Ungültiger Kreditkartentyp +|5019        |Invalid Credit card type   
-|9999        |Interner Fehler            |+|9999        |Internal error             |
  
en/reseller/api/newmerchant.1459235884.txt.gz · Last modified: 2021/04/12 14:33