Search Results create_payment

Overview

IGF_SE_PAYMENT_PUB is a public PL/SQL package body in the Oracle E-Business Suite application schema APPS, classified under the IGF (Grants/Federal) product family, specifically the Student Financial Aid / Grants disbursement (SE) module. The package encapsulates the business logic required to create student payment records within Oracle EBS, providing a controlled, API-driven entry point rather than allowing direct DML against the underlying payment tables. Consistent with the Oracle Application Object Library (AOL) API design conventions, the package implements standard return-status and message-list handling through FND_API, FND_MSG_PUB, and application savepoints, ensuring that callers receive consistent success, error, or unexpected-exception signalling and that partial writes are rolled back atomically.

Key Procedures and Functions

The documented public interface exposes a single procedure, CREATE_PAYMENT. This is the main entry point into the package. Its purpose is to validate and persist a student payment record supplied by the caller, returning a transaction identifier and a standard API return status. The procedure honours the standard AOL API contract: it accepts an initialization flag to control whether the message list is reset, invokes an internal helper (do_create_payment) to perform the actual insertion and business validation, and translates failures into the standard FND_API exception codes. On success it sets the return status to G_RET_STS_SUCCESS; on a raised application error it rolls back to its own savepoint and returns G_RET_STS_ERROR. A separate branch of the exception handler returns G_RET_STS_UNEXP_ERROR for any unhandled condition. Message count and message data are returned through the standard x_msg_count and x_msg_data out parameters, populated via FND_MSG_PUB.COUNT_AND_GET, allowing the caller to surface detailed diagnostic information to the user.

The internal private procedure do_create_payment is forward-declared in the package body and is not part of the public API; it encapsulates the core record-creation logic. No other public procedures or functions are documented.

Tables Accessed

The package operates against the following base tables through their APPS synonyms:

• IGF_SE_PAYMENT — the primary target of the create operation, holding the student payment/disbursement records inserted by CREATE_PAYMENT.
• IGF_AW_AWARD_ALL — the awards table against which payment eligibility and award context are validated, linking each payment to its originating award.
• IGF_SE_AUTH — the authorization table used to verify that the payment is permitted for the student or award before the record is committed.
• HZ_PARTIES — the Trading Community Architecture party table, used to resolve and confirm the person or organization (typically the student or payee) associated with the payment.

Usage Notes

CREATE_PAYMENT is intended to be invoked from within the Oracle EBS runtime environment, most commonly from a Forms-based grants or student-financial-aid screen, from a concurrent program, or from custom PL/SQL that needs to generate a payment record without direct table access. Callers should pass a fully populated payment record, set p_init_msg_list to FND_API.G_TRUE only when a fresh message stack is required, and always inspect x_return_status before relying on the returned transaction identifier. The package is declared as a public (PUB) API, so its signature should be treated as a stable integration point; nonetheless, because it is a published API rather than an extension point, customizations should call it rather than modify it. The API performs its own savepoint management and exception translation, so callers should not wrap the call in additional rollback logic without accounting for the package's internal error handling.