Update Payment Driver Configuration
post
/config/sim/v2/setup/updatePaymentDriverConfiguration
Updates the configuration for the payment driver.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string(string)
Detail that Identifies that who made the change
A CUD request body
Root Schema : PaymentDriverConfigCUDRequestBody
Type:
objectModel for a Payment Driver Configuration CUD Request.
Show Source
-
configuration(required):
object configuration
An object containing the configuration parameters for the payment driver.
-
hierUnitId(required):
integer
Unique reference of the hierarchy unit.Example:
1034 -
objectNum(required):
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)
Response
Supported Media Types
- application/json
200 Response
Payment Driver Configuration that was updated.
Root Schema : PaymentDriverConfigResponse
Type:
objectModel for a Payment Driver Configuration Response Object
Show Source
-
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
1034 -
objectNum(required):
integer
Object number of the Payment DriverExample:
20
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