Update a payment gateway
patch
/fscmRestApi/resources/11.13.18.05/publicSectorGateways/{publicSectorGatewaysUniqID}
Request
Path Parameters
-
publicSectorGatewaysUniqID(required): string
This is the hash key of the attributes which make up the composite key--- GatewayName and GatewayProductId ---for the Gateways resource and used to uniquely identify an instance of Gateways. The client should not generate the hash key value. Instead, the client should query on the Gateways collection resource with a filter on the primary key values in order to navigate to a specific instance of Gateways.
For example: publicSectorGateways?q=GatewayName=<value1>;GatewayProductId=<value2>
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether seed data has been deleted. If the value is Y, the seed data has been deleted. The default value is N. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the payment gateway is active. If the value is Y, the payment gateway is active. The default value is N. -
GatewayProductDescr: string
Title:
Gateway Product Description
Maximum Length:100
The description of the product of the payment processor that is called by the payment gateway. -
GatewayProductVersion: string
Title:
Gateway Product Version
Maximum Length:10
The version number of the product of the payment processor that is called by the payment gateway. -
SeedDataLock: integer
(int32)
Default Value:
0
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. -
URLLive: string
Title:
Production Link
Maximum Length:300
The URL that takes the user to the production environment of the payment processor product that is called by the payment gateway. -
URLTest: string
Title:
Test Link
Maximum Length:300
The URL that takes the user to the test environment of the payment processor product that is called by the payment gateway.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorGateways-item-response
Type:
Show Source
object
-
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether seed data has been deleted. If the value is Y, the seed data has been deleted. The default value is N. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the payment gateway is active. If the value is Y, the payment gateway is active. The default value is N. -
GatewayName: string
Title:
Gateway Name
Maximum Length:80
The name of the payment gateway. -
GatewayProductDescr: string
Title:
Gateway Product Description
Maximum Length:100
The description of the product of the payment processor that is called by the payment gateway. -
GatewayProductId: 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. -
GatewayProductVersion: string
Title:
Gateway Product Version
Maximum Length:10
The version number of the product of the payment processor that is called by the payment gateway. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SeedDataLock: integer
(int32)
Default Value:
0
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. -
URLLive: string
Title:
Production Link
Maximum Length:300
The URL that takes the user to the production environment of the payment processor product that is called by the payment gateway. -
URLTest: string
Title:
Test Link
Maximum Length:300
The URL that takes the user to the test environment of the payment processor product that is called by the payment gateway.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.