Skip to Main Content
Riverty Docs
    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
    Max length: 80
    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
    Max length: 80
    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
    Max length: 255
    marketCountry
    required
    string
    Enum:
    • NL
    • BE
    • DE
    • AT
    • CH
    • SE
    • DK
    • FI
    • NO
    industryCode
    required
    string
    Max length: 10
    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
    firstName
    required
    string
    Max length: 50
    lastName
    required
    string
    Max length: 75
    phoneNumber
    string
    Max length: 20
    email
    required
    string
    Max length: 80
    object
    firstName
    required
    string
    Max length: 50
    lastName
    required
    string
    Max length: 75
    phoneNumber
    string
    Max length: 20
    email
    required
    string
    Max length: 80
    required
    object
    firstName
    required
    string
    Max length: 50
    lastName
    required
    string
    Max length: 75
    phoneNumber
    string
    Max length: 20
    email
    required
    string
    Max length: 80
    customerservicePhoneNumber
    string
    This shop specific contact information will be shown to consumers on any consumer facing communication.
    customerserviceEmailAddress
    string
    Max length: 80
    This shop specific contact information will be shown to consumers on any consumer facing communication.
    customerserviceUrl
    string
    required
    object
    partnerReference
    required
    string
    Max length: 255
    The Partner Reference is a unique idempotency identifier, which ensures that if the Create Merchant of Add Shop request is sent multiple times, the operation is only performed once.
    agreementId
    required
    string
    The Agreement ID is the unique reference for a partner’s set of pre-defined shop settings. Partners will receive a minimum of one Agreement ID per country. A partner may have multiple Agreement IDs (indicating different shop settings) for the same country.
    iban
    string
    Max length: 34
    IBAN is not needed for M-level agreements, as Riverty will pay out to the partner.
    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 true or false.

    Responses

    • shopId
      string
    • 400 Bad Request. Possible 400 errors: - A Shop with the same URL and market country was already onboarded for this merchant, shopID = {}, Please use the credentials endpoint. - The AgreementId in the contract does not match that of the partner - The AgreementId in the contract does not match with the MarketCountry
    • 404 Not Found. Example: Merchant not found.
    Successful Call

    Request Example

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

    Response Example

        
        {
 "shopId": "RTY123459355"
}