merchant-portal-pam-product-controller

Create new product

Required role for operation: BO_MP_CREATE_NEW_PRODUCT

post/merchantportalws/createNewProduct

Request

  • Base URL
    //test.tecs.at (relative, and the document’s source URL is not known)
  • URL
    //test.tecs.at/merchantportalws/createNewProduct
  • Auth
    none declared. Required headers: Authorization

Headers

Authorizationstring required

Authorization

Request body

acquirerIdstring

Unique identifier for the acquirer. Only numeric values are allowed.

allowMultipleOrdersboolean required

Indication whether multiple orders are allowed or not.

appFormTemplateNamestring required

Name of the application form template.

contractNeededboolean required

Indication whether contract is needed or not.

credentialsNeededboolean

Indication whether credentials are needed or not.

descriptionKeystring required

Key indicator for product description.

nameKeystring required

Key indicator for product name.

prescreeningAllowedboolean required

Indication whether prescreening is allowed or not.

productNamestring required

Name of the product.

terminalTemplateNamestring required

Name of the terminal template.

vendorNamestring required

Name of the vendor.

xmlTemplateFilestring required

A string value containing the XML template file encoded in Base64.

Example request

{
  "appFormTemplateName": "AppForm_123",
  "contractNeeded": true,
  "credentialsNeeded": true,
  "descriptionKey": "Desc_123",
  "nameKey": "Key_123",
  "prescreeningAllowed": true,
  "productName": "Product_123",
  "terminalTemplateName": "TerminalTemplate_123",
  "vendorName": "Vendor_123",
  "xmlTemplateFile": "PFRlcm1pbmFsVGVtcGxhdGU+PGRlc2NyaXB0aW9uPjxEZXNjcmlwdGlvblRleHQ+VGVybWluYWwgcmVnaXN0cmF0aW9uIHRlbXBsYXRlIFRlc3Q8L0Rlc2NyaXB0aW9uVGV4dD48L2Rlc2NyaXB0aW9uPjwvVGVybWluYWxUZW1wbGF0ZT4="
}

Response

OK

responseCodeinteger required

Response code. For success state 0. For failure state lower than 0.

responseMessagestring required

Response message. For success state OK. For failure state description of the cause.

Example response

{
  "responseMessage": "OK"
}

Changes

No recorded changes to this operation across all 1 revision of this API.