Create a payment adapter payment method
post
/fscmRestApi/resources/11.13.18.05/publicSectorAdapterMethods
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AdapterId: string
Title:
Payment Adapter ID
Maximum Length:100
The unique identifier for the payment adapter. -
AgencyId: integer
Title:
Agency ID
Default Value:1
The unique identifier of the agency receiving incoming customer payments. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether a payment adapter payment method is active. If the value is Y, the payment adapter payment method is active. -
PaymentMethodCode: string
Title:
Payment Method
Maximum Length:30
The payment method code. -
ServiceChargeAmount: number
Title:
Service Charge Amount
The amount that is charged by the payment processor as a payment service charge. -
ServiceChargeCurrency: string
Title:
Service Charge Currency
Maximum Length:3
The currency code related to any payment service charge amounts. -
ServiceChargeDescr: string
Title:
Service Charge Description
Maximum Length:150
The description of the service charge that is applied to payment transactions by the payment processor. -
ServiceChargePercent: number
Title:
Service Charge Percent
The percentage of the payment amount that is charged by the payment processor as a payment service charge. -
SpecialInstructions: string
Title:
Special Instructions
Maximum Length:1000
List of special instructions for the user related to the payment.
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 : publicSectorAdapterMethods-item-response
Type:
Show Source
object
-
AdapterId: string
Title:
Payment Adapter ID
Maximum Length:100
The unique identifier for the payment adapter. -
AgencyId: integer
Title:
Agency ID
Default Value:1
The unique identifier of the agency receiving incoming customer payments. -
EnabledFlag: string
Title:
Enabled
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaymentMethodCode: string
Title:
Payment Method
Maximum Length:30
The payment method code. -
ServiceChargeAmount: number
Title:
Service Charge Amount
The amount that is charged by the payment processor as a payment service charge. -
ServiceChargeCurrency: string
Title:
Service Charge Currency
Maximum Length:3
The currency code related to any payment service charge amounts. -
ServiceChargeDescr: string
Title:
Service Charge Description
Maximum Length:150
The description of the service charge that is applied to payment transactions by the payment processor. -
ServiceChargePercent: number
Title:
Service Charge Percent
The percentage of the payment amount that is charged by the payment processor as a payment service charge. -
SpecialInstructions: string
Title:
Special Instructions
Maximum Length:1000
List of special instructions for the user related to the payment.
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.