Search Payment Event Payments
post
https://server:port/spl/rest/apis/customer/financials/paymentEvents/payments/search
This operation retrieves all payments details for the provided input Payment Event Id.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
count: number
Minimum Value:
0
Maximum Value:99999
Count -
filters: object
filters
-
hasMore: boolean
Has More
-
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Limit -
offset: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Offset -
paymentEventId: string
Maximum Length:
12
Payment Event ID is the system-assigned unique identifier of the payment event.Example:317772795000
-
payments: object
payments
-
totalnumberOfrecords: number
Minimum Value:
0
Maximum Value:99999
Total Number Of Records
Nested Schema : filters
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID -
personName: string
Maximum Length:
30
Person Name
Nested Schema : items
Type:
Show Source
object
-
account: object
account
-
bill: object
bill
-
cancelReason: object
cancelReason
-
currency: object
currency
-
isNonCisPayment: boolean
Non-CIS Account SwitchExample:
false
-
isOpenItemAccounting: boolean
Open Item Accounting SwitchExample:
false
-
matchType: string
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)
-
matchValue: string
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
-
nonCisComments: string
Maximum Length:
254
Non CIS Comments -
nonCisName: string
Maximum Length:
50
Non CIS Name -
payment: object
payment
-
paymentAccountCash: string
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. -
paymentAmount: number
Payment Amount
-
paymentEventId: string
Maximum Length:
12
Payment Event ID is the system-assigned unique identifier of the payment event.Example:317772795000
-
paymentException: string
Maximum Length:
254
Message -
paymentSegmentTotal: number
Payment Segment TotalExample:
28.43
-
paymentStatus: string
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 ` - CanceledExample:10
-
payStatusMessage: string
Maximum Length:
10
The message description for Payment's Status. -
referenceNumber: string
Maximum Length:
30
Reference Number -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : bill
Type:
Show Source
object
-
billDate: string
(date)
Bill Date
-
billId: string
Maximum Length:
12
Bill ID -
billTotal: number
Bill Total
Nested Schema : cancelReason
Type:
Show Source
object
-
cancelReason: string
Maximum Length:
4
Cancel Reason
Root Schema : schema
Type:
Show Source
object
-
count: number
Minimum Value:
0
Maximum Value:99999
Count -
filters: object
filters
-
hasMore: boolean
Has More
-
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Limit -
offset: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Offset -
paymentEventId: string
Maximum Length:
12
Payment Event ID is the system-assigned unique identifier of the payment event.Example:317772795000
-
payments: object
payments
-
totalnumberOfrecords: number
Minimum Value:
0
Maximum Value:99999
Total Number Of Records
Nested Schema : filters
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID -
personName: string
Maximum Length:
30
Person Name
Nested Schema : items
Type:
Show Source
object
-
account: object
account
-
bill: object
bill
-
cancelReason: object
cancelReason
-
currency: object
currency
-
isNonCisPayment: boolean
Non-CIS Account SwitchExample:
false
-
isOpenItemAccounting: boolean
Open Item Accounting SwitchExample:
false
-
matchType: string
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)
-
matchValue: string
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
-
nonCisComments: string
Maximum Length:
254
Non CIS Comments -
nonCisName: string
Maximum Length:
50
Non CIS Name -
payment: object
payment
-
paymentAccountCash: string
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. -
paymentAmount: number
Payment Amount
-
paymentEventId: string
Maximum Length:
12
Payment Event ID is the system-assigned unique identifier of the payment event.Example:317772795000
-
paymentException: string
Maximum Length:
254
Message -
paymentSegmentTotal: number
Payment Segment TotalExample:
28.43
-
paymentStatus: string
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 ` - CanceledExample:10
-
payStatusMessage: string
Maximum Length:
10
The message description for Payment's Status. -
referenceNumber: string
Maximum Length:
30
Reference Number -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : bill
Type:
Show Source
object
-
billDate: string
(date)
Bill Date
-
billId: string
Maximum Length:
12
Bill ID -
billTotal: number
Bill Total
Nested Schema : cancelReason
Type:
Show Source
object
-
cancelReason: string
Maximum Length:
4
Cancel Reason
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1PayEvtPay
Type:
Show Source
object
-
count: number
Minimum Value:
0
Maximum Value:99999
Count -
hasMore: boolean
Has More
-
payments: object
payments
-
totalnumberOfrecords: number
Minimum Value:
0
Maximum Value:99999
Total Number Of Records
Nested Schema : items
Type:
Show Source
object
-
account: object
account
-
bill: object
bill
-
cancelReason: object
cancelReason
-
currency: object
currency
-
isNonCisPayment: boolean
Non-CIS Account SwitchExample:
false
-
isOpenItemAccounting: boolean
Open Item Accounting SwitchExample:
false
-
matchType: string
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)
-
matchValue: string
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
-
nonCisComments: string
Maximum Length:
254
Non CIS Comments -
nonCisName: string
Maximum Length:
50
Non CIS Name -
payment: object
payment
-
paymentAccountCash: string
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. -
paymentAmount: number
Payment Amount
-
paymentEventId: string
Maximum Length:
12
Payment Event ID is the system-assigned unique identifier of the payment event.Example:317772795000
-
paymentException: string
Maximum Length:
254
Message -
paymentSegmentTotal: number
Payment Segment TotalExample:
28.43
-
paymentStatus: string
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 ` - CanceledExample:10
-
payStatusMessage: string
Maximum Length:
10
The message description for Payment's Status. -
referenceNumber: string
Maximum Length:
30
Reference Number -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID
Nested Schema : bill
Type:
Show Source
object
-
_link: string
_link
-
billDate: string
(date)
Bill Date
-
billId: string
Maximum Length:
12
Bill ID -
billTotal: number
Bill Total
Nested Schema : cancelReason
Type:
Show Source
object
-
_link: string
_link
-
cancelReason: string
Maximum Length:
4
Cancel Reason
Nested Schema : currency
Type:
Show Source
object
-
_link: string
_link
-
currency: string
Maximum Length:
3
Currency Code
Nested Schema : payment
Type:
Show Source
object
-
_link: string
_link
-
paymentId: string
Maximum Length:
12
Payment ID
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
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. -
problemType: string
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: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
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. -
problemType: string
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: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.