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.

Body ()

Request body

Root Schema : PaymentDriverCURequestBody

Type: object

Show Source

• displayName(required): string
  Class name of the driver to be instantiated.

  Example: Payment Driver
• filename: string
  The name of the image file with extension.

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

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

  Example: 1
• name(required): object name
  A group of string objects representing the name of the payment driver in configured languages
• objectNum(required): integer
  Object number of the payment driver.

  Example: 1
• passphrase(required): string
  Enter the authentication passphrase (OPI Only).

  Example: Pa$$woRd123
• type: integer
  the type of the file.

  Example: 26

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name",
        "displayName",
        "passphrase"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the payment driver."
        },
        "name":{
            "description":"A group of string objects representing the name of the payment driver in configured languages",
            "type":"object",
            "example":{
                "en-US":"Payment Driver",
                "de-DE":"Zahlungstreiber",
                "es-MX":"Conductor de pago"
            }
        },
        "displayName":{
            "type":"string",
            "example":"Payment Driver",
            "description":"Class name of the driver to be instantiated."
        },
        "passphrase":{
            "type":"string",
            "example":"Pa$$woRd123",
            "description":"Enter the authentication passphrase (OPI Only)."
        },
        "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."
        }
    }
}

Nested Schema : name

Type: object

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

Example:

{
    "en-US":"Payment Driver",
    "de-DE":"Zahlungstreiber",
    "es-MX":"Conductor de pago"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Payment Driver Added.

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",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value."
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object Number of the payment driver."
        }
    }
}

Back to Top