Search Results get_payreq_id




Overview
Explore in AI Chat

Overview

IBY_BUILD_INSTRUCTIONS_PUB_PKG is a public PL/SQL package body owned by the APPS schema in Oracle E-Business Suite Release 12.1.1 and 12.2.2. It belongs to the Oracle Payments (IBY) module and forms part of the payment instruction generation layer that converts a payment service request into one or more concrete payment instructions. In functional terms, this package is the engine behind the "Build Payments" processing step: it reads the payment attributes and attributes values assembled for a payment process request, applies the formatting and validation rules defined for the selected payment instruction format, and produces the instruction records that are subsequently formatted, printed, or transmitted electronically to a payment system.

The package is classified as a public API (API classification OTHER) and is marked VALID in the ETRM metadata. Its documented interface exposes ten procedures and functions, covering instruction construction, rebuilding, deferral handling, attribute retrieval, and debug output. It is referenced by one other database object and does not itself reference any object outside the APPS and SYS schemas shown in the dependency list.

Key Procedures and Functions

  • BUILD_PMT_INSTRUCTIONS — The primary entry point. Builds payment instructions for a payment service request by evaluating the request's instruction attributes and populating the instruction records.
  • REBUILD_PMT_INSTRUCTION — Regenerates a previously built instruction, typically after a change to payment attributes, validation setup, or formatting parameters.
  • MOVEINSTRTODEFERREDSTATUS — Transitions an instruction to a deferred status, used when an instruction cannot proceed to completion in the current run and must be retried later.
  • GET_PAYREQ_ID — Retrieves the payment service request identifier associated with the instruction being processed.
  • GET_PAYDOC_ID — Retrieves the payment document identifier linked to the instruction.
  • GET_INT_BANK_ACCT_ID — Returns the internal bank account identifier used to derive payment details for the instruction.
  • GET_INSTRUCTION_ATTRIBUTES — Reads and returns the instruction attribute set applicable to the payment process request and instruction format.
  • BUILD_ELECTRONIC_INSTRUCTIONS — Builds instructions destined for electronic transmission rather than printed output.
  • BUILD_PRINTED_INSTRUCTIONS — Builds instructions destined for printed output such as cheque or remittance advice formats.
  • PRINT_DEBUGINFO — Writes diagnostic information, using the FND logging infrastructure, to aid troubleshooting of instruction construction.

Tables Accessed

  • IBY_PAY_INSTRUCTIONS_ALL — The core instruction table. Records representing individual payment instructions are created, updated, and status-managed here by the build and rebuild procedures.
  • IBY_PAY_SERVICE_REQUESTS — The governing payment service request. The package reads request-level attributes and identifiers that drive which instructions are built and how they are classified.
  • PLITBLM — A PL/SQL table-of-strings type used internally, for example to hold attribute value collections during instruction assembly.

Additional supporting objects referenced by the package body include IBY_PAYMENT_PROFILES, IBY_PAYINSTR_PUB, IBY_BUILD_UTILS_PKG, IBY_CHECKNUMBER_PUB, IBY_VALIDATIONSETS_PUB, IBY_SECURITY_PKG, IBY_UTILITY_PVT, IBY_DISBURSE_SUBMIT_PUB_PKG, IBY_DISBURSE_UI_API_PUB_PKG, and IBY_FD_POST_PICP_PROGS_PVT, along with the standard FND_API, FND_MESSAGE, FND_MSG_PUB, FND_LOG, FND_FILE, and APP_EXCEPTION utilities. These dependencies confirm that the package participates in the wider Oracle Payments disbursement and validation framework rather than operating in isolation.

Usage Notes

IBY_BUILD_INSTRUCTIONS_PUB_PKG is not intended to be called directly by end users. It is invoked by the Oracle Payments payment processing infrastructure, most commonly through the payments build and format concurrent programs and the underlying submission packages such as IBY_DISBURSE_SUBMIT_PUB_PKG. The build procedures run as part of the payment process request lifecycle, after payment attributes have been captured and before formatting, printing, or transmission. The deferral procedure is used during exception handling so that a failed or incomplete instruction can be reconsidered in a later run without abandoning the payment process request.

Because the package is a public API in the APPS schema and its procedures are documented in the ETRM repository, custom integrations that need to build or rebuild payment instructions programmatically may call it, provided they supply a valid payment service request context and observe the standard FND_API error-handling and message-stack conventions. All calls should be made using the APPS schema or a synonym with appropriate grants, and debug output should be enabled selectively via the FND logging profile options to avoid excess log volume in production.