Jump to

• Request
• Response

Add Payment Drivers

post

/content/sim/v1/setup/paymentdrivers

Add the payment driver to the specified organization.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.
• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Request body

Root Schema : PaymentDriver

Type: object

Show Source

• filename(optional): string
  The name of the image file with extension.

  Example: OPIPayment.dll
• filenameOrigin(optional): string
  the content file origin.

  Example: C:\Program Files\Oracle Hospitality\EMCClient\OPIPayment.dll
• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1
• hierUnitName(optional): object TranslatedString_HierUnitName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the hierarchy unit configured languages
• hierUnitObjNum(optional): integer
  Hierarchy unit object number

  Example: 1
• name(optional): object TranslatedString_PaymentDriverName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the payment driver in configured languages
• objectNum: integer
  Object number of the workstation

  Example: 1
• type(optional): integer
  the type of the file.

  Example: 26
• url(optional): string
  The URL of the download API which needs to be used to download the actual content file.

  Example: https://baseurl/download

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Hierarchy unit object number"
        },
        "hierUnitName":{
            "$ref":"#/definitions/TranslatedString_HierUnitName"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the workstation"
        },
        "name":{
            "$ref":"#/definitions/TranslatedString_PaymentDriverName"
        },
        "type":{
            "type":"integer",
            "example":26,
            "description":"the type of the file."
        },
        "filenameOrigin":{
            "type":"string",
            "example":"C:\\Program Files\\Oracle Hospitality\\EMCClient\\OPIPayment.dll",
            "description":"the content file origin."
        },
        "filename":{
            "type":"string",
            "example":"OPIPayment.dll",
            "description":"The name of the image file with extension."
        },
        "url":{
            "type":"string",
            "example":"https://baseurl/download",
            "description":"The URL of the download API which needs to be used to download the actual content file."
        }
    }
}

Nested Schema : TranslatedString_HierUnitName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A group of string objects representing the name of the hierarchy unit configured languages",
    "example":{
        "en-US":"Enterprise",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the hierarchy unit configured languages

Example:

{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

Nested Schema : TranslatedString_PaymentDriverName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A group of string objects representing the name of the payment driver in configured languages",
    "type":"object",
    "example":{
        "en-US":"Payment Driver",
        "es-SS":"Conductor de pago",
        "lt=LT":"Mok??jimo vairuotojas"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the payment driver in configured languages

Example:

{
    "en-US":"Payment Driver",
    "es-SS":"Conductor de pago",
    "lt=LT":"Mok??jimo vairuotojas"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response object

Body ()

Root Schema : PaymentDriverResponse

Type: object

Show Source

• hierUnitId: integer
  Unique hierarchy unit value.

  Example: 1
• objectNum: integer
  Object Number of the payment driver.

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value."
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object Number of the payment driver."
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top