Get Payment Drivers
post
/content/sim/v2/setup/getPaymentDrivers
Gets all the payment drivers
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : PaymentDriverGetRequestv2
Type:
Show Source
object-
include:
string
Objects included in responseExample:
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 -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
10 -
offset:
integer
Starting resource record indexExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort orderExample:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field valueExample:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A Collection of payment driver objects
Root Schema : PaymentDriverGetResponsev2
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Payment Drivers objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : PaymentDriverv2
Type:
Show Source
object-
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:
integer
Unique hierarchy unit valueExample:
1 -
hierUnitObjNum:
integer
Hierarchy unit object numberExample:
1 -
name:
object name
A group of string objects representing the name of the payment driver in configured languages
-
objectNum:
integer
Object number of the workstationExample:
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.
Nested Schema : name
Type:
objectA group of string objects representing the name of the payment driver in configured languages
Example:
{
"1":"Payment Driver",
"2":"Zahlungstreiber",
"3":"Conductor de pago"
}Nested Schema : url
Type:
objectThe 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
Nested Schema : params
Type:
Show Source
object-
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
2 -
objectNum:
integer
Object Number of the payment driverExample:
1
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse 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 problemExample:
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
404 Response
404 Requested resource not found