Create a payment gateway
post
/fscmRestApi/resources/11.13.18.05/publicSectorGateways
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorGateways-item
Type:
Show Source
object
-
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.
-
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the payment gateway is active. If the value is Y, the payment gateway is active. The default value is N. -
GatewayName(optional):
string
Title:
Gateway Name
Maximum Length:80
The name of the payment gateway. -
GatewayProductDescr(optional):
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(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. -
GatewayProductVersion(optional):
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(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.
-
URLLive(optional):
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(optional):
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 : 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 : publicSectorGateways-item
Type:
Show Source
object
-
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.
-
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the payment gateway is active. If the value is Y, the payment gateway is active. The default value is N. -
GatewayName(optional):
string
Title:
Gateway Name
Maximum Length:80
The name of the payment gateway. -
GatewayProductDescr(optional):
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(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. -
GatewayProductVersion(optional):
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(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.
-
URLLive(optional):
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(optional):
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 : 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.