Create an agency payment option
post
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsAgencies
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)
The unique identifier of the agency receiving an incoming customer payment. This is usually the name of a city or county.
-
CashierSessionAtnRule: string
Title:
Cashier Session Number Rule
Maximum Length:20
The autonumbering rule used to generate cashier session numbers. -
DefaultPaymentMethod: string
Title:
Default Payment
Maximum Length:30
The initial payment method that defaults on the cash drawer payment page. -
DepositSlipAtnRule: string
Title:
Deposit Slip Number
Maximum Length:20
The autonumbering rule used to generate deposit slip sequence numbers. -
EnabledUser: string
Maximum Length:
30
Default Value:ORA_AGENCY_STAFF
Indicates whether payment method is enabled for agency staff or public user or both. -
IdVerification: string
Title:
Require ID Verification
Maximum Length:1
Indicates whether ID verification is required when accepting check payments. -
PaymentAdapterId: string
Title:
Payment Adapter ID
Maximum Length:100
The unique identifier of the payment adapter associated with the agency. -
PaymentMethodCode: string
Title:
Payment Method
Maximum Length:30
The method of payment. Possible values are Cash or Check. -
PaymentReferencePrefix: string
Title:
Payment Reference Prefix
Maximum Length:4
Prefix used by the payment process for the payment reference value. -
ReceiptAtnRule: string
Title:
Cash Receipts Number Rule
Maximum Length:20
The autonumbering rule used to generate receipt numbers. -
RefundFeeItemId: string
Maximum Length:
30
Specifies the identifier to recover a refund of overpayment on return of payment by the financial institution. -
ReinstateFeeFlag: string
Maximum Length:
1
Default Value:N
Specifies whether a fee should be reinstated on return of payment by the financial institution. -
ReopenCashierSession: string
Title:
Reopen Cashier Session
Maximum Length:1
Indicates whether users can reopen a closed cashier session that has not been reconciled. -
ReturnFeeAmount: number
Specifies the amount of the fee charged on return of payment by the financial institution.
-
ReturnFeeCurrency: string
Maximum Length:
3
Specifies the currency of the fee charged on 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 : publicSectorPaymentOptionsAgencies-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier of the agency receiving an incoming customer payment. This is usually the name of a city or county.
-
CashierSessionAtnRule: string
Title:
Cashier Session Number Rule
Maximum Length:20
The autonumbering rule used to generate cashier session numbers. -
DefaultPaymentMethod: string
Title:
Default Payment
Maximum Length:30
The initial payment method that defaults on the cash drawer payment page. -
DepositSlipAtnRule: string
Title:
Deposit Slip Number
Maximum Length:20
The autonumbering rule used to generate deposit slip sequence numbers. -
EnabledUser: string
Maximum Length:
30
Default Value:ORA_AGENCY_STAFF
Indicates whether payment method is enabled for agency staff or public user or both. -
IdVerification: string
Title:
Require ID Verification
Maximum Length:1
Indicates whether ID verification is required when accepting check payments. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaymentAdapterId: string
Title:
Payment Adapter ID
Maximum Length:100
The unique identifier of the payment adapter associated with the agency. -
PaymentMethodCode: string
Title:
Payment Method
Maximum Length:30
The method of payment. Possible values are Cash or Check. -
PaymentReferencePrefix: string
Title:
Payment Reference Prefix
Maximum Length:4
Prefix used by the payment process for the payment reference value. -
ReceiptAtnRule: string
Title:
Cash Receipts Number Rule
Maximum Length:20
The autonumbering rule used to generate receipt numbers. -
RefundFeeItemId: string
Maximum Length:
30
Specifies the identifier to recover a refund of overpayment on return of payment by the financial institution. -
ReinstateFeeFlag: string
Maximum Length:
1
Default Value:N
Specifies whether a fee should be reinstated on return of payment by the financial institution. -
ReopenCashierSession: string
Title:
Reopen Cashier Session
Maximum Length:1
Indicates whether users can reopen a closed cashier session that has not been reconciled. -
ReturnFeeAmount: number
Specifies the amount of the fee charged on return of payment by the financial institution.
-
ReturnFeeCurrency: string
Maximum Length:
3
Specifies the currency of the fee charged on 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.