Search Results invalid_instrument

Overview

IBY_PAYMENTCARD_PKG is a PL/SQL package owned by the APPS schema in Oracle E-Business Suite, classified in ETRM as an "OTHER" API rather than a formally published public interface. It centralizes the business logic that governs payment card instruments within the Oracle Payments (IBY) module. Payment cards in EBS are stored as instruments on the IBY_PAYMENTCARD entity, and this package provides the validation, creation, update, retrieval, and masking routines that surround that data. The package is declared with AUTHID CURRENT_USER, meaning its SQL executes with the privileges of the calling schema rather than as definer's rights, which is significant for custom code that invokes it directly.

The package header defines a substantial set of constants that reveal its scope. It identifies the instrument type PAYMENTCARD, the COMCHECK card issuer, default masking behavior (the mask character 'X' and a default unmask length of four), a set of standard validation error codes such as INVALID_CARD_NUMBER, INVALID_CARD_EXPIRY, INVALID_CARD_ISSUER, INVALID_PARTY, and INVALID_ADDRESS, and the billing site usage constant PAYMENTCARD_BILLING. It also declares the PaymentCard_rec_type record, a structured representation of a payment card that includes the card identifier, owner, cardholder name, billing address attributes, card number, expiration date, instrument type, issuer, single-use and information-only flags, purpose, description, active status, and descriptive flexfield attribute columns.

Key Procedures and Functions

The documented API surface contains eight procedures and functions. Together they form the complete lifecycle for a payment card record.

• GET_MASK_SETTINGS — Retrieves the system-level configuration that determines how card numbers are masked, drawing on security options stored in the database.
• MASK_CARD_NUMBER — Applies the masking algorithm to a card number, replacing all but the configured trailing digits with the mask character. This supports PCI-oriented requirements to avoid displaying or storing full card numbers.
• CREATE_CARD — Validates and inserts a new payment card instrument, performing the checks associated with the package's error code constants before persisting the record.
• UPDATE_CARD — Modifies an existing card instrument, re-applying the relevant validations.
• GET_CARD — Retrieves a payment card, populating the PaymentCard_rec_type structure or equivalent output for the caller.
• CARD_EXISTS — The routine associated with the "card_exists" search. It provides an existence check, allowing callers to determine whether a given card already exists before attempting a create, which supports idempotent loading and duplicate prevention.
• REMASK_INSTRUMENTS — Bulk re-applies masking across stored card instruments, typically after a change to masking configuration or as part of a security remediation.

No parameter lists are documented in the ETRM metadata, and none should be assumed.

Tables Accessed

The package references these objects through APPS synonyms. IBY_PAYMENTCARD is the primary table holding card instrument records, and IBY_PAYMENTCARD_S is its corresponding sequence used to generate identifiers. IBY_SYS_SECURITY_OPTIONS supplies the masking and security configuration consumed by GET_MASK_SETTINGS. Party and address data is read from HZ_PARTIES, HZ_LOCATIONS, HZ_PARTY_SITES, and HZ_PARTY_SITE_USES, which validate the cardholder and billing address association; the package constants G_PARTY_SITE_ID and G_PARTY_SITE_USE_ID indicate that address resolution may target either a party site or a site use. DUAL is used for constant and sequence-style evaluations.

Usage Notes

Because ETRM reports that IBY_PAYMENTCARD_PKG is referenced by zero other packages, it is not part of a documented internal dependency chain. It is typically invoked from Oracle Payments setup and payment instrument entry flows, from Oracle iProcurement and Payables card entry forms, and from concurrent programs that load or refresh card data. Custom integrations that import or validate payment card instruments commonly call CARD_EXISTS to avoid duplicate creation and then CREATE_CARD or UPDATE_CARD to persist changes, while MASK_CARD_NUMBER and GET_MASK_SETTINGS are used in any custom reporting or display path that must avoid exposing full card numbers. Callers should note the AUTHID CURRENT_USER declaration and grant the executing schema appropriate privileges on the underlying tables before invoking the package.