Update a payment adapter currency
patch
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterCurrencies/{publicSectorAdapterCurrenciesUniqID}
Request
Path Parameters
-
publicSectorAdapterCurrenciesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AdapterId, PaymentMethodCode, CurrencyCode and AgencyId ---for the Adapter Currencies resource and used to uniquely identify an instance of Adapter Currencies. The client should not generate the hash key value. Instead, the client should query on the Adapter Currencies collection resource with a filter on the primary key values in order to navigate to a specific instance of Adapter Currencies.
For example: publicSectorAdapterCurrencies?q=AdapterId=<value1>;PaymentMethodCode=<value2>;CurrencyCode=<value3>;AgencyId=<value4>
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
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for the agency receiving incoming customer payments. -
MaximumThreshold: integer
(int32)
The maximum payment amount for the selected payment method and currency.
-
MinimumThreshold: integer
(int32)
The minimum payment amount for the selected payment method and currency.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : publicSectorAdapterCurrencies-item-response
Type:
Show Source
object
-
AdapterId: string
Maximum Length:
100
The unique identifier for the payment adapter. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for the agency receiving incoming customer payments. -
CurrencyCode: string
Maximum Length:
3
The currency code. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumThreshold: integer
(int32)
The maximum payment amount for the selected payment method and currency.
-
MinimumThreshold: integer
(int32)
The minimum payment amount for the selected payment method and currency.
-
PaymentMethodCode: string
Maximum Length:
30
The payment method code.
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.