Jump to

• Request
• Response

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

Header Parameters

• Simphony-OrgShortName: string(string)
  Org Identifier

Body ()

A request body

Root Schema : PaymentDriverConfigGetRequestBody

Type: object

The input Body model that needs to be given.

Show Source

• include(optional): string
• languages(optional): string
• searchCriteria(optional): string

{
    "description":"The input Body model that needs to be given.",
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string"
        },
        "include":{
            "type":"string"
        },
        "languages":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of all Payment Drivers with configurations for an organization.

Body ()

Root Schema : PaymentDriverConfig

Type: object

Model 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(optional): object hierUnitName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the hierarchy unit configured languages.
• hierUnitObjNum(optional): integer
  Object number of the hierarchy unit.

  Example: 3
• name: object name
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the Payment Driver in configured languages.
• objectNum: integer
  Object number of the Payment Driver.

  Example: 20

{
    "description":"Model for a Payment Driver Configuration Object.",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name",
        "configuration"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit.",
            "type":"integer",
            "example":1034
        },
        "hierUnitObjNum":{
            "description":"Object number of the hierarchy unit.",
            "type":"integer",
            "example":3
        },
        "hierUnitName":{
            "description":"A group of string objects representing the name of the hierarchy unit configured languages.",
            "type":"object",
            "example":{
                "en-US":"Enterprise",
                "es-SS":"Empresa",
                "lt=LT":"??mon??"
            },
            "additionalProperties":{
                "type":"string"
            }
        },
        "objectNum":{
            "description":"Object number of the Payment Driver.",
            "type":"integer",
            "example":20
        },
        "name":{
            "description":"A group of string objects representing the name of the Payment Driver in configured languages.",
            "type":"object",
            "example":{
                "en-US":"OPI",
                "es-SS":"OPI",
                "lt=LT":"OPI"
            },
            "additionalProperties":{
                "type":"string"
            }
        },
        "configuration":{
            "description":"An object containing the configuration parameters for the payment driver.",
            "type":"object",
            "properties":{
                "parameterName":{
                    "description":"Name of the configuration parameter",
                    "type":"string"
                },
                "parameterValue":{
                    "description":"configuration value of the parameter",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : configuration

Type: object

An object containing the configuration parameters for the payment driver.

Show Source

• parameterName(optional): string
  Name of the configuration parameter
• parameterValue(optional): string
  configuration value of the parameter

{
    "description":"An object containing the configuration parameters for the payment driver.",
    "type":"object",
    "properties":{
        "parameterName":{
            "description":"Name of the configuration parameter",
            "type":"string"
        },
        "parameterValue":{
            "description":"configuration value of the parameter",
            "type":"string"
        }
    }
}

Nested Schema : hierUnitName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A group of string objects representing the name of the hierarchy unit configured languages.",
    "type":"object",
    "example":{
        "en-US":"Enterprise",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

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

Example:

{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

Nested Schema : name

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A group of string objects representing the name of the Payment Driver in configured languages.",
    "type":"object",
    "example":{
        "en-US":"OPI",
        "es-SS":"OPI",
        "lt=LT":"OPI"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the Payment Driver in configured languages.

Example:

{
    "en-US":"OPI",
    "es-SS":"OPI",
    "lt=LT":"OPI"
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

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

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

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

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

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

  Example: VALIDATION ERROR
• type(optional): 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",
    "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"
        }
    }
}

Back to Top