Get Pay Segments
get
/rest/apis/customer/financials/payments/{paymentId}/paySegments
Request
Path Parameters
-
paymentId(required): string
Payment ID is the system-assigned unique identifier of the payment.Example:
317896608844
Query Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1GetPaySegm
Type:
Show Source
object
-
_self: string
_self
-
account: object
account
-
hasMore: boolean
Has More
-
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Limit -
offset: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Offset -
payment: object
payment
-
paySegments: object
paySegments
-
totalNumberOfRecords: number
Minimum Value:
0
Maximum Value:99999
Total Number Of Records
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID identifies the customer who is responsible for the bill.Example:1112345900
Nested Schema : payment
Type:
Show Source
object
-
_link: string
_link
-
paymentId: string
Maximum Length:
12
Payment ID is the system-assigned unique identifier of the payment.Example:317896608844
Nested Schema : items
Type:
Show Source
object
-
adjustment: object
adjustment
-
currency: object
currency
-
financialTransaction: object
financialTransaction
-
matchEvent: object
matchEvent
-
paySegment: object
paySegment
-
paySegmentAmount: number
Distributed Amount is the amount of the service agreement's debt relieved by the payment.Example:
25.08
-
premise: object
premise
-
serviceAgreement: object
serviceAgreement
Nested Schema : adjustment
Type:
Show Source
object
-
_link: string
_link
-
adjustmentId: string
Maximum Length:
12
Adjustment ID
Nested Schema : currency
Type:
Show Source
object
-
_link: string
_link
-
currency: string
Maximum Length:
3
Currency Code
Nested Schema : financialTransaction
Type:
Show Source
object
-
_link: string
_link
-
financialTransactionId: string
Maximum Length:
12
Financial Transaction ID
Nested Schema : matchEvent
Type:
Show Source
object
-
_link: string
_link
-
matchEventId: string
Maximum Length:
12
Match Event ID
Nested Schema : paySegment
Type:
Show Source
object
-
_link: string
_link
-
paySegmentId: string
Maximum Length:
12
Pay Segment ID
Nested Schema : premise
Type:
Show Source
object
-
_link: string
_link
-
premiseId: string
Maximum Length:
10
Premise ID
Nested Schema : serviceAgreement
Type:
Show Source
object
-
_link: string
_link
-
serviceAgreementId: string
Maximum Length:
10
Service Agreement -
serviceAgreementTypeDescription: string
Maximum Length:
30
SA Type Description -
serviceType: string
Maximum Length:
80
Service Type
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.