1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Billing and Payment
  4. Payments

Get all payment data

get

/fscmRestApi/resources/11.13.18.05/publicSectorPayments

Request

Query Parameters
  • 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).
  • 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
  • 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 payments that match the primary key criteria specified.
      Finder Variables:
      • PaymentHistoryKey; integer; The unique identifier for the payment transaction.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AccountPurpose; string; The purpose assigned with the deposit account.
    • AccountType; string; The type assigned with the deposit account.
    • ActivityType; string; The type of activity.
    • Address1; string; The first line of the payer billing address. Requires a valid street number and name.
    • Address2; string; The second line of the payer billing address such as apartment, suite, unit, building, floor, or village information.
    • Address3; string; The third line of the payer billing address.
    • Address4; string; The fourth line of the payer billing address.
    • AgencyId; integer; The unique identifier of the agency associated with the payment transaction.
    • AmountDue; number; The total payment amount due that is the sum total of the amounts on payment history lines.
    • AuthorizationCode; string; The authorization code value returned by the payment gateway or trust account system.
    • AuthorizationDttm; string; The authorization date returned by the payment gateway, by the trust account system, or a timestamp given by the agency staff for cash drawer and manual confirmation of trust account funds.
    • AuthorizationStatus; string; The status value returned by the payment gateway or trust account system.
    • BusinessEntityDbaName; string; Doing business as name of the business making the payment.
    • BusinessEntityId; string; The unique identifier for the business entity associated with this transaction.
    • BusinessEntityName; string; The entity name of the business making the payment.
    • BusinessEntityPartyId; integer; The unique identifier for the business entity party associated with this transaction.
    • BusinessLocationId; string; The unique identifier for the location of the business entity.
    • BusinessLocationPartyId; integer; The unique identifier for the party associated with the business entity location.
    • BusinessProfileId; integer; The unique identifier for the profile of the business entity associated with this transaction.
    • CheckoutId; integer; Checkout identifier for the credit applied.
    • CreditAmountApplied; number; The amount of the credit applied to the payment.
    • CreditAmountAvailable; number; The amount available to apply a payment on account credit.
    • CreditAppliedFlag; string; Payment on account credit is applied.
    • CreditCardDigits; integer; The last four digits of the credit card number used for a payment.
    • CreditCardType; string; The type of credit card used for a payment. Examples are MasterCard and Visa.
    • EcheckAgreeDttm; string; The date and time of the user???s consent and agreement on the electronic check terms and conditions. This is required only for the electronic check payment method.
    • ExternalPaymentReference; string; An attribute that identifies the external payment reference provided by the third party payment system.
    • FarReceiptStatus; string; The status to indicate the creation of a receipt in Oracle Receivables.
    • FarReceiptStatusDescr; string; The status to indicate the creation of a receipt in Oracle Receivables.
    • FirstResponseMessage; string; The first part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account.
    • Meaning; string; The payment method description.
    • MigratedDataFlag; string; A flag to indicate that the data was migrated from another system.
    • PartyId; integer; The unique identifier for the party associated with this transaction.
    • PayerAddress; string; The address of the person who made the payment.
    • PayerCity; string; The city of the payer billing address.
    • PayerCountryThreeCharacterCode; string; The international three-digit country code call prefix of the payer's phone number.
    • PayerCountryTwoCharacterCode; string; The international two-digit country code call prefix of the payer's phone number.
    • PayerCounty; string; The county of the payer billing address. This is a geographical subdivision within a state or region and encompasses multiple cities.
    • PayerEmail; string; The email address of the payer for a payment transaction.
    • PayerFirstName; string; The first name of the payer for a payment transaction.
    • PayerLastName; string; The last name of the payer for a payment transaction.
    • PayerMiddleName; string; The middle name of the payer for a payment transaction.
    • PayerName; string; The name of the person who made the payment.
    • PayerNameSuffix; string; The suffix for the name of the payer for a payment transaction.
    • PayerPhone; string; The phone number of the person making the payment.
    • PayerPostalAddOnCode; string; The additional digits used to identify a specific mail delivery route.
    • PayerPostalCode; string; The postal code of the payer billing address. It can be a series of digits or letters or both.
    • PayerProvince; string; The region code for the payer billing address in non-US countries. In Canada, this is the two-character province abbreviation by the Canada Post.
    • PayerState; string; The state code of the payer billing address. In the U.S, this is the two-character USPS state abbreviation. For example, NY for New York.
    • PaymentAdapterId; string; The unique identifier of the payment adapter associated with the agency and payment method.
    • PaymentAmount; number; The total payment amount authorized and settled by the payment gateway or verified by the trust account system.
    • PaymentCurrency; string; The currency used for the payment transaction.
    • PaymentDate; string; The date on which the payment transaction occurred.
    • PaymentHeaderId; string; Identifies the alpha numeric payment header reference for a payment processed by third party payment system.
    • PaymentHeaderKey; integer; Identifies payment header key.
    • PaymentHistoryKey; integer; The unique identifier for the payment transaction.
    • PaymentMethodCode; string; The method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier???s check.
    • PaymentReferenceId; string; A reference value created by the payment module and sent as pass-through data to the payment processor, trust account, and cash drawer.
    • PaymentStatus; string; Indicates the status of the payment.
    • PaymentTrackingData; string; The identifying attribute passed during checkout by the originator of the assessed fees.
    • PaymentTrackingDataPlus; string; The additional identifying attribute passed during checkout by the originator of the assessed fees.
    • PaymentTransactionId; string; The unique identifier of the transaction that is received from the payment gateway or from the trust account system.
    • ProfileId; integer; The unique identifier for the profile of the user associated with this transaction.
    • PublishedStatusCode; string; Indicates whether reconciliation activity has been created for the transaction by code.
    • PublishedStatusName; string; Indicates whether reconciliation activity has been created for the transaction by name.
    • ReconHistoryKey; integer; Unique identifier for each bank reconciliation activity record.
    • ReconcileDatetime; string; The date and time of the payment reconciliation.
    • ReconcileType; string; Indicates whether the payment was reconciled through an online API or by the ESS job.
    • ReversalFlag; string; Indicates whether the record is a reversal of a payment.
    • ReversalReasonCd; string; Identifies the reason code when payment is reversed or voided.
    • ReversalTransactionType; string; Indicates the type of reversal transaction.
    • SecondResponseMessage; string; The second part of the response message returned by the payment gateway, or a free form message entered by agency staff for cash drawer or trust account.
    • ServiceChargeAmount; number; A convenience fee assessed by the department for using a specific payment method.
    • ServiceChargeCurrency; string; The currency used for the service charge.
    • ThirdPartyPayFlag; string; Identifies the payment was processed by a third party payment system.
    • ThirdResponseMessage; string; The third part of the response message returned by the payment gateway, or a free form message entered by agency staff for a cash drawer or deposit account.
    • TrustAccountNumber; string; An attribute that identifies the deposit account number.
    • UnappliedFlag; string; Identifies an unapplied payment record.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : publicSectorPayments
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorPayments-item-response
Type: object
Show Source
Nested Schema : Payment Lines
Type: array
Title: Payment Lines
The payment lines resource is used to view or create payment detail lines.
Show Source
Nested Schema : publicSectorPayments-PaymentHistoryLine-item-response
Type: object
Show Source
Back to Top