riverty logo

Docs

Add Shop

Create and add a shop, with its associated contract, to an existing merchant

Path

POST /merchants/{merchantId}/shops

Request Parameters

merchantId
required
string
The id of the merchant that was returned from CreateMerchant endpoint
Accept-version
required
string
undefined

Request Body

application/json

name
required
string
> 80 Characters
The name of the webshop can be the URL (our suggestion) or the legal name with some differentiator (to identify different webshops under one merchant)
tradeName
string
> 80 Characters
The trade name of the shop will be used as shop name in our consumer facing portals, if not set the regular shop name will be used.
url
required
string
> 255 Characters
marketCountry
required
string
Enum:

NL

BE

DE

AT

CH

industryCode
required
string
> 10 Characters
The industry code should be the lowest level (webshop level) in case the merchants work in several industries and the first and second code differ.
industryCodeStandard
required
string
Enum:

Sbi

Mcc

Sic

numberOfAnnualTransactions
integer
The annual transactions of this webshop.
averageOrderValue
integer
Average order value can be a default value, based on partner portfolio.
object
object
required
object
customerservicePhoneNumber
string
This shop specific contact information will be shown to consumers on any consumer facing communication.
customerserviceEmailAddress
string
> 80 Characters
This shop specific contact information will be shown to consumers on any consumer facing communication.
customerserviceUrl
string
required
object
isMarketplace
boolean
In case the contract allows partners to send in marketplaces, we need to know of each webshop if it is a market place setup yes or no.

Responses

Successful Call

Request Example

    
        {
 "name": "Example Shop B",
 "url": "https://www.exampleshop-b.at",
 "marketCountry": "AT",
 "isMarketplace": false,
 "industryCode": "5691",
 "industryCodeStandard": "MCC",
 "numberOfAnnualTransactions": 100000,
 "averageOrderValue": 30,
 "operationalContact": {
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+4930936681944",
  "email": "john.doe@examplepartner.com"
 },
 "technicalContact": {
  "firstName": "Janet",
  "lastName": "Doe",
  "phoneNumber": "+4930936681944",
  "email": "janet.doe@examplepartner.com"
 },
 "fraudContact": {
  "firstName": "Jeff",
  "lastName": "Doe",
  "phoneNumber": "+4930936681944",
  "email": "jeff.doe@examplemerchant-a.at"
 },
 "customerservicePhoneNumber": "+4930936681945",
 "customerserviceEmailAddress": "customer.service@exampleshop-b.at",
 "contract": {
  "partnerReference": "C1774334146",
  "iban": null,
  "agreementId": 32
 }
}

Response Example

    
        {
 "shopId": "RTY123459355"
}