Jump to

• Request
• Response

Get Payment Drivers

post

/content/sim/v1/setup/getpaymentdrivers

Gets all the payment drivers

Request

Supported Media Types

• application/json
• multipart/form-data

Body ()

Request body

Root Schema : PaymentDriverGetRequest

Type: object

Show Source

• include: string
  Objects included in response

  Example: locations
• includeAll: string
  This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

  Example: detailed
• languages: string
  If specified, limits translated strings returned

  Example: en-US, de-DE, es-MX
• limit: integer
  If using paging, number of results returned in this page.

  Example: 10
• offset: integer
  Starting resource record index

  Example: 0
• orderBy: string
  Sorts the response by the specified field name and sort order

  Example: objectNum:asc
• searchCriteria: string
  Search criteria to filter results based on field value

  Example: where equals(active,1)

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"string",
            "example":"objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order"
        },
        "searchCriteria":{
            "type":"string",
            "example":"where equals(active,1)",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "example":"locations",
            "description":"Objects included in response"
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n"
        },
        "languages":{
            "type":"string",
            "example":"en-US, de-DE, es-MX",
            "description":"If specified, limits translated strings returned"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A Collection of payment driver objects

Body ()

Root Schema : PaymentDriverGetResponse

Type: object

Show Source

• count(required): integer
  Current response recount count.

  Example: 9
• hasMore(required): boolean
  Flag indicating if there are more objects to fetch.

  Example: true
• items(required): array items
  Array of Payment Drivers objects of the organization.
• limit(required): integer
  Server page size

  Example: 10
• offset(required): integer
  Starting resource record index

  Example: 0
• totalResults(required): integer
  Total number of rows (excluding the paging parameters)

  Example: 100

{
    "type":"object",
    "required":[
        "totalResults",
        "hasMore",
        "count",
        "items",
        "offset",
        "limit"
    ],
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response recount count."
        },
        "items":{
            "type":"array",
            "description":"Array of Payment Drivers objects of the organization.",
            "items":{
                "$ref":"#/definitions/PaymentDriver"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Payment Drivers objects of the organization.

Show Source

• Array of: object PaymentDriver

{
    "type":"array",
    "description":"Array of Payment Drivers objects of the organization.",
    "items":{
        "$ref":"#/definitions/PaymentDriver"
    }
}

Nested Schema : PaymentDriver

Type: object

Show Source

• 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
• hierUnitName: object hierUnitName
  A group of string objects representing the name of the hierarchy unit configured languages
• hierUnitObjNum: integer
  Hierarchy unit object number

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

  Example: 1
• type: integer
  the type of the file.

  Example: 26
• url: object url
  The URL of the download API which needs to be used to download the actual content file. This is auto-generated and does not need to be provided during add/update calls.

{
    "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":{
            "description":"A group of string objects representing the name of the hierarchy unit configured languages",
            "type":"object",
            "example":{
                "en-US":"Enterprise",
                "de-DE":"Unternehmen",
                "es-MX":"Empresa"
            }
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the workstation"
        },
        "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"
            }
        },
        "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":"object",
            "description":"The URL of the download API which needs to be used to download the actual content file. This is auto-generated and does not need to be provided during add/update calls.",
            "properties":{
                "params":{
                    "type":"object",
                    "properties":{
                        "hierUnitId":{
                            "description":"Unique reference of the hierarchy unit",
                            "type":"integer",
                            "example":2
                        },
                        "objectNum":{
                            "description":"Object Number of the payment driver",
                            "type":"integer",
                            "example":1
                        }
                    }
                },
                "endpoint":{
                    "type":"string",
                    "example":"https://abc.com/content/sim/v1/setup/downloadpaymentdrivers"
                }
            }
        }
    }
}

Nested Schema : hierUnitName

Type: object

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

Example:

{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}

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"
}

Nested Schema : url

Type: object

The URL of the download API which needs to be used to download the actual content file. This is auto-generated and does not need to be provided during add/update calls.

Show Source

• endpoint: string
  Example: https://abc.com/content/sim/v1/setup/downloadpaymentdrivers
• params: object params

{
    "type":"object",
    "description":"The URL of the download API which needs to be used to download the actual content file. This is auto-generated and does not need to be provided during add/update calls.",
    "properties":{
        "params":{
            "type":"object",
            "properties":{
                "hierUnitId":{
                    "description":"Unique reference of the hierarchy unit",
                    "type":"integer",
                    "example":2
                },
                "objectNum":{
                    "description":"Object Number of the payment driver",
                    "type":"integer",
                    "example":1
                }
            }
        },
        "endpoint":{
            "type":"string",
            "example":"https://abc.com/content/sim/v1/setup/downloadpaymentdrivers"
        }
    }
}

Nested Schema : params

Type: object

Show Source

• hierUnitId: integer
  Unique reference of the hierarchy unit

  Example: 2
• objectNum: integer
  Object Number of the payment driver

  Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit",
            "type":"integer",
            "example":2
        },
        "objectNum":{
            "description":"Object Number of the payment driver",
            "type":"integer",
            "example":1
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

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

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

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

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

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

  Example: VALIDATION ERROR
• type(required): 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",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "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"
        }
    }
}

404 Response

404 Requested resource not found

Back to Top