Search Results check_mandatory

Overview

IBY_PAYMENT_ADAPTER_PUB is a public PL/SQL package in the Oracle Payments (IBY) module of Oracle E-Business Suite, delivered under the APPS schema. It serves as the payment adapter layer that mediates communication between Oracle Payments and external payment processors, system interfaces, and risk-management services. The package encapsulates the protocols, message construction, and response parsing logic required to transmit payment requests — captures, authorizations, refunds, voids, and batch operations — to third-party or internal payment systems, and to interpret the results returned by those systems.

The header comment indicates a source lineage from the iPayment 3i product line, with utility logic such as unpack_results_url carried forward and enhanced. The package declares a full validation level (FND_API.G_VALID_LEVEL_FULL) and a package name constant, following standard EBS API conventions. It is documented as a PUB classification API, meaning it is intended for supported external invocation rather than purely internal use.

Key Procedures and Functions

The documented procedures fall into several functional groups. Payment transaction operations include ORAPMTREQ (payment request), ORAPMTMOD (modify), ORAPMTCANC (cancel), ORAPMTVOID (void), ORAPMTCREDIT (credit), ORAPMTRETURN (return), and ORAPMTREVERSE (reversal). These routines drive the lifecycle transitions of individual payment transactions against the external processor. ORAPMTCAPTURE handles capture of previously authorized funds.

Query and inquiry operations are represented by ORAPMTQRYTRXN (query transaction), ORAPMTINQ (general inquiry), ORAPMTQUERYBATCH (batch query), and ORAPMTCLOSEBATCH (close batch). These support reconciliation and settlement workflows. ORACCBATCHCAPTURE provides credit-card batch capture support. ORARISKEVAL performs risk evaluation, while IS_RISKINFO_REC_MISSING is a function that determines whether required risk information is absent for a transaction. ORASECUREEXTENSION provides a secure extension entry point, allowing processor-specific payloads to be passed through the standard adapter framework.

These procedures are commonly referenced through the module constant used in debug logging (G_DEBUG_MODULE) and are instrumented with iby_debug_pub calls for diagnostic tracing.

Tables Accessed

The package references IBY_FNDCPT_TX_EXTENSIONS, the transaction extension table that stores processor-specific or custom attributes associated with a payment transaction. It also references IBY_TRXN_SUMMARIES_ALL, which holds summary records for payment transactions and is queried or updated to reflect transaction status and outcome. Utility dependencies include DBMS_OUTPUT (diagnostic output), PLITBLM (PL/SQL table manipulation for name-value collection), UTL_HTTP (outbound HTTP communication with remote payment servers), and UTL_TCP (lower-level socket communication). The presence of UTL_HTTP and UTL_TCP confirms that the adapter transmits request messages over network protocols and parses returned response strings, as illustrated by the unpack_results_url logic that decomposes HTML-formatted response strings into indexed name-value pairs.

Usage Notes

IBY_PAYMENT_ADAPTER_PUB is typically invoked indirectly through Oracle Payments processing — payment process requests, formatted payment instructions, and settlement flows — rather than being called directly by end users. Because it is classified as a public API, it may be called from custom code that needs to submit payment instructions to a processor or to query transaction status. The package is referenced by six other packages, indicating its role as a shared adapter service within the IBY dependency chain. Customizations should invoke the documented procedures only; internal utility routines such as unpack_results_url are implementation details. Debug output can be enabled through the standard IBY debug framework to trace adapter behavior during integration testing and troubleshooting.