Update a payment gateway configuration
patch
/fscmRestApi/resources/11.13.18.05/publicSectorGatewayConfigs/{publicSectorGatewayConfigsUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorGatewayConfigsUniqID: integer
This is the hash key of the attributes which make up the composite key--- GatewayName, GatewayProductId and ConfigurationId ---for the Gateway Configs resource and used to uniquely identify an instance of Gateway Configs. The client should not generate the hash key value. Instead, the client should query on the Gateway Configs collection resource with a filter on the primary key values in order to navigate to a specific instance of Gateway Configs.
For example: publicSectorGatewayConfigs?q=GatewayName=<value1>;GatewayProductId=<value2>;ConfigurationId=<value3>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorGatewayConfigs-item
Type:
Show Source
object
-
ConfigurationDescr(optional):
string
Title:
Configuration Description
Maximum Length:300
The description of the payment gateway configuration. -
ConfigurationId(optional):
string
Title:
Configuration ID
Maximum Length:15
The unique identifier of the payment gateway configuration. -
ConfigurationName(optional):
string
Title:
Configuration Name
Maximum Length:100
The name of the payment gateway configuration. -
DeletedFlag(optional):
boolean
Indicates whether seed data has been deleted. If the value is Y, the seed data has been deleted. The default value is N.
-
GatewayName(optional):
string
Title:
Gateway Name
Maximum Length:80
The name of the payment gateway. -
GatewayProductId(optional):
string
Title:
Gateway Product ID
Maximum Length:100
The unique identifier of the product of the payment processor that is called by the payment gateway. -
links(optional):
array Items
Title:
Items
Link Relations -
SeedDataLock(optional):
integer(int32)
Indicates whether seed data is locked. A value of 0 means it is customer data. A value of 1 means the seed data is locked and cannot be updated. A value of 2 means the seed data can be updated.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorGatewayConfigs-item
Type:
Show Source
object
-
ConfigurationDescr(optional):
string
Title:
Configuration Description
Maximum Length:300
The description of the payment gateway configuration. -
ConfigurationId(optional):
string
Title:
Configuration ID
Maximum Length:15
The unique identifier of the payment gateway configuration. -
ConfigurationName(optional):
string
Title:
Configuration Name
Maximum Length:100
The name of the payment gateway configuration. -
DeletedFlag(optional):
boolean
Indicates whether seed data has been deleted. If the value is Y, the seed data has been deleted. The default value is N.
-
GatewayName(optional):
string
Title:
Gateway Name
Maximum Length:80
The name of the payment gateway. -
GatewayProductId(optional):
string
Title:
Gateway Product ID
Maximum Length:100
The unique identifier of the product of the payment processor that is called by the payment gateway. -
links(optional):
array Items
Title:
Items
Link Relations -
SeedDataLock(optional):
integer(int32)
Indicates whether seed data is locked. A value of 0 means it is customer data. A value of 1 means the seed data is locked and cannot be updated. A value of 2 means the seed data can be updated.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.