Update a payment adapter payment method
patch
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterMethods/{publicSectorAdapterMethodsUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorAdapterMethodsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AdapterId, PaymentMethodCode and AgencyId ---for the Adapter Methods resource and used to uniquely identify an instance of Adapter Methods. The client should not generate the hash key value. Instead, the client should query on the Adapter Methods collection resource with a filter on the primary key values in order to navigate to a specific instance of Adapter Methods.
For example: publicSectorAdapterMethods?q=AdapterId=<value1>;PaymentMethodCode=<value2>;AgencyId=<value3>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorAdapterMethods-item
Type:
Show Source
object
-
AdapterId(optional):
string
Maximum Length:
100
The unique identifier for the payment adapter. -
AgencyId(optional):
integer(int64)
The unique identifier of the agency receiving incoming customer payments.
-
EnabledFlag(optional):
string
Maximum Length:
1
Indicates whether a payment adapter payment method is active. If the value is Y, the payment adapter payment method is active. -
links(optional):
array Items
Title:
Items
Link Relations -
PaymentMethodCode(optional):
string
Maximum Length:
30
The payment method code. -
ServiceChargeAmount(optional):
number
The amount that is charged by the payment processor as a payment service charge.
-
ServiceChargeCurrency(optional):
string
Maximum Length:
3
The currency code related to any payment service charge amounts. -
ServiceChargeDescr(optional):
string
Maximum Length:
150
The description of the service charge that is applied to payment transactions by the payment processor. -
ServiceChargePercent(optional):
number
The percentage of the payment amount that is charged by the payment processor as a payment service charge.
-
SpecialInstructions(optional):
string
Maximum Length:
1000
List of special instructions for the user related to the payment.
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 : publicSectorAdapterMethods-item
Type:
Show Source
object
-
AdapterId(optional):
string
Maximum Length:
100
The unique identifier for the payment adapter. -
AgencyId(optional):
integer(int64)
The unique identifier of the agency receiving incoming customer payments.
-
EnabledFlag(optional):
string
Maximum Length:
1
Indicates whether a payment adapter payment method is active. If the value is Y, the payment adapter payment method is active. -
links(optional):
array Items
Title:
Items
Link Relations -
PaymentMethodCode(optional):
string
Maximum Length:
30
The payment method code. -
ServiceChargeAmount(optional):
number
The amount that is charged by the payment processor as a payment service charge.
-
ServiceChargeCurrency(optional):
string
Maximum Length:
3
The currency code related to any payment service charge amounts. -
ServiceChargeDescr(optional):
string
Maximum Length:
150
The description of the service charge that is applied to payment transactions by the payment processor. -
ServiceChargePercent(optional):
number
The percentage of the payment amount that is charged by the payment processor as a payment service charge.
-
SpecialInstructions(optional):
string
Maximum Length:
1000
List of special instructions for the user related to the payment.
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.