Search Results provide_pmt_reference_num




Overview
Explore in AI Chat

Overview

IBY_DISBURSE_SINGLE_PMT_PKG is the disbursement engine package within the Oracle Payments (IBY) module of Oracle E-Business Suite. Its principal business function is to disburse a single payment request from end to end: it validates the payment request, inserts a corresponding payment request record, invokes the payment process profile logic, formats and transmits the payment instruction, records payment references, and captures any transaction errors that arise during processing. The package is the procedural core behind the "Submit Single Payment" disbursement action used by payables and payments users who need to issue an individual payment outside of a batch.

The package header defines several PL/SQL collection and record types, including payreq_tbl_type (a table of payment service request identifiers), distinctPmtFxAccessType and distinctOrgAccessType records, and their corresponding index-by tables. These structures support the disbursement user interface by exposing the distinct payment functions and organizations present in a payment request, which the UI then uses to restrict user access according to the user's authorized payment function and organization.

Key Procedures and Functions

  • SUBMIT_SINGLE_PAYMENT — The primary entry point. It orchestrates disbursement of a single payment request, driving the sequence of validation, insertion, processing, and error handling steps.
  • INSERT_PAYREQ — Inserts the payment service request record into IBY_PAY_SERVICE_REQUESTS, creating the disbursement request that the rest of the flow processes. This is the procedure most commonly referenced by callers and custom code.
  • POPULATEOUTPARAMS — Populates the package's output parameters, returning status and processing information to the calling program after disbursement has been attempted.
  • RETRIEVE_TRANSACTION_ERRORS — Reads error rows associated with the disbursement transaction from IBY_TRANSACTION_ERRORS so that failures can be surfaced to the user or logged.
  • PROVIDE_PMT_REFERENCE_NUM — Supplies the payment reference number recorded against the payment, supporting reconciliation and traceability of the disbursed instruction.
  • PRINT_DEBUGINFO — Emits diagnostic information when debugging is enabled, used during implementation and support troubleshooting.

Tables Accessed

The package reads and writes the core IBY disbursement tables. IBY_PAY_SERVICE_REQUESTS holds the payment service request inserted by INSERT_PAYREQ. IBY_PAYMENTS_ALL stores the resulting payment records. IBY_PROCESS_FUNCTIONS and IBY_PROCESS_ORGS supply the payment function and organization access data used to restrict UI access. IBY_TRANSACTION_ERRORS is queried for error identification. IBY_PAYMENT_REFERENCES and IBY_PAY_INSTRUCTIONS_ALL support reference numbers and payment instructions, while IBY_DOCS_PAYABLE_ALL links the payment to its invoices. CE_PAYMENT_DOCUMENTS and IBY_USED_PAYMENT_DOCS track payment document usage, and PLITBLM is the standard EBS table used for storing large PL/SQL objects.

Usage Notes

IBY_DISBURSE_SINGLE_PMT_PKG is typically invoked from Oracle Payments disbursement forms and from concurrent programs that process individual payments on demand, rather than as part of the standard payment batch run. It is referenced by two other packages in the ETRM metadata. Custom code should call the documented public procedures, particularly SUBMIT_SINGLE_PAYMENT, rather than manipulating the underlying tables directly, because the package enforces validation, error capture, and reference-number assignment. In Oracle EBS 12.1.1 and 12.2.2 the package remains an APPS-owned object; online patching in 12.2.2 does not change its callable interface. Due to limited published parameter documentation, integrators should confirm exact signatures against the deployed package specification in their instance before writing dependent code.