Get Payment Driver Configuration
post
/config/sim/v1/setup/getpaymentdriverconfiguration
Gets the configuration of all the payment drivers.
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
Objects included in the response.Example:
hierUnitId -
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 the translated strings returned.Example:
en-US, es-ES, es-MX -
limit:
integer
If using paging, number of results returned in this page.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.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(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A Collection of Payment Drivers Configurations
Root Schema : PaymentDriverConfigGetResponsev1
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 Driver Config 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 : items
Type:
arrayArray of Payment Driver Config objects of the organization.
Show Source
-
Array of:
object PaymentDriverConfigv1
Model for a Payment Driver Configuration Object.
Nested Schema : PaymentDriverConfigv1
Type:
objectModel for a Payment Driver Configuration Object.
Show Source
-
configuration:
object configuration
An object containing the configuration parameters for the payment driver.
-
hierUnitId:
integer
Unique reference of the hierarchy unit.Example:
1034 -
hierUnitName:
object hierUnitName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the hierarchy unit configured languages.
-
hierUnitObjNum:
integer
Object number of the hierarchy unit.Example:
3 -
name:
object name
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the Payment Driver in configured languages.
-
objectNum:
integer
Object number of the Payment Driver.Example:
20
Nested Schema : configuration
Type:
objectAn object containing the configuration parameters for the payment driver.
Show Source
-
assemblyName:
string
Name of the assembly containing the module
-
categoryAndType:
string
Category and type of the driver to be initiated
-
className:
string
Class name of the module to be initiated
-
clientCertCommonName:
string
Displays client certificate common name, if loaded
-
clientCertEffectiveDt:
string
Displays client certificate effective date, if loaded
-
clientCertExpDt:
string
Displays client certificate expiration date, if loaded
-
clientCertificate:
string
Client certificate public key
-
clientCertPassword:
string
Client certificate password
-
currencyCode:
string
Enter the 3 digit ISO Numeric Currency Code. (SPI Only)
-
description:
string
A description for this module
-
enableQuickChip:
boolean
Select True to enable the Quick Chip feature with fast transactions. The payment Service provider should support this feature.(SPI only)
-
hostTimeout:
integer
Timeout in seconds before the request is abandoned.
-
includeNamespaceWithXMLMessage:
boolean
Include NameSpace elements in XML message.(SPI only)
-
merchantNumber:
string
Enter the merchant identification number.
-
passphrase:
string
Enter the authentication pass phrase.(OPI only)
-
primaryHost:
string
Enter the URL for the endpoint.(format- http(s)://host:port number)
-
securitySettings:
integer
Http Only; Https without certificate validation; Https with certificate validation(Server certificate required, Client certificate optional)(SPI only)
-
serverCertCommonName:
string
Displays server certificate common name, if loaded
-
serverCertEffectiveDt:
string
Displays server certificate effective date, if loaded
-
serverCertExpDt:
string
Displays server certificate expiration date, if loaded
-
serverCertificate:
string
Server certificate public key
-
spiInterface:
boolean
True- Use SPI Interface, False- Use OPI JSON Interface
-
supportsCardAcquisition:
boolean
Select True to enable the Payment Service Provider to supply Card Acquisition payment and loyalty data.(SPI only)
-
validateXMLAgainstSchema:
boolean
Validate XML message against schema and log errors in SPIXML.log.(SPI only)
Nested Schema : hierUnitName
Type:
objectAdditional Properties Allowed
Show Source
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:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the Payment Driver in configured languages.
Example:
{
"en-US":"OPI",
"de-DE":"OPI",
"es-MX":"OPI"
}