1. Oracle Utilities REST API for Metering and Customer Information
  2. Tasks
  3. Financial Transactions
  4. Payment

Update Payment

put

https://server:port/spl/rest/apis/customer/financials/payments/{paymentId}

This operation handles the Integration Suite API to Update Payment

Request

Path Parameters
Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
  • account
  • Maximum Length: 1
    Account Check Digit
  • Maximum Length: 30
    If the payment is canceled , the Cancel Reason is displayed.
    Example: Data entry error
  • characteristics
  • currency
  • Exception
  • Non-CIS Account Switch
    Example: true
  • Open Item Accounting Switch
    Example: false
  • When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.
    Example: true
  • 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.
  • 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.
  • 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.
  • 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
  • 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.
  • 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.
  • Payment Amount is the amount of the payment. This field is gray after the payment is frozen.
    Example: 300
  • paymentEvent
  • Maximum Length: 12
    Payment ID is the system-assigned unique identifier of the payment.
    Example: 317896608844
  • Allowed Values: [ "10 ", "20 ", "30 ", "50 ", "60 " ]
    Payment Status is the payment's status. * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `50 ` - Frozen, * `60 ` - Canceled
    Example: 30
  • paySegments
  • Maximum Length: 10
    Account ID is the account to which the payment event should be transferred.
  • Maximum Length: 4
    Cancel Reason defines why you are performing the payment event transfer.
    Example: NSF (Non sufficient funds)
  • 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)
  • 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
  • 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.
  • 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.
  • 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.
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 20
Nested Schema : account
Type: object
Show Source
Nested Schema : characteristics
Type: object
Show Source
Nested Schema : currency
Type: object
Show Source
Nested Schema : Exception
Type: object
Show Source
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
  • 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: object
Show Source
Nested Schema : paySegments
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : characteristicType
Type: object
Show Source
Nested Schema : characteristicValue
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • account
  • Maximum Length: 1
    Account Check Digit
  • Maximum Length: 30
    If the payment is canceled , the Cancel Reason is displayed.
    Example: Data entry error
  • characteristics
  • currency
  • Exception
  • Non-CIS Account Switch
    Example: true
  • Open Item Accounting Switch
    Example: false
  • When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.
    Example: true
  • 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.
  • 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.
  • 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.
  • 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
  • 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.
  • 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.
  • Payment Amount is the amount of the payment. This field is gray after the payment is frozen.
    Example: 300
  • paymentEvent
  • Maximum Length: 12
    Payment ID is the system-assigned unique identifier of the payment.
    Example: 317896608844
  • Allowed Values: [ "10 ", "20 ", "30 ", "50 ", "60 " ]
    Payment Status is the payment's status. * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `50 ` - Frozen, * `60 ` - Canceled
    Example: 30
  • paySegments
  • Maximum Length: 10
    Account ID is the account to which the payment event should be transferred.
  • Maximum Length: 4
    Cancel Reason defines why you are performing the payment event transfer.
    Example: NSF (Non sufficient funds)
  • 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)
  • 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
  • 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.
  • 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.
  • 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.
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 20
Nested Schema : account
Type: object
Show Source
Nested Schema : characteristics
Type: object
Show Source
Nested Schema : currency
Type: object
Show Source
Nested Schema : Exception
Type: object
Show Source
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
  • 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: object
Show Source
Nested Schema : paySegments
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : characteristicType
Type: object
Show Source
Nested Schema : characteristicValue
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : C1-CxPayment
Type: object
Show Source
  • _self
  • account
  • Maximum Length: 1
    Account Check Digit
  • Maximum Length: 30
    If the payment is canceled , the Cancel Reason is displayed.
    Example: Data entry error
  • characteristics
  • currency
  • Exception
  • Non-CIS Account Switch
    Example: true
  • Open Item Accounting Switch
    Example: false
  • When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.
    Example: true
  • 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.
  • 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
  • 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.
  • 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
  • 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.
  • 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.
  • Payment Amount is the amount of the payment. This field is gray after the payment is frozen.
    Example: 300
  • paymentEvent
  • Maximum Length: 12
    Payment ID is the system-assigned unique identifier of the payment.
    Example: 317896608844
  • Allowed Values: [ "10 ", "20 ", "30 ", "50 ", "60 " ]
    Payment Status is the payment's status. * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `50 ` - Frozen, * `60 ` - Canceled
    Example: 30
  • paySegments
  • Maximum Length: 10
    Account ID is the account to which the payment event should be transferred.
  • Maximum Length: 4
    Cancel Reason defines why you are performing the payment event transfer.
    Example: NSF (Non sufficient funds)
  • 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)
  • 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
  • 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.
  • 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.
  • 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.
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 20
Nested Schema : account
Type: object
Show Source
Nested Schema : characteristics
Type: object
Show Source
Nested Schema : currency
Type: object
Show Source
Nested Schema : Exception
Type: object
Show Source
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
  • 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 : nextActions
Type: object
Show Source
Nested Schema : paymentEvent
Type: object
Show Source
Nested Schema : paySegments
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : characteristicType
Type: object
Show Source
Nested Schema : characteristicValue
Type: object
Show Source
Nested Schema : messageCategory
Type: object
Message category within Oracle Utilities Application Framework.
Show Source
Nested Schema : reviewUser
Type: object
Review User
Show Source
Nested Schema : user
Type: object
User
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : adjustment
Type: object
Show Source
Nested Schema : currency
Type: object
Show Source
Nested Schema : financialTransaction
Type: object
Show Source
Nested Schema : matchEvent
Type: object
Show Source
Nested Schema : paySegment
Type: object
Show Source
Nested Schema : serviceAgreement
Type: object
Show Source

400 Response

Bad Request
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.

500 Response

Internal Server Error
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.
Back to Top