Get Payment Summary
get
https://server:port/spl/rest/apis/customer/financials/payments/{paymentId}/summary
Request
Path Parameters
-
paymentId(required): string
Payment ID is the system-assigned unique identifier of the payment.Example:
317896608844
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1PaySumry
Type:
Show Source
object
-
currency: object
currency
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:GET
-
payment: object
payment
-
paymentAmount: number
Payment Amount is the amount of the payment. This field is gray after the payment is frozen.Example:
300
-
paymentDate: string
(date)
Payment Date is the business date associated with the payment event.Example:
2000-10-16
-
paymentStatus: string
Allowed Values:
[ "10 ", "20 ", "30 ", "50 ", "60 " ]
Payment Status is the payment's status. * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `50 ` - Frozen, * `60 ` - CanceledExample:30
-
paymentStatusDescription: string
Maximum Length:
60
Description for payment status.Example:Frozen
-
paymentSummary: object
paymentSummary
-
paymentTenders: array
paymentTenders
-
paySegments: array
paySegments
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 is the system-assigned unique identifier of the payment.Example:317896608844
Nested Schema : paymentSummary
Type:
Show Source
object
-
paymentByServiceType: array
paymentByServiceType
-
segmentCount: number
Minimum Value:
0
Maximum Value:999
Segment CountExample:1
-
tenderCount: number
Minimum Value:
0
Maximum Value:999
Tender CountExample:1
Nested Schema : items
Type:
Show Source
object
-
segmentCount: number
Minimum Value:
0
Maximum Value:999
Segment CountExample:1
-
serviceType: string
Maximum Length:
80
Service Type defines the type of service associated with the SA type.Example:E
-
totalDistributedAmount: number
Total distributed amountExample:
75
Nested Schema : items
Type:
Show Source
object
-
autopayIndicator: boolean
AutopayIndicator indicates if payment was triggered by autopay processing from the TenderType field 'generates AutoPay'.Example:
false
-
cancelReason: object
cancelReason
-
currency: object
currency
-
payorAccountName: string
Maximum Length:
30
Payor Account Name -
tenderAmount: number
Tender Amount is the amount of the tender.Example:
125
-
tenderStatus: string
Maximum Length:
2
Tender Status is the tender's status.Example:25
-
tenderStatusDescription: string
Maximum Length:
60
Description for tender status.Example:Valid
-
tenderType: object
tenderType
Tender Type describes what was remitted. For example, cash or check.
Nested Schema : cancelReason
Type:
Show Source
object
-
_link: string
_link
-
cancelReason: string
Maximum Length:
4
Cancel Reason -
cancelReasonDescription: string
Maximum Length:
100
Cancel Reason Description
Nested Schema : currency
Type:
Show Source
object
-
_link: string
_link
-
currency: string
Maximum Length:
3
Currency Code
Nested Schema : tenderType
Type:
object
Tender Type describes what was remitted. For example, cash or check.
Show Source
-
_link: string
_link
-
tenderType: string
Maximum Length:
4
Tender Type describes what was remitted. For example, cash or check.Example:CHEC
-
tenderTypeDescription: string
Maximum Length:
60
Tender Type describes what was remitted. For example, cash or check.Example:CHEC
Nested Schema : items
Type:
Show Source
object
-
distributedAmount: number
Total distributed amountExample:
75
-
paySegmentId: string
Maximum Length:
12
Pay Segment ID -
premise: object
premise
-
serviceAgreement: object
serviceAgreement
-
serviceAgreementType: object
serviceAgreementType
Service Agreement Type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.
-
serviceType: object
serviceType
Service Type defines the type of service associated with the SA type.
Nested Schema : premise
Type:
Show Source
object
-
_link: string
_link
-
premiseAddress: string
Maximum Length:
254
Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement. -
premiseId: string
Maximum Length:
10
Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.
Nested Schema : serviceAgreement
Type:
Show Source
object
-
_link: string
_link
-
serviceAgreementId: string
Maximum Length:
10
SA ID is the bill segment's service agreement.Example:0340281111
-
statusCode: string
Allowed Values:
[ "05 ", "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]
SA ID is the bill segment's service agreement. * `05 ` - Incomplete, * `10 ` - Pending Start, * `20 ` - Active, * `30 ` - Pending Stop, * `40 ` - Stopped, * `50 ` - Reactivated, * `60 ` - Closed, * `70 ` - CanceledExample:0340281111
-
statusCodeDescription: string
Maximum Length:
60
SA ID is the bill segment's service agreement.Example:0340281111
Nested Schema : serviceAgreementType
Type:
object
Service Agreement Type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.
Show Source
-
_link: string
_link
-
division: string
Maximum Length:
5
CIS Division defines the jurisdiction that governs the account.Example:CA
-
divisionDescription: string
Maximum Length:
1
CIS Division defines the jurisdiction that governs the account.Example:CA
-
serviceAgreementType: string
Maximum Length:
8
CIS Division defines the jurisdiction that governs the account.Example:CA
-
serviceAgreementTypeDescription: string
Maximum Length:
30
CIS Division defines the jurisdiction that governs the account.Example:CA
Nested Schema : serviceType
Type:
object
Service Type defines the type of service associated with the SA type.
Show Source
-
_link: string
_link
-
serviceType: string
Maximum Length:
80
Service Type defines the type of service associated with the SA type.Example:E
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.