Search Results iby_fipayments_pkg




Overview
Explore in AI Chat

Overview

IBY_FIPAYMENTS_PKG is an Oracle Applications (APPS) PL/SQL package that belongs to the IBY module, the Payments component of Oracle E-Business Suite. It provides the funds capture and funds disbursement integration logic that connects Oracle Payments to external financial institutions and payment systems. In practice, the package acts as the bridge between Oracle Payments transaction records and the underlying financial institution (FI) payment processing layer. It is used by the Payments engine when a payment instruction must be created, modified, deleted, or reconciled against the tangible and electronic payment records maintained in the IBY schema.

The package is documented as VALID in ETRM release 12.2.2 and is classified under the API classification OTHER, indicating that it is an internal engine package rather than a public, customer-facing API. It operates within the APPS schema and interacts with both APPS synonyms and IBY base objects.

Key Procedures and Functions

The ETRM metadata documents nine procedures and functions within the package. Their names and purposes are as follows:

  • CREATEPAYMENT — Creates the payment record that represents a new payment to be transmitted to the financial institution. This is the primary entry point for establishing a payment within the funds capture integration flow.
  • MODIFYPAYMENT — Applies changes to an existing payment record, allowing payment attributes to be updated before or during transmission.
  • DELETEPAYMENT — Removes or logically cancels a payment previously created through the package.
  • REQUESTEXISTS — Determines whether a payment request already exists, supporting idempotency and duplicate-prevention logic in the integration layer.
  • CHECKINSTRID — Validates or verifies the instruction identifier associated with a payment, ensuring the instruction reference is known and consistent with the payment record.
  • SETTRXNSTATUS — Sets or updates the transaction status on a payment record, enabling the Payments engine to reflect processing outcomes.
  • CREATERETURNPAYMENT — Creates a return payment record, used when a previously submitted payment is returned by the financial institution and must be represented as a reversing or return transaction.
  • UPDATETRXN — Updates transaction-level information associated with the payment, keeping the IBY transaction tables synchronized with payment processing activity.

The ETRM metadata also lists an incomplete ninth entry; the documented procedures above represent the substantive documented API surface.

Tables Accessed

The package reads and writes the following documented objects, primarily through APPS synonyms:

  • IBY_ECAPP — Electronic commerce application setup and configuration data used by the payment integration.
  • IBY_TANGIBLE — Tangible (check or physical instrument) payment records, distinguishing tangible from electronic payments.
  • IBY_TRXN_FI — Transaction-to-financial-institution relationship records linking payments to the FI that processes them.
  • IBY_TRXN_SUMMARIES_ALL — Summary transaction records, partitioned across the "ALL" naming convention, used for consolidated payment reporting and status.
  • IBY_EXT_BANK_ACCOUNTS and IBY_EXT_BANK_ACCOUNTS_V — External bank account definitions for payees and remit-to parties, including the view variant used for query access.
  • IBY_PAYEE — Payee records identifying the party receiving payment.
  • IBY_BEPINFO — Payment system / bank entry point information used to route payments.
  • IBY_TRXNSUMM_MID_S — A sequence used to generate summary transaction identifiers.
  • HZ_CUST_ACCOUNTS — Trading community customer account data, referenced to resolve payee and remit-to account context.
  • DUAL — Used for scalar evaluations and single-row queries.

Note that IBY_EXT_BANK_ACCOUNTS_V is documented as a dependency of the package, while IBY_EXT_BANK_ACCOUNTS appears in the package's synonym list; both references are preserved as documented.

Usage Notes

IBY_FIPAYMENTS_PKG is an engine-level package and is not intended to be called directly by end users. It is referenced by the companion package IBY_TRANSACTIONEFT_PKG, which the ETRM metadata identifies as its sole documented referencing package. Because the package is invoked from within the Oracle Payments processing flow, the typical call path is a concurrent program, a Payments workbench form action, or an internal API call from IBY_TRANSACTIONEFT_PKG. Custom code should not invoke these procedures directly unless it fully replicates the surrounding transaction, validation, and commit logic, since the package assumes it is operating within the Payments engine's transaction context. Changes to payments should be made through the supported Oracle Payments public APIs, with this package remaining an internal implementation detail of the funds capture and disbursement integration layer.