Jump to

• Request
• Response

Action Payment Event

patch

https://server:port/spl/rest/apis/customer/financials/paymentEvents/{paymentEventId}/lifecycle

This operation updates Payment Events status for given Payment event id.

Request

Path Parameters

• paymentEventId(required): string

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID
• action: string
  Allowed Values: [ "C1DS", "C1FR", "C1TR" ]

  Available actions for the Payment Event * `C1DS` - Distribute, * `C1FR` - Freeze, * `C1TR` - Transfer
• cancelReason: string
  Maximum Length: 4

  Cancel Reason
• cancelReasonDescription: string
  Maximum Length: 100

  Cancel Reason Description
• 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
• 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.

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "C1DS",
                "C1FR",
                "C1TR"
            ],
            "description":"Available actions for the Payment Event\n* `C1DS` - Distribute,\n* `C1FR` - Freeze,\n* `C1TR` - Transfer"
        },
        "matchType":{
            "type":"string",
            "maxLength":8,
            "description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        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. \n        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\n\n(Bill ID / Sequential Bill Number)"
        },
        "matchValue":{
            "type":"string",
            "maxLength":30,
            "description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        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. \n        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"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "transferNonCisName":{
            "type":"string",
            "maxLength":50,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon 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":{
            "type":"string",
            "maxLength":30,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon 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."
        },
        "transferNonCISComment":{
            "type":"string",
            "maxLength":254,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon 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."
        },
        "cancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason"
        },
        "cancelReasonDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Cancel Reason Description"
        }
    },
    "xml":{
        "name":"C1ActPayEve"
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID
• action: string
  Allowed Values: [ "C1DS", "C1FR", "C1TR" ]

  Available actions for the Payment Event * `C1DS` - Distribute, * `C1FR` - Freeze, * `C1TR` - Transfer
• cancelReason: string
  Maximum Length: 4

  Cancel Reason
• cancelReasonDescription: string
  Maximum Length: 100

  Cancel Reason Description
• 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
• 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.

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "C1DS",
                "C1FR",
                "C1TR"
            ],
            "description":"Available actions for the Payment Event\n* `C1DS` - Distribute,\n* `C1FR` - Freeze,\n* `C1TR` - Transfer"
        },
        "matchType":{
            "type":"string",
            "maxLength":8,
            "description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        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. \n        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\n\n(Bill ID / Sequential Bill Number)"
        },
        "matchValue":{
            "type":"string",
            "maxLength":30,
            "description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        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. \n        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"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "transferNonCisName":{
            "type":"string",
            "maxLength":50,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon 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":{
            "type":"string",
            "maxLength":30,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon 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."
        },
        "transferNonCISComment":{
            "type":"string",
            "maxLength":254,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon 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."
        },
        "cancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason"
        },
        "cancelReasonDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Cancel Reason Description"
        }
    },
    "xml":{
        "name":"C1ActPayEve"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1ActPayEve

Type: object

Show Source

• action: string
  Allowed Values: [ "C1DS", "C1FR", "C1TR" ]

  Available actions for the Payment Event * `C1DS` - Distribute, * `C1FR` - Freeze, * `C1TR` - Transfer
• nextActions: array nextActions
• paymentEvent: object paymentEvent

{
    "type":"object",
    "properties":{
        "paymentEvent":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "paymentEventId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Payment Event ID is the system-assigned unique identifier of the payment event.",
                    "example":"317772795000"
                }
            }
        },
        "action":{
            "type":"string",
            "enum":[
                "C1DS",
                "C1FR",
                "C1TR"
            ],
            "description":"Available actions for the Payment Event\n* `C1DS` - Distribute,\n* `C1FR` - Freeze,\n* `C1TR` - Transfer"
        },
        "nextActions":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "action":{
                        "type":"string",
                        "enum":[
                            "C1DS",
                            "C1FR",
                            "C1TR"
                        ],
                        "description":"Available actions for the Payment Event\n* `C1DS` - Distribute,\n* `C1FR` - Freeze,\n* `C1TR` - Transfer"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1ActPayEve"
    }
}

Nested Schema : nextActions

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "action":{
                "type":"string",
                "enum":[
                    "C1DS",
                    "C1FR",
                    "C1TR"
                ],
                "description":"Available actions for the Payment Event\n* `C1DS` - Distribute,\n* `C1FR` - Freeze,\n* `C1TR` - Transfer"
            }
        }
    }
}

Nested Schema : paymentEvent

Type: object

Show Source

• _link: string
  _link
• paymentEventId: string
  Maximum Length: 12

  Payment Event ID is the system-assigned unique identifier of the payment event.

  Example: 317772795000

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "paymentEventId":{
            "type":"string",
            "maxLength":12,
            "description":"Payment Event ID is the system-assigned unique identifier of the payment event.",
            "example":"317772795000"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• action: string
  Allowed Values: [ "C1DS", "C1FR", "C1TR" ]

  Available actions for the Payment Event * `C1DS` - Distribute, * `C1FR` - Freeze, * `C1TR` - Transfer

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "C1DS",
                "C1FR",
                "C1TR"
            ],
            "description":"Available actions for the Payment Event\n* `C1DS` - Distribute,\n* `C1FR` - Freeze,\n* `C1TR` - Transfer"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top