Search Results get_billing_site




Overview
Explore in AI Chat

Overview

IBY_PAYMENTCARD_PKG is the primary PL/SQL package body in the Oracle Payments (IBY) module responsible for the creation, maintenance, retrieval, and masking of payment card instruments within Oracle E-Business Suite. In releases 12.1.1 and 12.2.2, this package encapsulates the business logic that governs how credit card and procurement card records are persisted in the IBY_PAYMENTCARD table and how sensitive card data is protected through masking routines. It serves as the programmatic backbone behind the payment card user interface, providing a controlled API layer so that forms, concurrent programs, and custom extensions do not manipulate card records directly. Because it depends on public APIs such as FND_API, FND_MSG_PUB, HZ_PARTY_SITE_V2PUB, and IBY_FNDCPT_COMMON_PUB, the package adheres to the standard EBS error-handling and message-stack conventions. The package is owned by APPS and is documented as VALID, with an API classification of OTHER.

Key Procedures and Functions

The package exposes eight documented procedures and functions supporting the payment card lifecycle:

  • GET_MASK_SETTINGS — Retrieves the masking configuration that determines how card numbers are displayed or stored for a given context.
  • MASK_CARD_NUMBER — Applies the configured masking rules to a card number, producing a partially obscured value suitable for display or logging.
  • CREATE_CARD — Inserts a new payment card instrument record, validating the supplied data before persisting it to IBY_PAYMENTCARD.
  • UPDATE_CARD — Modifies the attributes of an existing card record while preserving data integrity and audit expectations.
  • GET_CARD — Retrieves a specific card record by its identifying criteria for use by calling programs.
  • CARD_EXISTS — Performs an existence check on a card record, typically used to prevent duplicate instrument creation.
  • REMASK_INSTRUMENTS — Reapplies masking across card instruments, commonly executed when masking settings change or during remediation of unmasked data.

These routines collectively enforce consistent behavior for any component that needs to read or write payment card information.

Tables Accessed

The package reads and writes IBY_PAYMENTCARD, the core table holding payment card instrument definitions, as well as IBY_PAYMENTCARD_S, its related sequence used to generate primary key values. Masking behavior is driven by IBY_SYS_SECURITY_OPTIONS, which stores system-level security configuration. Party and location data are sourced from the HZ schema tables HZ_PARTIES, HZ_LOCATIONS, HZ_PARTY_SITES, and HZ_PARTY_SITE_USES, reflecting the relationship between a card instrument and the trading partner and site to which it belongs. The package also references DUAL for simple value evaluations consistent with standard PL/SQL practice.

Usage Notes

IBY_PAYMENTCARD_PKG is typically invoked from the Oracle Payments setup and payment instrument forms, which call CREATE_CARD, UPDATE_CARD, and GET_CARD to manage card records on behalf of users. Masking routines are exercised during data retrieval and display, and MASK_CARD_NUMBER is often reused by custom reports or extensions that must show obfuscated card values. REMASK_INSTRUMENTS is commonly scheduled as an administrative or remediation step when security settings change, ensuring all stored instruments conform to current masking policy. Because the package is not referenced by any other database object, it is intended to be called directly rather than through inter-package dependencies, and custom code should invoke the documented procedures rather than touching IBY_PAYMENTCARD directly to preserve validation and security behavior.