SAIF.Business.Payment.EFT database tables¶
This page catalogs database tables accessed by this library. All tables target Oracle.* Schema qualifiers are shown exactly as they appear in the SQL (e.g., PAYMENT_OWNER); tables accessed without an explicit qualifier are marked [unqualified]**.
Table catalog¶
| Table | Database | Schema/Link | CRUD | Purpose | Primary business object |
|---|---|---|---|---|---|
| ACH_FILE_ID | Oracle* | [unqualified]** | R | ACH file identifier reference data | clsAchFileID, clsAchFileIDCollection |
| ACH_STANDARD_ENTRY_CLASS_CODE | Oracle* | [unqualified]** | R | ACH standard entry class code reference data | clsAchStandardEntryClassCode |
| ADDENDA_TYPE_CODE | Oracle* | [unqualified]** | R | Addenda type code reference data | clsAddendaTypeCode, clsAddendaTypeCodeCollection |
| AUTHORIZATION_TYPE_CODE | Oracle* | [unqualified]** | R | Authorization type code reference data | clsAuthorizationTypeCode, clsAuthorizationTypeCodeCollection |
| BALANCE_TYPE_CODE | Oracle* | [unqualified]** | R | Balance type code reference data including dynamic SQL | clsBalanceTypeCode |
| BANK_ACCOUNT | Oracle* | [unqualified]** | CDRU | Bank account records with routing/account numbers and status | clsBankAccount, clsBankAccountCollection |
| BANK_ACCOUNT_DATA_SOURCE_CODE | Oracle* | [unqualified]** | R | Bank account data source code reference data | clsBankAccountDataSourceCode, clsBankAccountDataSourceCodeCollection |
| BANK_ACCOUNT_STATUS_CODE | Oracle* | [unqualified]** | R | Bank account status code reference data | clsBankAccountStatusCode, clsBankAccountStatusCodeCollection |
| BANK_ACCOUNT_TRANSFER | Oracle* | [unqualified]** | CRU | Bank account transfer records linking bank accounts to US Bank users | clsBankAccountTransfer |
| BANK_ACCOUNT_TYPE_CODE | Oracle* | [unqualified]** | R | Bank account type code reference data | clsBankAccountTypeCode, clsBankAccountTypeCodeCollection |
| BANKING_NETWORK_CODE | Oracle* | [unqualified]** | CRU | Banking network code reference data (writable) | clsBankingNetworkCode, clsBankingNetworkCodeCollection |
| CUSTOMER_TYPE_CODE | Oracle* | [unqualified]** | R | Customer type code reference data | clsCustomerTypeCode, clsCustomerTypeCodeCollection |
| DEBIT_CARD_ENROLLMENT_REQUEST | Oracle* | [unqualified]** | CRU | Debit card payment enrollment requests | clsDebitCardEnrollmentRequest, clsDebitCardEnrollmentRequestCollection |
| DUAL | Oracle* | [unqualified]** | S | Oracle pseudo-table for sequence generation | Multiple transactional BOs |
| ENROLL_STATUS_CODE | Oracle* | [unqualified]** | R | Enrollment status code reference data | clsEnrollStatusCode, clsEnrollStatusCodeCollection |
| ONLINE_PAYMENT_TYPE_CODE | Oracle* | [unqualified]** | R | Online payment type code reference data | clsOnlinePaymentTypeCode, clsOnlinePaymentTypeCodeCollection |
| OUTPUT_CONTROL | Oracle* | [unqualified]** | CRU | Output control records for claim document generation | clsOutputControl, clsOutputControlCollection |
| OUTPUT_DOCUMENT_CODE | Oracle* | [unqualified]** | R | Output document code reference data | clsOutputDocumentCode, clsOutputDocumentCodeCollection |
| PAYMENT_ADDENDA | Oracle* | [unqualified]** | CDRU | NACHA ACH addenda records attached to payment details | clsPaymentAddenda, clsPaymentAddendaCollection |
| PAYMENT_ALLOCATION | Oracle* | [unqualified]** | CRU | Payment allocations across claim/benefit categories | clsPaymentAllocation, clsPaymentAllocationCollection |
| PAYMENT_AUTHORIZATION | Oracle* | [unqualified]** | CDRU | EFT authorization/consent records | clsEFTAuthorization, clsEFTAuthorizationCollection |
| PAYMENT_AUTH_SESSION_TRANSFER | Oracle* | [unqualified]** | CR | Links payment authorizations to session transfers | clsPaymentAuthorizationSessionTransfer |
| PAYMENT_DETAIL | Oracle* | [unqualified]** | CRU | Individual EFT payment line items | clsPaymentDetail |
| PAYMENT_EVENT | Oracle* | [unqualified]** | CR | Payment lifecycle event records | clsPaymentEvent, clsPaymentEventCollection |
| PAYMENT_EVENT_CODE | Oracle* | [unqualified]** | R | Payment event code reference data | clsPaymentEventCode, clsPaymentEventCodeCollection |
| PAYMENT_OWNER.AUTHORIZATION_TYPE_CODE | Oracle* | PAYMENT_OWNER | R | Authorization type code accessed via PAYMENT_OWNER schema for payment return context | clsPaymentReturn, clsPaymentReturnCollection |
| PAYMENT_OWNER.PAYMENT_AUTHORIZATION | Oracle* | PAYMENT_OWNER | R | Payment authorization accessed via PAYMENT_OWNER schema for payment return context | clsPaymentReturn, clsPaymentReturnCollection |
| PAYMENT_OWNER.PAYMENT_DETAIL | Oracle* | PAYMENT_OWNER | R | Payment detail accessed via PAYMENT_OWNER schema for EFT auth collection and payment return context | clsEFTAuthorizationCollection, clsPaymentReturn, clsPaymentReturnCollection |
| PAYMENT_OWNER.PAYMENT_RETURN | Oracle* | PAYMENT_OWNER | R | Payment return data accessed via PAYMENT_OWNER schema | clsPaymentReturn, clsPaymentReturnCollection |
| PAYMENT_OWNER.PAYMENT_RETURN_REASON_CODE | Oracle* | PAYMENT_OWNER | R | Payment return reason code accessed via PAYMENT_OWNER schema | clsPaymentReturn, clsPaymentReturnCollection |
| PAYMENT_OWNER.REVOKE_REASON_CODE | Oracle* | PAYMENT_OWNER | R | Revoke reason code accessed via PAYMENT_OWNER schema | clsRevokeReasonCode, clsRevokeReasonCodeCollection |
| PAYMENT_RETURN | Oracle* | [unqualified]** | CU | Payment return records (insert/update without schema qualifier) | clsPaymentReturn |
| PAYMENT_RETURN_REASON_CODE | Oracle* | [unqualified]** | R | NACHA return reason code reference data | clsPaymentReturnReasonCode, clsPaymentReturnReasonCodeCollection |
| PAYMENT_RETURN_REASON_GCODE | Oracle* | [unqualified]** | R | Culture-aware return reason code descriptions | clsPaymentReturn, clsPaymentReturnReasonCode |
| PAYMENT_SOURCE_SYSTEM_CODE | Oracle* | [unqualified]** | R | Payment source system code reference data | clsPaymentSourceSystemCode, clsPaymentSourceSystemCodeCollection |
| RETURN_STATUS_CODE | Oracle* | [unqualified]** | R | Return status code reference data | clsReturnStatusCode, clsReturnStatusCodeCollection |
| RETURN_TYPE_CODE | Oracle* | [unqualified]** | R | Return type code reference data | clsReturnTypeCode, clsReturnTypeCodeCollection |
| REVOKE_REASON_CODE | Oracle* | [unqualified]** | R | Revoke reason code reference data (also accessed via PAYMENT_OWNER in return context) | clsEFTAuthorization, clsRevokeReasonCode |
| SESSION_TRANSFER | Oracle* | [unqualified]** | CRU | Session transfer records linking policies/users to payment details | clsSessionTransfer |
ACH_FILE_ID¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Stores ACH file identifiers and descriptions used in batch file generation. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | ACH_FILE_ID, ACH_FILE_DESCR |
| Sequence | N/A |
| Related tables | ACH_STANDARD_ENTRY_CLASS_CODE (references ACH_FILE_ID) |
| Business objects | clsAchFileID, clsAchFileIDCollection |
SQL referencing this table¶
ACH_STANDARD_ENTRY_CLASS_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Reference data for ACH standard entry class codes, filtered by banking network, data source, and business/consumer type. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | BANKING_NETWORK_CODE, BANK_ACCOUNT_DATA_SOURCE_CODE, BUSINESS_CONSUMER_CODE, CODE, CODE_DESCR, MAX_ADDENDA_RECORD_COUNT |
| Sequence | N/A |
| Related tables | BANKING_NETWORK_CODE, BANK_ACCOUNT_DATA_SOURCE_CODE |
| Business objects | clsAchStandardEntryClassCode |
SQL referencing this table¶
ADDENDA_TYPE_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Reference data for NACHA addenda type codes. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR |
| Sequence | N/A |
| Related tables | PAYMENT_ADDENDA |
| Business objects | clsAddendaTypeCode, clsAddendaTypeCodeCollection |
SQL referencing this table¶
AUTHORIZATION_TYPE_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Reference data for EFT authorization types including recurring payment flags, ACH company IDs/names, and default bank routing numbers. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR, RECURRING_PAYMENT_FLAG, DEFAULT_BANK_ROUTING_NUM, ACH_COMPANY_ID, ACH_COMPANY_NAME, ACH_FILE_ID |
| Sequence | N/A |
| Related tables | PAYMENT_AUTHORIZATION (FK on AUTHORIZATION_TYPE_CODE) |
| Business objects | clsAuthorizationTypeCode, clsAuthorizationTypeCodeCollection, clsEFTAuthorization, clsPaymentDetail |
SQL referencing this table¶
- SQL-027: clsAuthorizationTypeCode retrieve by code
- SQL-028: clsAuthorizationTypeCodeCollection retrieve all
BALANCE_TYPE_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Reference data for balance types; includes GET_BALANCE_SQL_TXT column whose value is executed at runtime by DynamicallyCalculatedBalanceInfoFactory. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR, GET_BALANCE_SQL_TXT, MISC_RECEIPT_BATCH_ID, MISC_RECEIPT_CODE |
| Sequence | N/A |
| Related tables | PAYMENT_ALLOCATION (references BALANCE_TYPE_CODE) |
| Business objects | clsBalanceTypeCode, DynamicallyCalculatedBalanceInfoFactory |
SQL referencing this table¶
BANK_ACCOUNT¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Stores bank account records including routing/account numbers, type, status, owner name, and audit columns. Soft-deleted via status code. |
| Access pattern | Direct SQL |
| CRUD operations | Create (via sequence), Read, Update, Delete (soft-delete via status code) |
| Key columns used | BANK_ACCOUNT_SEQ_NUM, BANK_ACCOUNT_DATA_SOURCE_CODE, BANK_ACCOUNT_HOLDER_NAME, BANK_ACCOUNT_NICK_NAME, BANK_ACCOUNT_NUM, BANK_ACCOUNT_OWNER_NAME, BANK_ACCOUNT_STATUS_CODE, BANK_ACCOUNT_TYPE_CODE, BANK_NAME, BANK_ROUTING_NUM, BUSINESS_CONSUMER_CODE, HISTORICAL_AUTHORIZATION_FLAG, PAYMENT_RETURN_REASON_CODE, CREATE_DATE, CREATE_USER, UPDATE_DATE, UPDATE_USER |
| Sequence | BANK_ACCOUNT_SEQ |
| Related tables | BANK_ACCOUNT_TRANSFER, PAYMENT_AUTHORIZATION |
| Business objects | clsBankAccount, clsBankAccountCollection |
Operations referencing this table¶
Business rules referencing this table¶
- BR-EFT-04: Bank account soft-delete preserves record integrity
- BR-EFT-05: Insert/update operations require exactly one affected row
SQL referencing this table¶
- SQL-001: BANK_ACCOUNT_SEQ sequence
- SQL-009: clsBankAccount insert
- SQL-030: clsBankAccount retrieve by ID
- SQL-031: clsBankAccountCollection retrieve by create user
- SQL-077: clsBankAccount update
- SQL-088: clsBankAccount soft-delete
BANK_ACCOUNT_DATA_SOURCE_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Reference data for bank account data source codes. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR |
| Sequence | N/A |
| Related tables | BANK_ACCOUNT |
| Business objects | clsBankAccountDataSourceCode, clsBankAccountDataSourceCodeCollection |
SQL referencing this table¶
- SQL-032: clsBankAccountDataSourceCode retrieve by code
- SQL-033: clsBankAccountDataSourceCodeCollection retrieve all
BANK_ACCOUNT_STATUS_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Reference data for bank account status codes including the DELETED constant used in soft-delete. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR |
| Sequence | N/A |
| Related tables | BANK_ACCOUNT |
| Business objects | clsBankAccountStatusCode, clsBankAccountStatusCodeCollection |
SQL referencing this table¶
- SQL-034: clsBankAccountStatusCode retrieve by code
- SQL-035: clsBankAccountStatusCodeCollection retrieve all
BANK_ACCOUNT_TRANSFER¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Links bank account sequence numbers to US Bank user sequence numbers and account IDs. |
| Access pattern | Direct SQL |
| CRUD operations | Create, Read, Update |
| Key columns used | BANK_ACCOUNT_SEQ_NUM, US_BANK_USER_SEQ_NUM, US_BANK_ACCOUNT_ID |
| Sequence | N/A |
| Related tables | BANK_ACCOUNT |
| Business objects | clsBankAccountTransfer |
SQL referencing this table¶
- SQL-010: clsBankAccountTransfer insert
- SQL-036: clsBankAccountTransfer retrieve
- SQL-078: clsBankAccountTransfer update
- SQL-089: clsBankAccountTransfer delete
BANK_ACCOUNT_TYPE_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Reference data for bank account types (checking, savings, etc.) associated with banking networks. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | BANKING_NETWORK_CODE, CODE, CODE_DESCR |
| Sequence | N/A |
| Related tables | BANKING_NETWORK_CODE, BANK_ACCOUNT |
| Business objects | clsBankAccountTypeCode, clsBankAccountTypeCodeCollection |
SQL referencing this table¶
- SQL-037: clsBankAccountTypeCode retrieve by code
- SQL-038: clsBankAccountTypeCodeCollection retrieve all
BANKING_NETWORK_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Reference data for banking network codes; uniquely writable among code-table classes (supports insert, update, delete). |
| Access pattern | Direct SQL |
| CRUD operations | Create, Read, Update |
| Key columns used | CODE, CODE_DESCR |
| Sequence | CODE_NEXTVAL (sequence via SELECT CODE_NEXTVAL FROM DUAL)* |
| Related tables | ACH_STANDARD_ENTRY_CLASS_CODE, BANK_ACCOUNT_TYPE_CODE |
| Business objects | clsBankingNetworkCode, clsBankingNetworkCodeCollection |
SQL referencing this table¶
- SQL-002: clsBankingNetworkCode sequence
- SQL-011: clsBankingNetworkCode insert
- SQL-039: clsBankingNetworkCode retrieve by code
- SQL-040: clsBankingNetworkCodeCollection retrieve all
- SQL-079: clsBankingNetworkCode update
- SQL-090: clsBankingNetworkCode delete
CUSTOMER_TYPE_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Reference data for customer types used in EFT authorization context. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR |
| Sequence | N/A |
| Related tables | PAYMENT_AUTHORIZATION |
| Business objects | clsCustomerTypeCode, clsCustomerTypeCodeCollection |
SQL referencing this table¶
DEBIT_CARD_ENROLLMENT_REQUEST¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Tracks debit-card payment enrollment requests including cardholder identity, address, dates, and enrollment status. |
| Access pattern | Direct SQL |
| CRUD operations | Create (via sequence), Read, Update |
| Key columns used | ENROLL_REQUEST_SEQ_NUM, ENROLL_STATUS_CODE, NEW_ENROLL_FLAG, CARDHOLDER_ID_NUM, FULL_NAME, SECOND_FULL_NAME, CARD_ENROLL_DATE, CARD_ACTIVE_DATE, CARD_TERM_DATE, ADDRESS_LINE1, STATE_CODE, ZIP_CODE, CREATE_DATE, CREATE_USER, UPDATE_DATE, UPDATE_USER |
| Sequence | ENROLL_REQUEST_SEQ |
| Related tables | PAYMENT_AUTHORIZATION |
| Business objects | clsDebitCardEnrollmentRequest, clsDebitCardEnrollmentRequestCollection |
Operations referencing this table¶
Business rules referencing this table¶
SQL referencing this table¶
- SQL-003: ENROLL_REQUEST_SEQ sequence
- SQL-012: clsDebitCardEnrollmentRequest insert
- SQL-043: clsDebitCardEnrollmentRequest retrieve
- SQL-044: clsDebitCardEnrollmentRequestCollection retrieve
- SQL-080: clsDebitCardEnrollmentRequest update
- SQL-091: clsDebitCardEnrollmentRequest delete
DUAL¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Oracle pseudo-table used exclusively for sequence NEXTVAL generation. |
| Access pattern | Direct SQL |
| CRUD operations | Sequence (S) |
| Key columns used | N/A |
| Sequence | BANK_ACCOUNT_SEQ, ENROLL_REQUEST_SEQ, OUTPUT_CONTROL_SEQ, PAYMENT_ADDENDA_SEQ, PAYMENT_DETAIL_SEQ, PAYMENT_EVENT_SEQ, PAYMENT_RETURN_SEQ, CODE_NEXTVAL |
| Related tables | N/A |
| Business objects | clsBankAccount, clsBankingNetworkCode, clsDebitCardEnrollmentRequest, clsOutputControl, clsPaymentAddenda, clsPaymentDetail, clsPaymentEvent, clsPaymentReturn |
SQL referencing this table¶
ENROLL_STATUS_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Reference data for debit-card enrollment status codes. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR |
| Sequence | N/A |
| Related tables | DEBIT_CARD_ENROLLMENT_REQUEST |
| Business objects | clsEnrollStatusCode, clsEnrollStatusCodeCollection |
SQL referencing this table¶
ONLINE_PAYMENT_TYPE_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Reference data for online payment types including NSF limits, notification addresses, and ACH report headings. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR, DEFAULT_COMPANY_ENTRY_DESCR, DEFAULT_CREDIT_DEBIT_CODE, DEFAULT_PAYMENT_DAY_OF_MTH_NUM, MAX_NSF_COUNT, NOTIFY_EMAIL_ADDR, ACH_REPORT_HEADING |
| Sequence | N/A |
| Related tables | PAYMENT_DETAIL |
| Business objects | clsOnlinePaymentTypeCode, clsOnlinePaymentTypeCodeCollection |
SQL referencing this table¶
- SQL-049: clsOnlinePaymentTypeCode retrieve by code
- SQL-050: clsOnlinePaymentTypeCodeCollection retrieve all
OUTPUT_CONTROL¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Tracks output control records for claim document generation, linking claims to output document codes and print dates. |
| Access pattern | Direct SQL |
| CRUD operations | Create (via sequence), Read, Update |
| Key columns used | OUTPUT_CONTROL_SEQ_NUM, CLAIM_ID, OUTPUT_DOCUMENT_CODE, PERSON_ID, SECONDARY_ID, PRINTED_DATE, CREATE_DATE, CREATE_USER |
| Sequence | output_control_seq |
| Related tables | OUTPUT_DOCUMENT_CODE |
| Business objects | clsOutputControl, clsOutputControlCollection |
SQL referencing this table¶
- SQL-004: output_control_seq sequence
- SQL-014: clsOutputControl insert
- SQL-051: clsOutputControl retrieve by seq num
- SQL-052: clsOutputControlCollection retrieve
- SQL-082: clsOutputControl update
- SQL-093: clsOutputControl delete
OUTPUT_DOCUMENT_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Reference data for output document codes including Xpresso package names. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR, CREATE_DATE, CREATE_USER, XPESSO_PACKAGE_NAME |
| Sequence | N/A |
| Related tables | OUTPUT_CONTROL |
| Business objects | clsOutputDocumentCode, clsOutputDocumentCodeCollection |
SQL referencing this table¶
- SQL-053: clsOutputDocumentCode retrieve by code
- SQL-054: clsOutputDocumentCodeCollection retrieve all
PAYMENT_ADDENDA¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Stores NACHA ACH addenda records attached to payment detail records. |
| Access pattern | Direct SQL |
| CRUD operations | Create (via sequence), Read, Update, Delete |
| Key columns used | PAYMENT_ADDENDA_SEQ_NUM, ADDENDA_TEXT, ADDENDA_TYPE_CODE, PAYMENT_DETAIL_SEQ_NUM, CREATE_DATE, CREATE_USER |
| Sequence | payment_addenda_seq |
| Related tables | PAYMENT_DETAIL, ADDENDA_TYPE_CODE |
| Business objects | clsPaymentAddenda, clsPaymentAddendaCollection |
Operations referencing this table¶
SQL referencing this table¶
- SQL-005: payment_addenda_seq sequence
- SQL-015: clsPaymentAddenda insert
- SQL-055: clsPaymentAddenda retrieve by seq num
- SQL-056: clsPaymentAddendaCollection retrieve by payment detail
- SQL-083: clsPaymentAddenda update
- SQL-094: clsPaymentAddenda delete
PAYMENT_ALLOCATION¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Allocates payment amounts across claim/benefit categories, linking session transfers to balance types and plan/policy period sequences. |
| Access pattern | Direct SQL |
| CRUD operations | Create, Read, Update |
| Key columns used | PAYMENT_ALLOCATION_SEQ_NUM, SESSION_TRANSFER_SEQ_NUM, BALANCE_TYPE_CODE, AMOUNT, APPROVED_PLAN_SEQ_NUM, OSC_POLICY_PERIOD_SEQ_NUM, DYNAMIC_BALANCE_SEQ_NUM |
| Sequence | N/A |
| Related tables | SESSION_TRANSFER, BALANCE_TYPE_CODE |
| Business objects | clsPaymentAllocation, clsPaymentAllocationCollection |
Operations referencing this table¶
SQL referencing this table¶
- SQL-016: clsPaymentAllocation insert
- SQL-057: clsPaymentAllocationCollection retrieve
- SQL-084: clsPaymentAllocation update
- SQL-095: clsPaymentAllocation delete
PAYMENT_AUTHORIZATION¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Stores EFT authorization/consent records for payees including customer identity, bank account reference, prenote tracking, revocation, and IAT (International ACH Transaction) fields. |
| Access pattern | Direct SQL |
| CRUD operations | Create, Read, Update, Delete |
| Key columns used | PAYMENT_AUTHORIZATION_SEQ_NUM, AUTHORIZATION_TYPE_CODE, ENROLL_REQUEST_SEQ_NUM, AUTH_AGREEMENT_VERSION, AUTH_DATE, BANK_ACCOUNT_SEQ_NUM, CUSTOMER_ID, CUSTOMER_TYPE_CODE, PAYMENT_SOURCE_SYSTEM_CODE, PRENOTE_REQUIRED_FLAG, PRENOTE_SUCCESS_DATE, REVOKE_REASON_CODE, REVOKE_DATE, AUTO_PAY_CONFIRMATION_NUM, IAT_FLAG, UPDATE_DATE, UPDATE_USER |
| Sequence | N/A |
| Related tables | AUTHORIZATION_TYPE_CODE, REVOKE_REASON_CODE, BANK_ACCOUNT, PAYMENT_DETAIL |
| Business objects | clsEFTAuthorization, clsEFTAuthorizationCollection, clsPaymentDetail |
Operations referencing this table¶
Business rules referencing this table¶
SQL referencing this table¶
- SQL-013: clsEFTAuthorization insert
- SQL-045: clsEFTAuthorization retrieve
- SQL-046: clsEFTAuthorizationCollection retrieve
- SQL-081: clsEFTAuthorization update
- SQL-092: clsEFTAuthorization delete
PAYMENT_AUTH_SESSION_TRANSFER¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Links payment authorizations to session transfer records with associated due dates. |
| Access pattern | Direct SQL |
| CRUD operations | Create, Read |
| Key columns used | PAYMENT_AUTHORIZATION_SEQ_NUM, SESSION_TRANSFER_SEQ_NUM, DUE_DATE |
| Sequence | N/A |
| Related tables | PAYMENT_AUTHORIZATION, SESSION_TRANSFER |
| Business objects | clsPaymentAuthorizationSessionTransfer |
SQL referencing this table¶
- SQL-017: clsPaymentAuthorizationSessionTransfer insert
- SQL-058: clsPaymentAuthorizationSessionTransfer retrieve
PAYMENT_DETAIL¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Stores individual EFT payment line items with amounts, event codes, ACH entry class codes, and prenote flags. |
| Access pattern | Direct SQL |
| CRUD operations | Create (via sequence), Read, Update |
| Key columns used | PAYMENT_DETAIL_SEQ_NUM, ACH_STD_ENTRY_CLASS_CODE, ACH_ADDENDUM_TEXT, CONFIRMATION_CHECK_NUM, CREDIT_DEBIT_CODE, CURRENT_PAYMENT_EVENT_CODE, NSF_COUNT, ONLINE_PAYMENT_TYPE_CODE, PAYMENT_AMT, PAYMENT_AUTHORIZATION_SEQ_NUM, PAYMENT_DATE, PRENOTE_FLAG, RESUBMIT_DATE, UPDATE_DATE, UPDATE_USER |
| Sequence | Payment_detail_seq |
| Related tables | PAYMENT_AUTHORIZATION, AUTHORIZATION_TYPE_CODE, PAYMENT_ADDENDA, PAYMENT_ALLOCATION, PAYMENT_EVENT |
| Business objects | clsPaymentDetail |
Operations referencing this table¶
Business rules referencing this table¶
SQL referencing this table¶
- SQL-006: Payment_detail_seq sequence
- SQL-018: clsPaymentDetail insert
- SQL-059: clsPaymentDetail retrieve
- SQL-085: clsPaymentDetail update
- SQL-096: clsPaymentDetail delete
PAYMENT_EVENT¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Records payment lifecycle events (ACH transmittal, return, etc.) linked to payment details. |
| Access pattern | Direct SQL |
| CRUD operations | Create (via sequence), Read |
| Key columns used | PAYMENT_EVENT_SEQ_NUM, PAYMENT_DETAIL_SEQ_NUM, PAYMENT_EVENT_CODE, BANK_EFF_ENTRY_DATE, BATCH_DATE, BATCH_NUM, PAYMENT_RETURN_REASON_CODE, TRACE_NUM, CREATE_DATE, CREATE_USER |
| Sequence | payment_event_seq |
| Related tables | PAYMENT_EVENT_CODE, PAYMENT_RETURN_REASON_CODE, PAYMENT_DETAIL |
| Business objects | clsPaymentEvent, clsPaymentEventCollection |
SQL referencing this table¶
- SQL-007: payment_event_seq sequence
- SQL-019: clsPaymentEvent insert
- SQL-060: clsPaymentEvent retrieve by seq num
- SQL-063: clsPaymentEventCollection retrieve by payment detail
PAYMENT_EVENT_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Reference data for payment event codes including bank transmittal flags. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR, CODE_SHORT_DESCR, BANK_TRANSMITTAL_FLAG |
| Sequence | N/A |
| Related tables | PAYMENT_EVENT |
| Business objects | clsPaymentEventCode, clsPaymentEventCodeCollection |
SQL referencing this table¶
PAYMENT_OWNER.AUTHORIZATION_TYPE_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | PAYMENT_OWNER |
| Purpose | Authorization type code accessed via PAYMENT_OWNER schema qualifier in payment return queries. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR |
| Sequence | N/A |
| Related tables | PAYMENT_OWNER.PAYMENT_AUTHORIZATION |
| Business objects | clsPaymentReturn, clsPaymentReturnCollection |
SQL referencing this table¶
PAYMENT_OWNER.PAYMENT_AUTHORIZATION¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | PAYMENT_OWNER |
| Purpose | Payment authorization accessed via PAYMENT_OWNER schema qualifier in payment return queries. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | PAYMENT_AUTHORIZATION_SEQ_NUM, CUSTOMER_TYPE_CODE, CUSTOMER_CONTACT_NAME, AUTHORIZATION_TYPE_CODE |
| Sequence | N/A |
| Related tables | PAYMENT_OWNER.PAYMENT_DETAIL, PAYMENT_OWNER.AUTHORIZATION_TYPE_CODE |
| Business objects | clsPaymentReturn, clsPaymentReturnCollection |
SQL referencing this table¶
PAYMENT_OWNER.PAYMENT_DETAIL¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | PAYMENT_OWNER |
| Purpose | Payment detail accessed via PAYMENT_OWNER schema qualifier in EFT authorization collection and payment return queries. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | PAYMENT_DETAIL_SEQ_NUM, PAYMENT_AUTHORIZATION_SEQ_NUM, NSF_COUNT, CONFIRMATION_CHECK_NUM |
| Sequence | N/A |
| Related tables | PAYMENT_OWNER.PAYMENT_RETURN, PAYMENT_OWNER.PAYMENT_AUTHORIZATION |
| Business objects | clsEFTAuthorizationCollection, clsPaymentReturn, clsPaymentReturnCollection |
SQL referencing this table¶
- SQL-046: clsEFTAuthorizationCollection retrieve
- SQL-064: clsPaymentReturn retrieve
- SQL-065: clsPaymentReturnCollection retrieve
PAYMENT_OWNER.PAYMENT_RETURN¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | PAYMENT_OWNER |
| Purpose | Payment return records accessed via PAYMENT_OWNER schema qualifier. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | PAYMENT_RETURN_SEQ_NUM, PAYMENT_RETURN_REASON_CODE, RETURN_STATUS_CODE, PAYMENT_DETAIL_SEQ_NUM |
| Sequence | N/A |
| Related tables | PAYMENT_OWNER.PAYMENT_RETURN_REASON_CODE, PAYMENT_OWNER.PAYMENT_DETAIL |
| Business objects | clsPaymentReturn, clsPaymentReturnCollection |
SQL referencing this table¶
PAYMENT_OWNER.PAYMENT_RETURN_REASON_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | PAYMENT_OWNER |
| Purpose | Payment return reason code accessed via PAYMENT_OWNER schema qualifier in payment return queries. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR, RETURN_PAYMENT_EVENT_CODE |
| Sequence | N/A |
| Related tables | PAYMENT_OWNER.PAYMENT_RETURN, PAYMENT_RETURN_REASON_GCODE |
| Business objects | clsPaymentReturn, clsPaymentReturnCollection |
SQL referencing this table¶
PAYMENT_OWNER.REVOKE_REASON_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | PAYMENT_OWNER |
| Purpose | Revoke reason code reference data accessed via PAYMENT_OWNER schema qualifier. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR, INTERNAL_FLAG |
| Sequence | N/A |
| Related tables | PAYMENT_AUTHORIZATION |
| Business objects | clsRevokeReasonCode, clsRevokeReasonCodeCollection |
SQL referencing this table¶
PAYMENT_RETURN¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Stores returned/failed EFT payment records with return reason, status, type, customer details, and payment amount. Insert and update operations use the unqualified table name; reads go through PAYMENT_OWNER schema. |
| Access pattern | Direct SQL |
| CRUD operations | Create (via sequence), Update |
| Key columns used | PAYMENT_RETURN_SEQ_NUM, PAYMENT_RETURN_REASON_CODE, RETURN_STATUS_CODE, RETURN_TYPE_CODE, CREDIT_DEBIT_CODE, CUSTOMER_ID, CUSTOMER_NAME, PAYMENT_AMT, PAYMENT_DETAIL_SEQ_NUM, RETURN_DATE, TRACE_NUM, CREATE_DATE, CREATE_USER, UPDATE_DATE, UPDATE_USER |
| Sequence | PAYMENT_RETURN_SEQ |
| Related tables | PAYMENT_RETURN_REASON_CODE, RETURN_STATUS_CODE, RETURN_TYPE_CODE, PAYMENT_DETAIL |
| Business objects | clsPaymentReturn |
Operations referencing this table¶
Business rules referencing this table¶
SQL referencing this table¶
- SQL-008: PAYMENT_RETURN_SEQ sequence
- SQL-020: clsPaymentReturn insert
- SQL-086: clsPaymentReturn update
PAYMENT_RETURN_REASON_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | NACHA return reason code reference data with bank transmittal flags and return payment event codes. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR, BANK_TRANSMITTAL_FLAG, CATEGORY, RETURN_PAYMENT_EVENT_CODE |
| Sequence | N/A |
| Related tables | PAYMENT_RETURN, PAYMENT_EVENT, PAYMENT_RETURN_REASON_GCODE |
| Business objects | clsPaymentReturnReasonCode, clsPaymentReturnReasonCodeCollection |
Business rules referencing this table¶
- BR-EFT-03: Returned EFT payment classified by NACHA return reason code
- BR-EFT-07: Return reason description is culture-aware
SQL referencing this table¶
- SQL-066: clsPaymentReturnReasonCode retrieve by code
- SQL-067: clsPaymentReturnReasonCodeCollection retrieve
PAYMENT_RETURN_REASON_GCODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Culture-aware return reason code description overrides; joined to PAYMENT_RETURN_REASON_CODE when a locale-specific description is needed. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR, CULTURE_CODE |
| Sequence | N/A |
| Related tables | PAYMENT_RETURN_REASON_CODE |
| Business objects | clsPaymentReturn, clsPaymentReturnReasonCode |
Business rules referencing this table¶
SQL referencing this table¶
- SQL-064: clsPaymentReturn retrieve
- SQL-065: clsPaymentReturnCollection retrieve
- SQL-066: clsPaymentReturnReasonCode retrieve
- SQL-067: clsPaymentReturnReasonCodeCollection retrieve
PAYMENT_SOURCE_SYSTEM_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Reference data for payment source system codes with notification email addresses. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR, NOTIFY_EMAIL_ADDR |
| Sequence | N/A |
| Related tables | PAYMENT_AUTHORIZATION, PAYMENT_RETURN |
| Business objects | clsPaymentSourceSystemCode, clsPaymentSourceSystemCodeCollection |
SQL referencing this table¶
- SQL-068: clsPaymentSourceSystemCode retrieve by code
- SQL-069: clsPaymentSourceSystemCodeCollection retrieve all
RETURN_STATUS_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Reference data for EFT payment return status codes. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR |
| Sequence | N/A |
| Related tables | PAYMENT_RETURN |
| Business objects | clsReturnStatusCode, clsReturnStatusCodeCollection |
SQL referencing this table¶
RETURN_TYPE_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Reference data for EFT payment return type codes. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR |
| Sequence | N/A |
| Related tables | PAYMENT_RETURN |
| Business objects | clsReturnTypeCode, clsReturnTypeCodeCollection |
SQL referencing this table¶
REVOKE_REASON_CODE¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Reference data for EFT authorization revocation reason codes; also accessed via PAYMENT_OWNER schema (see PAYMENT_OWNER.REVOKE_REASON_CODE). Used in JOIN on PAYMENT_AUTHORIZATION for single-object retrieval. |
| Access pattern | Direct SQL |
| CRUD operations | Read |
| Key columns used | CODE, CODE_DESCR, INTERNAL_FLAG |
| Sequence | N/A |
| Related tables | PAYMENT_AUTHORIZATION |
| Business objects | clsEFTAuthorization, clsRevokeReasonCode |
SQL referencing this table¶
SESSION_TRANSFER¶
| Field | Value |
|---|---|
| Database | Oracle* |
| Schema/Link | [unqualified]** |
| Purpose | Links policy numbers and US Bank user sequence numbers to payment detail records for session context. |
| Access pattern | Direct SQL |
| CRUD operations | Create, Read, Update |
| Key columns used | SESSION_TRANSFER_SEQ_NUM, POLICY_NUM, US_BANK_USER_SEQ_NUM, PAYMENT_DETAIL_SEQ_NUM |
| Sequence | N/A |
| Related tables | PAYMENT_DETAIL, PAYMENT_AUTH_SESSION_TRANSFER |
| Business objects | clsSessionTransfer |
SQL referencing this table¶
- SQL-021: clsSessionTransfer insert
- SQL-076: clsSessionTransfer retrieve
- SQL-087: clsSessionTransfer update
- SQL-097: clsSessionTransfer delete
Table relationship diagram¶
The following diagram shows key relationships between core transactional tables used by this library.
erDiagram
BANK_ACCOUNT ||--o{ PAYMENT_AUTHORIZATION : "BANK_ACCOUNT_SEQ_NUM"
PAYMENT_AUTHORIZATION ||--o{ PAYMENT_DETAIL : "PAYMENT_AUTHORIZATION_SEQ_NUM"
PAYMENT_DETAIL ||--o{ PAYMENT_ADDENDA : "PAYMENT_DETAIL_SEQ_NUM"
PAYMENT_DETAIL ||--o{ PAYMENT_EVENT : "PAYMENT_DETAIL_SEQ_NUM"
PAYMENT_DETAIL ||--o{ PAYMENT_RETURN : "PAYMENT_DETAIL_SEQ_NUM"
PAYMENT_AUTHORIZATION ||--o{ PAYMENT_AUTH_SESSION_TRANSFER : "PAYMENT_AUTHORIZATION_SEQ_NUM"
SESSION_TRANSFER ||--o{ PAYMENT_AUTH_SESSION_TRANSFER : "SESSION_TRANSFER_SEQ_NUM"
SESSION_TRANSFER ||--o{ PAYMENT_ALLOCATION : "SESSION_TRANSFER_SEQ_NUM"
PAYMENT_AUTHORIZATION }|--|| AUTHORIZATION_TYPE_CODE : "AUTHORIZATION_TYPE_CODE"
PAYMENT_AUTHORIZATION }o--o| REVOKE_REASON_CODE : "REVOKE_REASON_CODE"
DEBIT_CARD_ENROLLMENT_REQUEST ||--o{ PAYMENT_AUTHORIZATION : "ENROLL_REQUEST_SEQ_NUM"
PAYMENT_RETURN }|--|| PAYMENT_RETURN_REASON_CODE : "PAYMENT_RETURN_REASON_CODE"
PAYMENT_RETURN_REASON_CODE ||--o{ PAYMENT_RETURN_REASON_GCODE : "CODE"
Note: Statements marked with
*were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts. Statements marked with**could not be confirmed; treat as unknown until verified.
Related documentation¶
- Index
- Overview
- Architecture
- Dependencies
- Operations and processes
- Business rules
- SQL catalog
- API reference
- Configuration
Sources¶
Business\SAIF.Business.Payment.EFT\clsBankAccount.vbBusiness\SAIF.Business.Payment.EFT\clsEFTAuthorization.vbBusiness\SAIF.Business.Payment.EFT\clsEFTAuthorizationCollection.vbBusiness\SAIF.Business.Payment.EFT\clsDebitCardEnrollmentRequest.vbBusiness\SAIF.Business.Payment.EFT\clsPaymentDetail.vbBusiness\SAIF.Business.Payment.EFT\clsPaymentAllocation.vbBusiness\SAIF.Business.Payment.EFT\clsPaymentAddenda.vbBusiness\SAIF.Business.Payment.EFT\clsPaymentReturn.vbBusiness\SAIF.Business.Payment.EFT\clsPaymentReturnReasonCode.vbBusiness\SAIF.Business.Payment.EFT\clsOutputControl.vbBusiness\SAIF.Business.Payment.EFT\clsSessionTransfer.vbBusiness\SAIF.Business.Payment.EFT\clsPaymentEvent.vbBusiness\SAIF.Business.Payment.EFT\clsPaymentAuthorizationSessionTransfer.vbBusiness\SAIF.Business.Payment.EFT\clsBankAccountTransfer.vbBusiness\SAIF.Business.Payment.EFT\clsAchFileID.vbBusiness\SAIF.Business.Payment.EFT\clsBalanceTypeCode.vbBusiness\SAIF.Business.Payment.EFT\clsBankingNetworkCode.vb