Search Results clear_msg_stack

Overview

The IBY_FNDCPT_COMMON_PUB package body in the APPS schema is the shared utility layer of the Oracle Payments (IBY) funds capture infrastructure in Oracle E-Business Suite 12.1.1 and 12.2.2. Funds capture governs the electronic movement of money into the enterprise: credit card settlements, bank account debits, and other payer-initiated transactions. The package encapsulates logic common to the funds capture application programming interfaces, so that individual payer and payment APIs do not duplicate the same validation, comparison, and error-handling code.

The package is classified as a public (PUB) API, meaning it is designed to be callable from outside the owning application. Its status is VALID in the ETRM repository, and it is referenced by 65 other database objects, confirming its role as a foundational dependency rather than a leaf-level component. The dependency metadata shows that it relies on the FND_API, FND_LOG, FND_MESSAGE, and FND_MSG_PUB packages for the standard EBS API error and message framework, on IBY_DEBUG_PUB for diagnostics, on IBY_UTILITY_PVT for internal utility routines, and on a set of HZ (Trading Community Architecture) tables for party and customer data.

Key Procedures and Functions

The ETRM metadata documents five procedures and functions within this package. Their documented purposes are as follows:

• VALIDATE_PAYER — Verifies that a payer record supplied by or resolved for a caller is valid before a funds capture operation proceeds. It is the primary guard routine invoked by funds capture APIs and processing logic.
• COMPARE_PAYER — Compares payer information, typically to detect whether two payer representations refer to the same party or, conversely, whether details have changed. This supports duplicate detection and reconciliation during payer maintenance or transaction processing.
• PREPARE_RESULT — Initializes or populates the result structure returned to callers of the funds capture APIs, ensuring a consistent response format across the application.
• GET_RESULT_CATEGORY — Derives or returns the category classification associated with a result, translating a low-level outcome into a business-meaningful result grouping.
• CLEAR_MSG_STACK — Resets the FND message stack, following the standard EBS API convention of initializing the message stack before execution and clearing it afterward.

Tables Accessed

The package reads and, where applicable, references the following tables through APPS synonyms:

• IBY_EXTERNAL_PAYERS_ALL — The primary repository of external payer records used in funds capture transactions.
• IBY_RESULT_CODES — The result code lookup used by PREPARE_RESULT and GET_RESULT_CATEGORY to derive standardized outcome codes and their categories.
• HZ_CUST_ACCOUNTS, HZ_CUST_ACCOUNT_ROLES, HZ_CUST_ACCT_SITES_ALL, HZ_CUST_SITE_USES_ALL, HZ_PARTIES, and HZ_PARTY_PREFERENCES — The Trading Community Architecture tables that supply customer account, party, account role, site, site use, and preference information required to validate and compare payers.

Usage Notes

IBY_FNDCPT_COMMON_PUB is an internal support API rather than an end-user-facing component. It is invoked by Oracle Payments forms, by funds capture concurrent programs, and by the 65 documented dependent packages that call its validation, comparison, and result-handling routines. Custom integrators building funds capture extensions may call the public procedures directly, but should observe the standard EBS API contract: initialize the message stack, call the routine, inspect the returned result, and clear the message stack on completion. Because it is a dependency of so many objects, changes to this package carry broad regression risk and should be tested against all calling funds capture APIs.