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

Get Payment Tender

get

https://server:port/spl/rest/apis/customer/financials/paymentTenders/{paymentTenderId}

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : C1PaymTender
Type: object
Show Source
Nested Schema : adjustment
Type: object
Show Source
Nested Schema : alternateCurrency
Type: object
If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency.
Show Source
Nested Schema : alternateTenderAmount
Type: object
Tender Amount
Show Source
Nested Schema : autoPayClearing
Type: object
Show Source
  • accountAutoPay
  • Maximum Length: 12
    Auto Pay Clearing ID is PK of the auto pay staging record.
  • The automatic payment is NOT distributed and frozen when the automatic payment is initially created. A separate background process distributes and freezes the automatic payment on the automatic payment GL distribution date . On the GL distribution date, the automatic payment will be interfaced to the general ledger.
  • autopaySource
    Auto Pay Source Code is the financial institution or credit card company that receives the automatic payment request.
  • batchControl
    Batch Code is the batch code for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.
  • Minimum Value: -9.999999999E9
    Maximum Value: 9.999999999E9
    Batch Number is the batch number for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Number is displayed.
  • bill
  • Maximum Length: 108
    External Account ID is used to define the customer's bank account or credit card number. The system supports encryption for the External Account ID. If your implementation has configured the system to encrypt the External Account ID, the data will be returned with a masked value, such as *******.
  • Maximum Length: 254
    Name is the customer's name in the financial institution's system.
  • Expires On is only needed if the Tender Type indicates that an expiration date is necessary, such as for a credit card payment.
  • Maximum Length: 50
    External Account ID is the customer's account number at the financial institution.
  • Scheduled Extract Date is the date the automatic payment request was sent or is scheduled to be sent to the financial institution.
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 1
Nested Schema : cancelReason
Type: object
If the payment is canceled, the Cancel Reason is displayed.
Show Source
Nested Schema : characteristics
Type: object
Show Source
Nested Schema : currency
Type: object
Currency Code defines the currency in which the account's financial transactions are expressed.
Show Source
Nested Schema : nextActions
Type: object
Show Source
Nested Schema : paymentEvent
Type: object
Show Source
Nested Schema : payorAccount
Type: object
Show Source
Nested Schema : tenderControl
Type: object
Show Source
  • _link
  • Maximum Length: 10
    Tender Control ID is the identity of the remittance processor batch or cash drawer bundle in which the tender was remitted.
    Example: 0225339900
Nested Schema : tenderType
Type: object
Tender Type describes what was remitted, such as cash or check.
Show Source
Nested Schema : accountAutoPay
Type: object
Show Source
Nested Schema : autopaySource
Type: object
Auto Pay Source Code is the financial institution or credit card company that receives the automatic payment request.
Show Source
Nested Schema : batchControl
Type: object
Batch Code is the batch code for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.
Show Source
  • _link
  • Maximum Length: 8
    Batch Code is the batch code for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.
Nested Schema : bill
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
  • Allowed Values: [ "C1CN" ]
    Payment Tender Web Service Actions: * `C1CN` - Cancel

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