Get Payment
get
https://server:port/spl/rest/apis/customer/financials/payments/{paymentId}
This operation handles the Integration Suite API to Get Payment
Request
Path 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 : C1-CxPayment
Type:
Show Source
object
-
_self: string
_self
-
account: object
account
-
accountCheckDigit: string
Maximum Length:
1
Account Check Digit -
cancelReason: string
Maximum Length:
30
If the payment is canceled , the Cancel Reason is displayed.Example:Data entry error
-
characteristics: object
characteristics
-
currency: object
currency
-
Exception: object
Exception
-
isNonCISAccount: boolean
Non-CIS Account SwitchExample:
true
-
isOpenItemAccounting: boolean
Open Item Accounting SwitchExample:
false
-
isPayTransfer: boolean
When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.Example:
true
-
matchType: object
matchType
Match Type and Match Value will only be used if either of the following conditions is true: The 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. Match Type and Match Value are gray after the payment is frozen.
-
matchValue: string
Maximum Length:
30
Match Type and Match Value will only be used if either of the following conditions is true: The 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. Match Type and Match Value are gray after the payment is frozen. -
nextActions: object
nextActions
-
nonCisComments: string
Maximum Length:
254
If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen): Name is the name of the person remitting the payment. Reference Number is the reference number of the item being paid (e.g., the property tax reference number). Comments are used to describe anything unusual about the non-CIS payment. -
nonCisName: string
Maximum Length:
50
If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen): Name is the name of the person remitting the payment. Reference Number is the reference number of the item being paid (e.g., the property tax reference number). Comments are used to describe anything unusual about the non-CIS payment.Example:ZZMXA,CX_test
-
nonCisReferenceNumber: string
Maximum Length:
30
If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen): Name is the name of the person remitting the payment. Reference Number is the reference number of the item being paid (e.g., the property tax reference number). Comments are used to describe anything unusual about the non-CIS 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 CSR accepting payments that the account is cash-only. -
paymentAmount: number
Payment Amount is the amount of the payment. This field is gray after the payment is frozen.Example:
300
-
paymentEvent: object
paymentEvent
-
paymentId: string
Maximum Length:
12
Payment ID is the system-assigned unique identifier of the payment.Example:317896608844
-
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
-
paySegments: object
paySegments
-
transferAccountId: string
Maximum Length:
10
Account ID is the account to which the payment event should be transferred. -
transferCancelReason: string
Maximum Length:
4
Cancel Reason defines why you are performing the payment event transfer.Example:NSF (Non sufficient funds)
-
transferMatchType: string
Maximum Length:
8
Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.Example:BILL-ID (Bill ID / Sequential Bill Number)
-
transferMatchValue: string
Maximum Length:
30
Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.Example:995516242555
-
transferNonCISComment: string
Maximum Length:
254
Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments. -
transferNonCisName: string
Maximum Length:
50
Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments. -
transferNonCisReferenceNumber: string
Maximum Length:
30
Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments. -
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:20
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID
Nested Schema : currency
Type:
Show Source
object
-
_link: string
_link
-
currency: string
Maximum Length:
3
Currency Code
Nested Schema : Exception
Type:
Show Source
object
-
callingProgramSequence: string
Maximum Length:
254
Calling Program Sequence -
comments: string
Maximum Length:
254
Comments -
creationDateTime: string
(date-time)
Create Date/TimeExample:
2010-11-24T17:49:23-05:00
-
expandedMessage: string
Maximum Length:
254
Expanded Message exceptionExample:The Payment is incomplete.
-
isReviewed: boolean
ReviewedExample:
false
-
messageCategory: object
messageCategory
Message category within Oracle Utilities Application Framework.
-
messageNumber: number
Minimum Value:
-99999
Maximum Value:99999
Message number within Oracle Utilities Application Framework.Example:14107
-
messageParameter1: string
Maximum Length:
2000
Message Parameter -
messageParameter2: string
Maximum Length:
2000
Message Parameter -
messageParameter3: string
Maximum Length:
2000
Message Parameter -
messageParameter4: string
Maximum Length:
2000
Message Parameter -
messageParameter5: string
Maximum Length:
2000
Message Parameter -
messageParameter6: string
Maximum Length:
2000
Message Parameter -
messageParameter7: string
Maximum Length:
2000
Message Parameter -
messageParameter8: string
Maximum Length:
2000
Message Parameter -
messageParameter9: string
Maximum Length:
2000
Message Parameter -
paymentExceptionType: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 " ]
Payment Exception Type * `10 ` - No Payment Segment found, * `20 ` - No SA found for this acct., * `30 ` - Unbalanced Payment, * `40 ` - Payment in errorExample:40
-
reviewedDate: string
(date)
Review Date
-
reviewUser: object
reviewUser
Review User
-
user: object
user
User
-
version: number
Minimum Value:
0
Maximum Value:0
The Version number is used for internal concurrency checks.Example:1
Nested Schema : matchType
Type:
object
Match Type and Match Value will only be used if either of the following conditions is true:
The 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.
Match Type and Match Value are gray after the payment is frozen.
Show Source
-
_link: string
_link
-
matchType: string
Maximum Length:
8
Match Type and Match Value will only be used if either of the following conditions is true: The 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. Match Type and Match Value are gray after the payment is frozen.
Nested Schema : paymentEvent
Type:
Show Source
object
-
_link: string
_link
-
PayEventException: string
Maximum Length:
30
Exception Messages -
paymentEventId: string
Maximum Length:
12
Payment Event ID is the system-assigned unique identifier of the payment event.Example:317772795000
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence Controls the order in which characteristics of the same type are displayed.Example:1
-
typeOfCharacteristicValue: string
Maximum Length:
4
Type of Char Value -
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:20
Nested Schema : characteristicType
Type:
Show Source
object
-
_link: string
_link
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : messageCategory
Type:
object
Message category within Oracle Utilities Application Framework.
Show Source
-
_link: string
_link
-
messageCategory: number
Minimum Value:
-99999
Maximum Value:99999
Message category within Oracle Utilities Application Framework.Example:11
Nested Schema : reviewUser
Type:
object
Review User
Show Source
-
_link: string
_link
-
reviewUser: string
Maximum Length:
8
Review User
Nested Schema : user
Type:
object
User
Show Source
-
_link: string
_link
-
user: string
Maximum Length:
8
User
Nested Schema : items
Type:
Show Source
object
-
_link: string
(_link)
-
actionName: string
(actionName)
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
-
serviceAgreement: object
serviceAgreement
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
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 : serviceAgreement
Type:
Show Source
object
-
_link: string
_link
-
serviceAgreement: string
Maximum Length:
10
Service Agreement
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.