Create a third party payment options
post
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPaymentOptions
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
-
AgencyId: integer
(int32)
Default Value:
1
Unique identifier of the agency. -
CEFeeLimit: integer
(int32)
Default Value:
200
Indicates the transaction limit on data source associated with code enforcement transactions. -
CETimer: integer
(int32)
Default Value:
6
Indicates the timer associated with search request for code enforcement transactions. -
LNPTransactionLimit: integer
(int32)
Default Value:
200
Indicates the transaction limit on data source associated with permits, planning and zoning applications and business license transactions. -
PaymentReferencePrefix: string
Maximum Length:
4
Default Value:TPTY
Prefix used for the payment reference value. -
PunchoutUser: string
Maximum Length:
30
Default Value:ORA_PUBLIC_USER
Indicates user types who will be punched out to third party payment service provider page. -
ReinstateFeeFlag: string
Maximum Length:
1
Default Value:N
Specifies whether a fee should be reinstated for return of payment by the financial institution. -
ReturnFeeAmount: number
Specifies the amount of the fee charged for return of payment by the financial institution.
-
ReturnFeeCurrency: string
Maximum Length:
3
Specifies the currency of the fee charged for return of payment by the financial institution. -
ReturnFeeFlag: string
Maximum Length:
1
Default Value:N
Specifies whether a return fee should be charged for return of payment by the financial institution. -
ReturnFeeItemId: string
Maximum Length:
30
Specifies the identifier to charge a fee on return of payment by the financial institution.
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 : publicSectorThirdPartyPaymentOptions-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
Unique identifier of the agency. -
CEFeeLimit: integer
(int32)
Default Value:
200
Indicates the transaction limit on data source associated with code enforcement transactions. -
CETimer: integer
(int32)
Default Value:
6
Indicates the timer associated with search request for code enforcement transactions. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LNPTransactionLimit: integer
(int32)
Default Value:
200
Indicates the transaction limit on data source associated with permits, planning and zoning applications and business license transactions. -
PaymentReferencePrefix: string
Maximum Length:
4
Default Value:TPTY
Prefix used for the payment reference value. -
PunchoutUser: string
Maximum Length:
30
Default Value:ORA_PUBLIC_USER
Indicates user types who will be punched out to third party payment service provider page. -
ReinstateFeeFlag: string
Maximum Length:
1
Default Value:N
Specifies whether a fee should be reinstated for return of payment by the financial institution. -
ReturnFeeAmount: number
Specifies the amount of the fee charged for return of payment by the financial institution.
-
ReturnFeeCurrency: string
Maximum Length:
3
Specifies the currency of the fee charged for return of payment by the financial institution. -
ReturnFeeFlag: string
Maximum Length:
1
Default Value:N
Specifies whether a return fee should be charged for return of payment by the financial institution. -
ReturnFeeItemId: string
Maximum Length:
30
Specifies the identifier to charge a fee on return of payment by the financial institution.
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.