1. Oracle Utilities REST API for Metering and Customer Information
  2. Tasks
  3. Financial Transactions
  4. Payment Event

Search Payment Event Payments

post

/rest/apis/customer/financials/paymentEvents/payments/search

This operation retrieves payment details for a payment event.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
Nested Schema : filters
Type: object
Show Source
Nested Schema : payments
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • account
  • bill
  • cancelReason
  • currency
  • Non-CIS Account Switch
    Example: false
  • Open Item Accounting Switch
    Example: false
  • Maximum Length: 8
    Match Type and Match Value should only be used if either of the following conditions is true: This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of "service agreement ID" and a Match Value of the respective service agreement ID.
    Example: BILL-ID (Bill ID / Sequential Bill Number)
  • Maximum Length: 30
    Match Type and Match Value should only be used if either of the following conditions is true: This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of "service agreement ID" and a Match Value of the respective service agreement ID.
    Example: 995516242555
  • Maximum Length: 254
    Non CIS Comments
  • Maximum Length: 50
    Non CIS Name
  • payment
  • Maximum Length: 30
    Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the Customer Service Representative accepting payments that the account is cash-only.
  • Payment Amount
  • Maximum Length: 12
    Payment Event ID is the system-assigned unique identifier of the payment event.
    Example: 317772795000
  • Maximum Length: 254
    Message
  • Payment Segment Total
    Example: 28.43
  • Allowed Values: [ "10 ", "20 ", "30 ", "50 ", "60 " ]
    Payment Status is the payment's status. If the payment's status is Error , the error message is displayed adjacent. * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `50 ` - Frozen, * `60 ` - Canceled
    Example: 10
  • Maximum Length: 10
    The message description for Payment's Status.
  • Maximum Length: 30
    Reference Number
  • Minimum Value: -99999
    Maximum Value: 99999
    Version
Nested Schema : account
Type: object
Show Source
Nested Schema : bill
Type: object
Show Source
Nested Schema : cancelReason
Type: object
Show Source
Nested Schema : currency
Type: object
Show Source
Nested Schema : payment
Type: object
Show Source
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : filters
Type: object
Show Source
Nested Schema : payments
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • account
  • bill
  • cancelReason
  • currency
  • Non-CIS Account Switch
    Example: false
  • Open Item Accounting Switch
    Example: false
  • Maximum Length: 8
    Match Type and Match Value should only be used if either of the following conditions is true: This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of "service agreement ID" and a Match Value of the respective service agreement ID.
    Example: BILL-ID (Bill ID / Sequential Bill Number)
  • Maximum Length: 30
    Match Type and Match Value should only be used if either of the following conditions is true: This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of "service agreement ID" and a Match Value of the respective service agreement ID.
    Example: 995516242555
  • Maximum Length: 254
    Non CIS Comments
  • Maximum Length: 50
    Non CIS Name
  • payment
  • Maximum Length: 30
    Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the Customer Service Representative accepting payments that the account is cash-only.
  • Payment Amount
  • Maximum Length: 12
    Payment Event ID is the system-assigned unique identifier of the payment event.
    Example: 317772795000
  • Maximum Length: 254
    Message
  • Payment Segment Total
    Example: 28.43
  • Allowed Values: [ "10 ", "20 ", "30 ", "50 ", "60 " ]
    Payment Status is the payment's status. If the payment's status is Error , the error message is displayed adjacent. * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `50 ` - Frozen, * `60 ` - Canceled
    Example: 10
  • Maximum Length: 10
    The message description for Payment's Status.
  • Maximum Length: 30
    Reference Number
  • Minimum Value: -99999
    Maximum Value: 99999
    Version
Nested Schema : account
Type: object
Show Source
Nested Schema : bill
Type: object
Show Source
Nested Schema : cancelReason
Type: object
Show Source
Nested Schema : currency
Type: object
Show Source
Nested Schema : payment
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : C1PayEvtPay
Type: object
Show Source
Nested Schema : payments
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • account
  • bill
  • cancelReason
  • currency
  • Non-CIS Account Switch
    Example: false
  • Open Item Accounting Switch
    Example: false
  • Maximum Length: 8
    Match Type and Match Value should only be used if either of the following conditions is true: This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of "service agreement ID" and a Match Value of the respective service agreement ID.
    Example: BILL-ID (Bill ID / Sequential Bill Number)
  • Maximum Length: 30
    Match Type and Match Value should only be used if either of the following conditions is true: This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of "service agreement ID" and a Match Value of the respective service agreement ID.
    Example: 995516242555
  • Maximum Length: 254
    Non CIS Comments
  • Maximum Length: 50
    Non CIS Name
  • payment
  • Maximum Length: 30
    Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the Customer Service Representative accepting payments that the account is cash-only.
  • Payment Amount
  • Maximum Length: 12
    Payment Event ID is the system-assigned unique identifier of the payment event.
    Example: 317772795000
  • Maximum Length: 254
    Message
  • Payment Segment Total
    Example: 28.43
  • Allowed Values: [ "10 ", "20 ", "30 ", "50 ", "60 " ]
    Payment Status is the payment's status. If the payment's status is Error , the error message is displayed adjacent. * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `50 ` - Frozen, * `60 ` - Canceled
    Example: 10
  • Maximum Length: 10
    The message description for Payment's Status.
  • Maximum Length: 30
    Reference Number
  • Minimum Value: -99999
    Maximum Value: 99999
    Version
Nested Schema : account
Type: object
Show Source
Nested Schema : bill
Type: object
Show Source
Nested Schema : cancelReason
Type: object
Show Source
Nested Schema : currency
Type: object
Show Source
Nested Schema : payment
Type: object
Show Source

400 Response

Bad Request
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • Maximum Length: 60
    Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
  • Maximum Length: 60
    URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
  • serverMessage
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.

500 Response

Internal Server Error
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • Maximum Length: 60
    Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
  • Maximum Length: 60
    URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
  • serverMessage
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.
Back to Top