Action Payment
patch
https://server:port/spl/rest/apis/customer/financials/payments/{paymentId}/lifecycle
This operation updates payment status for the provided Payment Id.
Request
Path Parameters
-
paymentId(required): string
Payment ID is the system-assigned unique identifier of the payment.Example:
317896608844
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
action: string
Allowed Values:
[ "C1CN", "C1DE", "C1DS", "C1FR", "C1TR" ]
Available action for the payment * `C1CN` - Cancel, * `C1DE` - Delete, * `C1DS` - Distribute, * `C1FR` - Freeze, * `C1TR` - Transfer -
cancelReason: string
Maximum Length:
30
If the payment is canceled, the Cancel Reason is displayed.Example:Data entry error
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:GET
-
isPayTransfer: boolean
When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.Example:
true
-
transferAccountId: string
Maximum Length:
10
Account ID is the account to which the payment event should be transferred. -
transferCancelReason: string
Maximum Length:
4
Cancel Reason defines why you are performing the payment event transfer.Example:NSF (Non sufficient funds)
-
transferMatchType: string
Maximum Length:
8
Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.Example:BILL-ID (Bill ID / Sequential Bill Number)
-
transferMatchValue: string
Maximum Length:
30
Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.Example:995516242555
-
transferNonCISComment: string
Maximum Length:
254
Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments. -
transferNonCisName: string
Maximum Length:
50
Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments. -
transferNonCisReferenceNumber: string
Maximum Length:
30
Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments.
Root Schema : schema
Type:
Show Source
object
-
action: string
Allowed Values:
[ "C1CN", "C1DE", "C1DS", "C1FR", "C1TR" ]
Available action for the payment * `C1CN` - Cancel, * `C1DE` - Delete, * `C1DS` - Distribute, * `C1FR` - Freeze, * `C1TR` - Transfer -
cancelReason: string
Maximum Length:
30
If the payment is canceled, the Cancel Reason is displayed.Example:Data entry error
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:GET
-
isPayTransfer: boolean
When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.Example:
true
-
transferAccountId: string
Maximum Length:
10
Account ID is the account to which the payment event should be transferred. -
transferCancelReason: string
Maximum Length:
4
Cancel Reason defines why you are performing the payment event transfer.Example:NSF (Non sufficient funds)
-
transferMatchType: string
Maximum Length:
8
Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.Example:BILL-ID (Bill ID / Sequential Bill Number)
-
transferMatchValue: string
Maximum Length:
30
Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.Example:995516242555
-
transferNonCISComment: string
Maximum Length:
254
Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments. -
transferNonCisName: string
Maximum Length:
50
Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments. -
transferNonCisReferenceNumber: string
Maximum Length:
30
Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments.
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1ActionPyt
Type:
Show Source
object
-
action: string
Allowed Values:
[ "C1CN", "C1DE", "C1DS", "C1FR", "C1TR" ]
Available action for the payment * `C1CN` - Cancel, * `C1DE` - Delete, * `C1DS` - Distribute, * `C1FR` - Freeze, * `C1TR` - Transfer -
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:GET
-
nextActions: array
nextActions
-
paymentId: object
paymentId
Payment ID is the system-assigned unique identifier of the payment.
-
paymentStatus: string
Allowed Values:
[ "10 ", "20 ", "30 ", "50 ", "60 " ]
Payment Status is the payment's status. * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `50 ` - Frozen, * `60 ` - CanceledExample:30
Nested Schema : paymentId
Type:
object
Payment ID is the system-assigned unique identifier of the payment.
Show Source
-
_link: string
_link
-
paymentId: string
Maximum Length:
12
Payment ID is the system-assigned unique identifier of the payment.Example:317896608844
Nested Schema : items
Type:
Show Source
object
-
action: string
Allowed Values:
[ "C1CN", "C1DE", "C1DS", "C1FR", "C1TR" ]
Available action for the payment * `C1CN` - Cancel, * `C1DE` - Delete, * `C1DS` - Distribute, * `C1FR` - Freeze, * `C1TR` - Transfer
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.