Create Payment Event
post
https://server:port/spl/rest/apis/customer/financials/paymentEvents/
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
account: object
account
-
account2: object
account2
-
account3: object
account3
-
accountNumber: string
Maximum Length:
50
Account Number -
accountT: object
accountT
-
bank: string
Maximum Length:
5
Define the Bank Code and Bank Account into which the tender source's funds will be deposited. The bank account defines the distribution code used to build the General Ledger details for the payment. -
cancelReason: object
cancelReason
-
canDistribute: boolean
Defining Distribute as true distributes all Incomplete, Error, or Freezable payments linked to the event.Example:
false
-
characteristics: object
characteristics
-
characteristicValueDescription: string
Maximum Length:
60
Char Value Description -
characteristicValueForeignKeyInformation: string
Maximum Length:
254
Characteristic Value Foreign Key Information -
characteristicValueForeignKeys: string
Maximum Length:
254
Characteristic Value Foreign Keys -
charateristicValue: string
Maximum Length:
150
Characteristic Value Indicates the value of the characteristic. -
creationDateTime: string
(date-time)
Create Date/Time
-
currency: object
currency
-
description: string
Maximum Length:
60
Description -
document: object
document
-
entityName2: string
Maximum Length:
254
Name -
exceptions: object
exceptions
-
hasTransfer: boolean
The Transfer button is enabled if: There is a single non-cancelled tender linked to the event AND There is a single frozen payment linked to the event AND The account on the tender is the same as the account on the payment.Example:
false
-
isNonCisAccount: boolean
Non CIS Switch is defined as true if the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments.
-
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 -
nonCisSaId: string
Maximum Length:
10
Non CIS Service Agreement ID for account that belongs to a customer class that is used for non-CIS payments. -
numberOfPayments: number
Minimum Value:
0
Maximum Value:9.99999999999999E14
Payment Number -
numberOfTenders: number
Minimum Value:
0
Maximum Value:9.99999999999999E14
Tender Number -
payEventAlternateCurrency: object
payEventAlternateCurrency
-
paymentAmount: number
Payment Amount
-
paymentDate: string
(date)
Payment Date is the business date associated with the payment event.
-
paymentEventException: string
Maximum Length:
254
Message -
paymentEventId2: string
Maximum Length:
30
Payment Event ID is the system-assigned unique identifier of the payment event.Example:755669969777
-
payments: object
payments
-
paymentTemplate: string
Maximum Length:
12
Payment Templates can be configured for common types of payment allocations to pre-populate the payment distribution and allowing non-CIS payments to be directly allocated against distribution codes. -
paymentTenders: object
paymentTenders
-
paymentTotalAmount: number
Payment Total Amount
-
payorAccount: object
payorAccount
-
referenceNumber: string
Maximum Length:
30
Reference Number -
shouldAllPaymentsFreeze: boolean
Defining Freeze as true causes all Freezable payments linked to the event to become frozen.Example:
false
-
shouldOverrideTenderAuthorization: boolean
The Authorization Override checkbox is only displayed if the tender type selected requires authorization. Use the Authorization override checkbox to indicate whether or not tender authorization should take place. If Authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call.
-
tenderAuthorizationCode: string
Maximum Length:
60
If authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call. -
tenderReversal: string
Maximum Length:
10
Tender Reversal Code -
tenderSource: string
Maximum Length:
8
Tender Source is the source of the tenders. For example, cash drawer 22, lockbox 1 at Bank of America.Example:ACH (Auto pay)
-
tenderTotalAmount: number
Tender Amount contains the amount of the tender.
-
tenderType: object
tenderType
-
totTenderAmt: number
Total Tender Amount is the total amount of all tenders linked to the tender control.
-
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. -
user: object
user
USER ID
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : account2
Type:
Show Source
object
-
accountId2: string
Maximum Length:
30
Account ID references the payment's account. The name of the account's main customer is displayed adjacent.
Nested Schema : account3
Type:
Show Source
object
-
acctId3: string
Maximum Length:
10
Reversal Account ID
Nested Schema : accountT
Type:
Show Source
object
-
accountIdT: string
Maximum Length:
10
Account ID references the payment's account. The name of the account's main customer is displayed adjacent.
Nested Schema : cancelReason
Type:
Show Source
object
-
cancelReason: string
Maximum Length:
4
Cancel Reason
Nested Schema : exceptions
Type:
Show Source
object
-
comments2: string
Maximum Length:
254
Comments -
creationDateTime2: string
(date-time)
Create Date/TimeExample:
2010-11-24T17:49:23-05:00
-
expandedMessage2: string
Maximum Length:
254
Message -
isReviewed2: boolean
ReviewedExample:
false
-
messageCategory2: number
Minimum Value:
-99999
Maximum Value:99999
Message category within Oracle Utilities Application FrameworkExample:11
-
messageNumber2: number
Minimum Value:
-99999
Maximum Value:99999
Message number within Oracle Utilities Application Framework.Example:14107
-
messageParameter12: string
Maximum Length:
2000
Message ParameterExample:.
-
messageParameter22: string
Maximum Length:
2000
Message Parameter -
messageParameter32: string
Maximum Length:
2000
Message Parameter -
messageParameter42: string
Maximum Length:
2000
Message Parameter -
messageParameter52: string
Maximum Length:
2000
Message Parameter -
messageParameter62: string
Maximum Length:
2000
Message Parameter -
messageParameter72: string
Maximum Length:
2000
Message Parameter -
messageParameter82: string
Maximum Length:
2000
Message Parameter -
messageParameter92: string
Maximum Length:
2000
Message Parameter -
paymentEventExceptionType: string
Allowed Values:
[ "10 ", "20 " ]
Payment Exception Type * `10 ` - Unbalanced Event, * `20 ` - Unfrozen PaymentExample:20
-
paymentEventId: string
Maximum Length:
12
Payment Event ID is the system-assigned unique identifier of the payment event.Example:317772795000
-
reviewedDate2: string
(date)
Review Date
-
reviewUser2: string
Maximum Length:
8
Review User -
userId2: string
Maximum Length:
30
User -
version23: number
Minimum Value:
0
Maximum Value:0
Version2
Nested Schema : payEventAlternateCurrency
Type:
Show Source
object
-
payEventAlternateCurrency: string
Maximum Length:
1
Pay Event Alternate Currency Info
Nested Schema : payorAccount
Type:
Show Source
object
-
payorAccountId: string
Maximum Length:
10
Account ID
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
typeOfCharacteristicValue: string
Maximum Length:
4
Characteristic Value Indicate the value of the characteristic.Example:02-20-2008
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : characteristicType
Type:
Show Source
object
-
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 : items
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID -
bill: object
bill
-
cancelReason: object
cancelReason
-
currency: string
Maximum Length:
3
Currency Code -
isNonCisPayment: boolean
Non-CIS Account SwitchExample:
false
-
isOpenItemAccounting: boolean
Open Item Accounting SwitchExample:
false
-
matchType: string
Maximum Length:
8
Match Type -
matchValue: string
Maximum Length:
30
Match Value -
nextActions: object
nextActions
-
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
-
paymentEventId2: 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 -
paymentId2: string
Maximum Length:
12
Payment ID -
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
Payment Status Message -
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
Nested Schema : items
Type:
Show Source
object
-
adjustment: object
adjustment
-
alternateCurrency: string
Maximum Length:
3
Alternate Currency Code -
altTenderAmount: number
Minimum Value:
-9.99999999999999E12
Maximum Value:9.99999999999999E12
Alternate Amount -
cancelReason: object
cancelReason
-
characteristics: object
characteristics
-
checkNumber: string
Maximum Length:
10
Check Number -
currency: string
Maximum Length:
3
Currency Code -
customerId: string
Maximum Length:
36
Customer ID is the customer's account ID that appeared on the interfaced payment. -
encryptedMicrId: string
Maximum Length:
64
Encrypted Micr ID -
externalAccountId: string
Maximum Length:
50
External Account ID is the customer's account number at the financial institution. -
externalReferenceId: string
Maximum Length:
36
External Reference ID -
hasCancelTender: boolean
(hasCancelTender)
-
hasCashTendered: boolean
(hasCashTendered)
-
hashMicrId: string
Maximum Length:
88
Hash MICR ID -
isIncludedInTenderControlBalance: boolean
Turn off Included in Tender Ctl Balance if the tender should not be included in the tender amount in the tender control's tender balance. You would turn this switch off if you canceled a tender because it was mistakenly applied to the wrong account (or the amount was wrong). This switch is only enabled if: The tender control is not balanced. The tender is canceled.
-
isTenderTypeAuthorized: boolean
(isTenderTypeAuthorized)
-
micrId: string
Maximum Length:
30
MICR ID -
name: string
Maximum Length:
40
Name is the customer's name on the interfaced payment record. -
paymentTender: object
paymentTender
-
payorAccountId: string
Maximum Length:
10
Account ID -
tenderAmount: number
Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency.
-
tenderControl: object
tenderControl
-
tenderStatus: string
Allowed Values:
[ "25 ", "60 " ]
Tender Status is the tender's status. * `25 ` - Valid, * `60 ` - CanceledExample:Valid
-
tenderType: string
Maximum Length:
4
Tender Type -
tenderTypeNonCredit: string
(tenderTypeNonCredit)
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : adjustment
Type:
Show Source
object
-
adjustmentId: string
Maximum Length:
12
Adjustment ID
Nested Schema : cancelReason
Type:
Show Source
object
-
cancelReason: string
Maximum Length:
4
Cancel Reason
Nested Schema : paymentTender
Type:
Show Source
object
-
paymentTenderId: string
Maximum Length:
12
Pay Tender ID
Nested Schema : tenderControl
Type:
Show Source
object
-
tenderControlId: string
Maximum Length:
10
Tender Control ID
Nested Schema : items
Type:
Show Source
object
-
adhocCharacteristicValue: string
Maximum Length:
254
Adhoc Characteristic Value -
characteristicType: object
characteristicType
-
characteristicValue: string
(characteristicValue3)
-
characteristicValueForeignKey: object
characteristicValueForeignKey
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
(characteristicType5)
Nested Schema : characteristicValueForeignKey
Type:
Show Source
object
-
characteristicValueForeignKey: string
(characteristicValueForeignKey12)
Nested Schema : items
Type:
Show Source
object
-
alternateCurrency: object
alternateCurrency
-
alternateTenderAmount: number
Minimum Value:
-9.99999999999999E12
Maximum Value:9.99999999999999E12
Alternate Amount -
checkNumber: string
Maximum Length:
10
Check Number -
comment: string
Maximum Length:
254
Use Comments to describe anything unusual about the tender control. For example, comments can explain why a large over/under amount was created. -
externalReferenceId: string
Maximum Length:
36
External Reference ID -
hashMicrId: string
Maximum Length:
88
Hash MICR ID -
micrId: string
Maximum Length:
30
MICR ID -
tenderedAmount: number
Amount Tendered contains the amount that was tendered by the customer.
-
tenderType: string
Maximum Length:
4
Tender Type
Nested Schema : alternateCurrency
Type:
Show Source
object
-
alternateCurrency: string
Maximum Length:
3
Alternate Currency Code
Root Schema : schema
Type:
Show Source
object
-
account: object
account
-
account2: object
account2
-
account3: object
account3
-
accountNumber: string
Maximum Length:
50
Account Number -
accountT: object
accountT
-
bank: string
Maximum Length:
5
Define the Bank Code and Bank Account into which the tender source's funds will be deposited. The bank account defines the distribution code used to build the General Ledger details for the payment. -
cancelReason: object
cancelReason
-
canDistribute: boolean
Defining Distribute as true distributes all Incomplete, Error, or Freezable payments linked to the event.Example:
false
-
characteristics: object
characteristics
-
characteristicValueDescription: string
Maximum Length:
60
Char Value Description -
characteristicValueForeignKeyInformation: string
Maximum Length:
254
Characteristic Value Foreign Key Information -
characteristicValueForeignKeys: string
Maximum Length:
254
Characteristic Value Foreign Keys -
charateristicValue: string
Maximum Length:
150
Characteristic Value Indicates the value of the characteristic. -
creationDateTime: string
(date-time)
Create Date/Time
-
currency: object
currency
-
description: string
Maximum Length:
60
Description -
document: object
document
-
entityName2: string
Maximum Length:
254
Name -
exceptions: object
exceptions
-
hasTransfer: boolean
The Transfer button is enabled if: There is a single non-cancelled tender linked to the event AND There is a single frozen payment linked to the event AND The account on the tender is the same as the account on the payment.Example:
false
-
isNonCisAccount: boolean
Non CIS Switch is defined as true if the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments.
-
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 -
nonCisSaId: string
Maximum Length:
10
Non CIS Service Agreement ID for account that belongs to a customer class that is used for non-CIS payments. -
numberOfPayments: number
Minimum Value:
0
Maximum Value:9.99999999999999E14
Payment Number -
numberOfTenders: number
Minimum Value:
0
Maximum Value:9.99999999999999E14
Tender Number -
payEventAlternateCurrency: object
payEventAlternateCurrency
-
paymentAmount: number
Payment Amount
-
paymentDate: string
(date)
Payment Date is the business date associated with the payment event.
-
paymentEventException: string
Maximum Length:
254
Message -
paymentEventId2: string
Maximum Length:
30
Payment Event ID is the system-assigned unique identifier of the payment event.Example:755669969777
-
payments: object
payments
-
paymentTemplate: string
Maximum Length:
12
Payment Templates can be configured for common types of payment allocations to pre-populate the payment distribution and allowing non-CIS payments to be directly allocated against distribution codes. -
paymentTenders: object
paymentTenders
-
paymentTotalAmount: number
Payment Total Amount
-
payorAccount: object
payorAccount
-
referenceNumber: string
Maximum Length:
30
Reference Number -
shouldAllPaymentsFreeze: boolean
Defining Freeze as true causes all Freezable payments linked to the event to become frozen.Example:
false
-
shouldOverrideTenderAuthorization: boolean
The Authorization Override checkbox is only displayed if the tender type selected requires authorization. Use the Authorization override checkbox to indicate whether or not tender authorization should take place. If Authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call.
-
tenderAuthorizationCode: string
Maximum Length:
60
If authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call. -
tenderReversal: string
Maximum Length:
10
Tender Reversal Code -
tenderSource: string
Maximum Length:
8
Tender Source is the source of the tenders. For example, cash drawer 22, lockbox 1 at Bank of America.Example:ACH (Auto pay)
-
tenderTotalAmount: number
Tender Amount contains the amount of the tender.
-
tenderType: object
tenderType
-
totTenderAmt: number
Total Tender Amount is the total amount of all tenders linked to the tender control.
-
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. -
user: object
user
USER ID
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : account2
Type:
Show Source
object
-
accountId2: string
Maximum Length:
30
Account ID references the payment's account. The name of the account's main customer is displayed adjacent.
Nested Schema : account3
Type:
Show Source
object
-
acctId3: string
Maximum Length:
10
Reversal Account ID
Nested Schema : accountT
Type:
Show Source
object
-
accountIdT: string
Maximum Length:
10
Account ID references the payment's account. The name of the account's main customer is displayed adjacent.
Nested Schema : cancelReason
Type:
Show Source
object
-
cancelReason: string
Maximum Length:
4
Cancel Reason
Nested Schema : exceptions
Type:
Show Source
object
-
comments2: string
Maximum Length:
254
Comments -
creationDateTime2: string
(date-time)
Create Date/TimeExample:
2010-11-24T17:49:23-05:00
-
expandedMessage2: string
Maximum Length:
254
Message -
isReviewed2: boolean
ReviewedExample:
false
-
messageCategory2: number
Minimum Value:
-99999
Maximum Value:99999
Message category within Oracle Utilities Application FrameworkExample:11
-
messageNumber2: number
Minimum Value:
-99999
Maximum Value:99999
Message number within Oracle Utilities Application Framework.Example:14107
-
messageParameter12: string
Maximum Length:
2000
Message ParameterExample:.
-
messageParameter22: string
Maximum Length:
2000
Message Parameter -
messageParameter32: string
Maximum Length:
2000
Message Parameter -
messageParameter42: string
Maximum Length:
2000
Message Parameter -
messageParameter52: string
Maximum Length:
2000
Message Parameter -
messageParameter62: string
Maximum Length:
2000
Message Parameter -
messageParameter72: string
Maximum Length:
2000
Message Parameter -
messageParameter82: string
Maximum Length:
2000
Message Parameter -
messageParameter92: string
Maximum Length:
2000
Message Parameter -
paymentEventExceptionType: string
Allowed Values:
[ "10 ", "20 " ]
Payment Exception Type * `10 ` - Unbalanced Event, * `20 ` - Unfrozen PaymentExample:20
-
paymentEventId: string
Maximum Length:
12
Payment Event ID is the system-assigned unique identifier of the payment event.Example:317772795000
-
reviewedDate2: string
(date)
Review Date
-
reviewUser2: string
Maximum Length:
8
Review User -
userId2: string
Maximum Length:
30
User -
version23: number
Minimum Value:
0
Maximum Value:0
Version2
Nested Schema : payEventAlternateCurrency
Type:
Show Source
object
-
payEventAlternateCurrency: string
Maximum Length:
1
Pay Event Alternate Currency Info
Nested Schema : payorAccount
Type:
Show Source
object
-
payorAccountId: string
Maximum Length:
10
Account ID
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
typeOfCharacteristicValue: string
Maximum Length:
4
Characteristic Value Indicate the value of the characteristic.Example:02-20-2008
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : characteristicType
Type:
Show Source
object
-
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 : items
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID -
bill: object
bill
-
cancelReason: object
cancelReason
-
currency: string
Maximum Length:
3
Currency Code -
isNonCisPayment: boolean
Non-CIS Account SwitchExample:
false
-
isOpenItemAccounting: boolean
Open Item Accounting SwitchExample:
false
-
matchType: string
Maximum Length:
8
Match Type -
matchValue: string
Maximum Length:
30
Match Value -
nextActions: object
nextActions
-
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
-
paymentEventId2: 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 -
paymentId2: string
Maximum Length:
12
Payment ID -
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
Payment Status Message -
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
Nested Schema : items
Type:
Show Source
object
-
adjustment: object
adjustment
-
alternateCurrency: string
Maximum Length:
3
Alternate Currency Code -
altTenderAmount: number
Minimum Value:
-9.99999999999999E12
Maximum Value:9.99999999999999E12
Alternate Amount -
cancelReason: object
cancelReason
-
characteristics: object
characteristics
-
checkNumber: string
Maximum Length:
10
Check Number -
currency: string
Maximum Length:
3
Currency Code -
customerId: string
Maximum Length:
36
Customer ID is the customer's account ID that appeared on the interfaced payment. -
encryptedMicrId: string
Maximum Length:
64
Encrypted Micr ID -
externalAccountId: string
Maximum Length:
50
External Account ID is the customer's account number at the financial institution. -
externalReferenceId: string
Maximum Length:
36
External Reference ID -
hasCancelTender: boolean
(hasCancelTender)
-
hasCashTendered: boolean
(hasCashTendered)
-
hashMicrId: string
Maximum Length:
88
Hash MICR ID -
isIncludedInTenderControlBalance: boolean
Turn off Included in Tender Ctl Balance if the tender should not be included in the tender amount in the tender control's tender balance. You would turn this switch off if you canceled a tender because it was mistakenly applied to the wrong account (or the amount was wrong). This switch is only enabled if: The tender control is not balanced. The tender is canceled.
-
isTenderTypeAuthorized: boolean
(isTenderTypeAuthorized)
-
micrId: string
Maximum Length:
30
MICR ID -
name: string
Maximum Length:
40
Name is the customer's name on the interfaced payment record. -
paymentTender: object
paymentTender
-
payorAccountId: string
Maximum Length:
10
Account ID -
tenderAmount: number
Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency.
-
tenderControl: object
tenderControl
-
tenderStatus: string
Allowed Values:
[ "25 ", "60 " ]
Tender Status is the tender's status. * `25 ` - Valid, * `60 ` - CanceledExample:Valid
-
tenderType: string
Maximum Length:
4
Tender Type -
tenderTypeNonCredit: string
(tenderTypeNonCredit)
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : adjustment
Type:
Show Source
object
-
adjustmentId: string
Maximum Length:
12
Adjustment ID
Nested Schema : cancelReason
Type:
Show Source
object
-
cancelReason: string
Maximum Length:
4
Cancel Reason
Nested Schema : paymentTender
Type:
Show Source
object
-
paymentTenderId: string
Maximum Length:
12
Pay Tender ID
Nested Schema : tenderControl
Type:
Show Source
object
-
tenderControlId: string
Maximum Length:
10
Tender Control ID
Nested Schema : items
Type:
Show Source
object
-
adhocCharacteristicValue: string
Maximum Length:
254
Adhoc Characteristic Value -
characteristicType: object
characteristicType
-
characteristicValue: string
(characteristicValue3)
-
characteristicValueForeignKey: object
characteristicValueForeignKey
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
(characteristicType5)
Nested Schema : characteristicValueForeignKey
Type:
Show Source
object
-
characteristicValueForeignKey: string
(characteristicValueForeignKey12)
Nested Schema : items
Type:
Show Source
object
-
alternateCurrency: object
alternateCurrency
-
alternateTenderAmount: number
Minimum Value:
-9.99999999999999E12
Maximum Value:9.99999999999999E12
Alternate Amount -
checkNumber: string
Maximum Length:
10
Check Number -
comment: string
Maximum Length:
254
Use Comments to describe anything unusual about the tender control. For example, comments can explain why a large over/under amount was created. -
externalReferenceId: string
Maximum Length:
36
External Reference ID -
hashMicrId: string
Maximum Length:
88
Hash MICR ID -
micrId: string
Maximum Length:
30
MICR ID -
tenderedAmount: number
Amount Tendered contains the amount that was tendered by the customer.
-
tenderType: string
Maximum Length:
4
Tender Type
Nested Schema : alternateCurrency
Type:
Show Source
object
-
alternateCurrency: string
Maximum Length:
3
Alternate Currency Code
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1-PayEvent
Type:
Show Source
object
-
_self: string
_self
-
account: object
account
-
account2: object
account2
-
account3: object
account3
-
accountNumber: string
Maximum Length:
50
Account Number -
accountT: object
accountT
-
bank: string
Maximum Length:
5
Define the Bank Code and Bank Account into which the tender source's funds will be deposited. The bank account defines the distribution code used to build the General Ledger details for the payment. -
cancelReason: object
cancelReason
-
canDistribute: boolean
Defining Distribute as true distributes all Incomplete, Error, or Freezable payments linked to the event.Example:
false
-
characteristics: object
characteristics
-
characteristicValueDescription: string
Maximum Length:
60
Char Value Description -
characteristicValueForeignKeyInformation: string
Maximum Length:
254
Characteristic Value Foreign Key Information -
characteristicValueForeignKeys: string
Maximum Length:
254
Characteristic Value Foreign Keys -
charateristicValue: string
Maximum Length:
150
Characteristic Value Indicates the value of the characteristic. -
creationDateTime: string
(date-time)
Create Date/Time
-
currency: object
currency
-
description: string
Maximum Length:
60
Description -
document: object
document
-
entityName2: string
Maximum Length:
254
Name -
exceptions: object
exceptions
-
hasTransfer: boolean
The Transfer button is enabled if: There is a single non-cancelled tender linked to the event AND There is a single frozen payment linked to the event AND The account on the tender is the same as the account on the payment.Example:
false
-
isNonCisAccount: boolean
Non CIS Switch is defined as true if the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments.
-
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 -
nonCisSaId: string
Maximum Length:
10
Non CIS Service Agreement ID for account that belongs to a customer class that is used for non-CIS payments. -
numberOfPayments: number
Minimum Value:
0
Maximum Value:9.99999999999999E14
Payment Number -
numberOfTenders: number
Minimum Value:
0
Maximum Value:9.99999999999999E14
Tender Number -
payEventAlternateCurrency: object
payEventAlternateCurrency
-
paymentAmount: number
Payment Amount
-
paymentDate: string
(date)
Payment Date is the business date associated with the payment event.
-
paymentEventException: string
Maximum Length:
254
Message -
paymentEventId: string
Maximum Length:
12
Payment Event ID is the system-assigned unique identifier of the payment event.Example:317772795000
-
paymentEventId2: string
Maximum Length:
30
Payment Event ID is the system-assigned unique identifier of the payment event.Example:755669969777
-
payments: object
payments
-
paymentTemplate: string
Maximum Length:
12
Payment Templates can be configured for common types of payment allocations to pre-populate the payment distribution and allowing non-CIS payments to be directly allocated against distribution codes. -
paymentTenders: object
paymentTenders
-
paymentTotalAmount: number
Payment Total Amount
-
payorAccount: object
payorAccount
-
referenceNumber: string
Maximum Length:
30
Reference Number -
shouldAllPaymentsFreeze: boolean
Defining Freeze as true causes all Freezable payments linked to the event to become frozen.Example:
false
-
shouldOverrideTenderAuthorization: boolean
The Authorization Override checkbox is only displayed if the tender type selected requires authorization. Use the Authorization override checkbox to indicate whether or not tender authorization should take place. If Authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call.
-
tenderAuthorizationCode: string
Maximum Length:
60
If authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call. -
tenderReversal: string
Maximum Length:
10
Tender Reversal Code -
tenderSource: string
Maximum Length:
8
Tender Source is the source of the tenders. For example, cash drawer 22, lockbox 1 at Bank of America.Example:ACH (Auto pay)
-
tenderTotalAmount: number
Tender Amount contains the amount of the tender.
-
tenderType: object
tenderType
-
totTenderAmt: number
Total Tender Amount is the total amount of all tenders linked to the tender control.
-
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. -
user: object
user
USER ID
-
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 : account2
Type:
Show Source
object
-
_link: string
_link
-
accountId2: string
Maximum Length:
30
Account ID references the payment's account. The name of the account's main customer is displayed adjacent.
Nested Schema : account3
Type:
Show Source
object
-
_link: string
_link
-
acctId3: string
Maximum Length:
10
Reversal Account ID
Nested Schema : accountT
Type:
Show Source
object
-
_link: string
_link
-
accountIdT: string
Maximum Length:
10
Account ID references the payment's account. The name of the account's main customer is displayed adjacent.
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 : document
Type:
Show Source
object
-
_link: string
_link
-
documentId: string
Maximum Length:
30
Document ID
Nested Schema : exceptions
Type:
Show Source
object
-
comments2: string
Maximum Length:
254
Comments -
creationDateTime2: string
(date-time)
Create Date/TimeExample:
2010-11-24T17:49:23-05:00
-
expandedMessage2: string
Maximum Length:
254
Message -
isReviewed2: boolean
ReviewedExample:
false
-
messageCategory2: number
Minimum Value:
-99999
Maximum Value:99999
Message category within Oracle Utilities Application FrameworkExample:11
-
messageNumber2: number
Minimum Value:
-99999
Maximum Value:99999
Message number within Oracle Utilities Application Framework.Example:14107
-
messageParameter12: string
Maximum Length:
2000
Message ParameterExample:.
-
messageParameter22: string
Maximum Length:
2000
Message Parameter -
messageParameter32: string
Maximum Length:
2000
Message Parameter -
messageParameter42: string
Maximum Length:
2000
Message Parameter -
messageParameter52: string
Maximum Length:
2000
Message Parameter -
messageParameter62: string
Maximum Length:
2000
Message Parameter -
messageParameter72: string
Maximum Length:
2000
Message Parameter -
messageParameter82: string
Maximum Length:
2000
Message Parameter -
messageParameter92: string
Maximum Length:
2000
Message Parameter -
paymentEventExceptionType: string
Allowed Values:
[ "10 ", "20 " ]
Payment Exception Type * `10 ` - Unbalanced Event, * `20 ` - Unfrozen PaymentExample:20
-
paymentEventId: string
Maximum Length:
12
Payment Event ID is the system-assigned unique identifier of the payment event.Example:317772795000
-
reviewedDate2: string
(date)
Review Date
-
reviewUser2: string
Maximum Length:
8
Review User -
userId2: string
Maximum Length:
30
User -
version23: number
Minimum Value:
0
Maximum Value:0
Version2
Nested Schema : payEventAlternateCurrency
Type:
Show Source
object
-
_link: string
_link
-
payEventAlternateCurrency: string
Maximum Length:
1
Pay Event Alternate Currency Info
Nested Schema : payorAccount
Type:
Show Source
object
-
_link: string
_link
-
payorAccountId: string
Maximum Length:
10
Account ID
Nested Schema : user
Type:
object
USER ID
Show Source
-
_link: string
_link
-
user: string
Maximum Length:
8
USER ID
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
typeOfCharacteristicValue: string
Maximum Length:
4
Characteristic Value Indicate the value of the characteristic.Example:02-20-2008
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
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 : items
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID -
bill: object
bill
-
cancelReason: object
cancelReason
-
currency: string
Maximum Length:
3
Currency Code -
isNonCisPayment: boolean
Non-CIS Account SwitchExample:
false
-
isOpenItemAccounting: boolean
Open Item Accounting SwitchExample:
false
-
matchType: string
Maximum Length:
8
Match Type -
matchValue: string
Maximum Length:
30
Match Value -
nextActions: object
nextActions
-
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
-
paymentEventId2: 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 -
paymentId2: string
Maximum Length:
12
Payment ID -
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
Payment Status Message -
referenceNumber: string
Maximum Length:
30
Reference Number -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
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 : payment
Type:
Show Source
object
-
_link: string
_link
-
paymentId: string
Maximum Length:
12
Payment ID
Nested Schema : items
Type:
Show Source
object
-
adjustment: object
adjustment
-
alternateCurrency: string
Maximum Length:
3
Alternate Currency Code -
altTenderAmount: number
Minimum Value:
-9.99999999999999E12
Maximum Value:9.99999999999999E12
Alternate Amount -
cancelReason: object
cancelReason
-
characteristics: object
characteristics
-
checkNumber: string
Maximum Length:
10
Check Number -
currency: string
Maximum Length:
3
Currency Code -
customerId: string
Maximum Length:
36
Customer ID is the customer's account ID that appeared on the interfaced payment. -
encryptedMicrId: string
Maximum Length:
64
Encrypted Micr ID -
externalAccountId: string
Maximum Length:
50
External Account ID is the customer's account number at the financial institution. -
externalReferenceId: string
Maximum Length:
36
External Reference ID -
hasCancelTender: boolean
(hasCancelTender)
-
hasCashTendered: boolean
(hasCashTendered)
-
hashMicrId: string
Maximum Length:
88
Hash MICR ID -
isIncludedInTenderControlBalance: boolean
Turn off Included in Tender Ctl Balance if the tender should not be included in the tender amount in the tender control's tender balance. You would turn this switch off if you canceled a tender because it was mistakenly applied to the wrong account (or the amount was wrong). This switch is only enabled if: The tender control is not balanced. The tender is canceled.
-
isTenderTypeAuthorized: boolean
(isTenderTypeAuthorized)
-
micrId: string
Maximum Length:
30
MICR ID -
name: string
Maximum Length:
40
Name is the customer's name on the interfaced payment record. -
paymentTender: object
paymentTender
-
payorAccountId: string
Maximum Length:
10
Account ID -
tenderAmount: number
Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency.
-
tenderControl: object
tenderControl
-
tenderStatus: string
Allowed Values:
[ "25 ", "60 " ]
Tender Status is the tender's status. * `25 ` - Valid, * `60 ` - CanceledExample:Valid
-
tenderType: string
Maximum Length:
4
Tender Type -
tenderTypeNonCredit: string
(tenderTypeNonCredit)
-
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 : cancelReason
Type:
Show Source
object
-
_link: string
_link
-
cancelReason: string
Maximum Length:
4
Cancel Reason
Nested Schema : paymentTender
Type:
Show Source
object
-
_link: string
_link
-
paymentTenderId: string
Maximum Length:
12
Pay Tender ID
Nested Schema : tenderControl
Type:
Show Source
object
-
_link: string
_link
-
tenderControlId: string
Maximum Length:
10
Tender Control ID
Nested Schema : items
Type:
Show Source
object
-
adhocCharacteristicValue: string
Maximum Length:
254
Adhoc Characteristic Value -
characteristicType: object
characteristicType
-
characteristicValue: string
(characteristicValue3)
-
characteristicValueForeignKey: object
characteristicValueForeignKey
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : characteristicType
Type:
Show Source
object
-
_link: string
_link
-
characteristicType: string
(characteristicType5)
Nested Schema : characteristicValueForeignKey
Type:
Show Source
object
-
_link: string
_link
-
characteristicValueForeignKey: string
(characteristicValueForeignKey12)
Nested Schema : items
Type:
Show Source
object
-
alternateCurrency: object
alternateCurrency
-
alternateTenderAmount: number
Minimum Value:
-9.99999999999999E12
Maximum Value:9.99999999999999E12
Alternate Amount -
checkNumber: string
Maximum Length:
10
Check Number -
comment: string
Maximum Length:
254
Use Comments to describe anything unusual about the tender control. For example, comments can explain why a large over/under amount was created. -
externalReferenceId: string
Maximum Length:
36
External Reference ID -
hashMicrId: string
Maximum Length:
88
Hash MICR ID -
micrId: string
Maximum Length:
30
MICR ID -
tenderedAmount: number
Amount Tendered contains the amount that was tendered by the customer.
-
tenderType: string
Maximum Length:
4
Tender Type
Nested Schema : alternateCurrency
Type:
Show Source
object
-
_link: string
_link
-
alternateCurrency: string
Maximum Length:
3
Alternate Currency Code
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.