Get all agency payment options
get
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsAgencies
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a payment option at the agency level that matches the primary key criteria specified.
Finder Variables:- AgencyId; integer; The unique identifier of the agency.
- PaymentMethodCode; string; The unique identifier of the payment method.
- simpleSearchFinder: Finds any payment options at the agency level with the specified payment method code.
Finder Variables:- value; string; The unique identifier of the payment method.
- PrimaryKey: Finds a payment option at the agency level that matches the primary key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AgencyId; integer; The unique identifier of the agency receiving an incoming customer payment. This is usually the name of a city or county.
- CashierSessionAtnRule; string; The autonumbering rule used to generate cashier session numbers.
- DefaultPaymentMethod; string; The initial payment method that defaults on the cash drawer payment page.
- DepositSlipAtnRule; string; The autonumbering rule used to generate deposit slip sequence numbers.
- EnabledUser; string; Indicates whether payment method is enabled for agency staff or public user or both.
- IdVerification; string; Indicates whether ID verification is required when accepting check payments.
- PaymentAdapterId; string; The unique identifier of the payment adapter associated with the agency.
- PaymentMethodCode; string; The method of payment. Possible values are Cash or Check.
- PaymentReferencePrefix; string; Prefix used by the payment process for the payment reference value.
- ReceiptAtnRule; string; The autonumbering rule used to generate receipt numbers.
- RefundFeeItemId; string; Specifies the identifier to recover a refund of overpayment on return of payment by the financial institution.
- ReinstateFeeFlag; string; Specifies whether a fee should be reinstated on return of payment by the financial institution.
- ReopenCashierSession; string; 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; Specifies the currency of the fee charged on return of payment by the financial institution.
- ReturnFeeItemId; string; Specifies the identifier to charge a fee on return of payment by the financial institution.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.