Update a payment adapter
patch
/fscmRestApi/resources/11.13.18.05/publicSectorAdapters/{publicSectorAdaptersUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorAdaptersUniqID: integer
This is the hash key of the attributes which make up the composite key--- AdapterId and AgencyId ---for the Adapters resource and used to uniquely identify an instance of Adapters. The client should not generate the hash key value. Instead, the client should query on the Adapters collection resource with a filter on the primary key values in order to navigate to a specific instance of Adapters.
For example: publicSectorAdapters?q=AdapterId=<value1>;AgencyId=<value2>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorAdapters-item
Type:
Show Source
object
-
AdapterId(optional):
string
Maximum Length:
100
The unique identifier of the payment adapter. -
AdapterMode(optional):
string
Maximum Length:
1
The mode for the payment adapter. The Test value indicates that the connection to the payment processor is used for testing purposes. The Live value indicates that it is used to process payment transactions in a production environment. The default value is Test. -
AgencyId(optional):
integer(int64)
The unique identifier of the agency receiving incoming customer payments.
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the payment adapter. -
CreationDate(optional):
string(date-time)
The date on which the payment adapter was created.
-
EnabledFlag(optional):
boolean
Indicates whether the payment adapter is active. If the value is Y, the payment adapter is active.
-
GatewayName(optional):
string
Maximum Length:
80
The name of the payment gateway associated with the payment adapter. -
GatewayProductId(optional):
string
Maximum Length:
100
The unique identifier of the product of the payment processor that is called by the payment gateway. -
LastUpdateDate(optional):
string(date-time)
The date on which the payment adapter was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the payment adapter. -
links(optional):
array Items
Title:
Items
Link Relations
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 : publicSectorAdapters-item
Type:
Show Source
object
-
AdapterId(optional):
string
Maximum Length:
100
The unique identifier of the payment adapter. -
AdapterMode(optional):
string
Maximum Length:
1
The mode for the payment adapter. The Test value indicates that the connection to the payment processor is used for testing purposes. The Live value indicates that it is used to process payment transactions in a production environment. The default value is Test. -
AgencyId(optional):
integer(int64)
The unique identifier of the agency receiving incoming customer payments.
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the payment adapter. -
CreationDate(optional):
string(date-time)
The date on which the payment adapter was created.
-
EnabledFlag(optional):
boolean
Indicates whether the payment adapter is active. If the value is Y, the payment adapter is active.
-
GatewayName(optional):
string
Maximum Length:
80
The name of the payment gateway associated with the payment adapter. -
GatewayProductId(optional):
string
Maximum Length:
100
The unique identifier of the product of the payment processor that is called by the payment gateway. -
LastUpdateDate(optional):
string(date-time)
The date on which the payment adapter was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the payment adapter. -
links(optional):
array Items
Title:
Items
Link Relations
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.