index

Package gb_payment

Common Business interface for the PAYMENT API (gb_payment).

Program units
f_api_version   Returns the API version number.
f_exists   Checks if a record exists.
f_appl_value   Returns the value associated with a parameter.
f_get_one   Returns the records for the entity.
f_isequal   Compares two records for equality.
f_query_all   Selects all records for the entity.
f_query_one   Selects one record using the key.
f_query_by_rowid   Selects one record using the ROWID.
f_query_one_lock   Selects one record and locks it.
p_create   Creates a record.
p_delete   Deletes a record.
p_lock   Locks a record.
p_update   Updates a record.

Types
payment_rec   Business Entity record type
payment_ref   Entity cursor variable type
payment_tab   Entity table type

Constants
M_ENTITY_NAME   Business Entity Name
M_BASE_TABLE_NAME   Base table name

M_ENTITY_NAME 

M_ENTITY_NAME        CONSTANT VARCHAR2(7) := 'PAYMENT';

Business Entity Name

M_BASE_TABLE_NAME 

M_BASE_TABLE_NAME    CONSTANT VARCHAR2(7) := 'GORCCAU';

Base table name

payment_rec 

TYPE payment_rec IS RECORD (
  r_id                      gorccau.gorccau_id%TYPE,
  r_pidm                    gorccau.gorccau_pidm%TYPE,
  r_term_code               gorccau.gorccau_term_code%TYPE,
  r_location                gorccau.gorccau_location%TYPE,
  r_detail                  gorccau.gorccau_detail%TYPE,
  r_street_line1            gorccau.gorccau_street_line1%TYPE,
  r_street_line2            gorccau.gorccau_street_line2%TYPE,
  r_stat_code               gorccau.gorccau_stat_code%TYPE,
  r_zip                     gorccau.gorccau_zip%TYPE,
  r_natn_code               gorccau.gorccau_natn_code%TYPE,
  r_merchant_id             gorccau.gorccau_merchant_id%TYPE,
  r_debug_msg               gorccau.gorccau_debug_msg%TYPE,
  r_status                  gorccau.gorccau_status%TYPE,
  r_street_line3            gorccau.gorccau_street_line3%TYPE,
  r_street_line4            gorccau.gorccau_street_line4%TYPE,
  r_pay_trans_id            gorccau.gorccau_pay_trans_id%TYPE,
  r_vendor_status           gorccau.gorccau_vendor_status%TYPE,
  r_banner_status           gorccau.gorccau_banner_status%TYPE,
  r_vendor_error_msg        gorccau.gorccau_vendor_error_msg%TYPE,
  r_application_data        gorccau.gorccau_application_data%TYPE,
  r_update_function         gorccau.gorccau_update_function%TYPE,
  r_success_url             gorccau.gorccau_success_url%TYPE,
  r_failure_url             gorccau.gorccau_failure_url%TYPE,
  r_vendor_auth_code        gorccau.gorccau_vendor_auth_code%TYPE,
  r_last_name               gorccau.gorccau_last_name%TYPE,
  r_first_name              gorccau.gorccau_first_name%TYPE,
  r_middle_name             gorccau.gorccau_middle_name%TYPE,
  r_surname_prefix          gorccau.gorccau_surname_prefix%TYPE,
  r_name_prefix             gorccau.gorccau_name_prefix%TYPE,
  r_name_suffix             gorccau.gorccau_name_suffix%TYPE,
  r_sub_code                gorccau.gorccau_sub_code%TYPE,
  r_proc_code               gorccau.gorccau_proc_code%TYPE,
  r_sysi_code               gorccau.gorccau_sysi_code%TYPE,
  r_appl_no                 gorccau.gorccau_appl_no%TYPE,
  r_city                    gorccau.gorccau_city%TYPE,
  r_house_number            gorccau.gorccau_house_number%TYPE,
  r_aidm                    gorccau.gorccau_aidm%TYPE,
  r_gift_no                 gorccau.gorccau_gift_no%TYPE,
  r_vendor_refer_no         gorccau.gorccau_vendor_refer_no%TYPE,
  r_amount                  gorccau.gorccau_amount%TYPE,
  r_cart_id                 gorccau.gorccau_cart_id%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

payment_ref 

TYPE payment_ref IS REF CURSOR RETURN payment_rec;

Entity cursor variable type

payment_tab 

TYPE payment_tab IS TABLE OF payment_rec INDEX BY BINARY_INTEGER;

Entity table type

f_api_version 

FUNCTION f_api_version RETURN PLS_INTEGER

Returns the API version number.

Returns
Version of the API signature. Changes only when the signature changes.

f_exists 

FUNCTION f_exists(p_pay_trans_id gorccau.gorccau_pay_trans_id%TYPE,
                  p_rowid        gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_pay_trans_id   The unique transaction id associated with the external vendor payment. NUMBER Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
Y if found, otherwise N.

f_appl_value 

FUNCTION f_appl_value(p_parm         gorccau.gorccau_application_data%TYPE,
                      p_appl_data    gorccau.gorccau_application_data%TYPE DEFAULT NULL,
                      p_pay_trans_id gorccau.gorccau_pay_trans_id%TYPE DEFAULT NULL)
  RETURN VARCHAR2

Returns the value associated with a parameter.

Parameters
p_parm   The parameter for which a value should be returned
p_appl_data   The string where the parm / value pair is located. The format must be parm=value|parm=value| ...
p_pay_trans_id   The transaction id, if present, that will be used to retrieve the p_appl_data from gorccau_application_data (if p_appl_data was null also)

Returns
The value associated with p_parm

f_get_one 

FUNCTION f_get_one(p_pay_trans_id gorccau.gorccau_pay_trans_id%TYPE)
  RETURN gorccau%ROWTYPE

Returns the records for the entity.

Parameters
p_pay_trans_id   The unique transaction id associated with the external vendor payment. NUMBER Required Key

Returns
The record for the transaction id. If a record does not exist, the record will be null

f_isequal 

FUNCTION f_isequal(rec_one payment_rec,
                   rec_two payment_rec) RETURN VARCHAR2

Compares two records for equality.
Tests each field of rec_one against the corresponding field of rec_two. Two null values are considered equal.

Parameters
rec_one   The first record to compare. Type payment_rec Required
rec_two   The second record to compare. Type payment_rec Required

Returns
Y if all values in records are equal, otherwise N. Nulls match Nulls.

f_query_all 

FUNCTION f_query_all(p_pay_trans_id gorccau.gorccau_pay_trans_id%TYPE)
  RETURN payment_ref

Selects all records for the entity.

Parameters
p_pay_trans_id   The unique transaction id associated with the external vendor payment. NUMBER Required Key

Returns
A cursor variable that will fetch a set of records.

f_query_one 

FUNCTION f_query_one(p_pay_trans_id gorccau.gorccau_pay_trans_id%TYPE)
  RETURN payment_ref

Selects one record using the key.

Parameters
p_pay_trans_id   The unique transaction id associated with the external vendor payment. NUMBER Required Key

Returns
A cursor variable that will fetch exactly one record.

f_query_by_rowid 

FUNCTION f_query_by_rowid(p_rowid gb_common.internal_record_id_type)
  RETURN payment_ref

Selects one record using the ROWID.

Parameters
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18) Required

Returns
A cursor variable that will fetch exactly one record.

f_query_one_lock 

FUNCTION f_query_one_lock(p_pay_trans_id gorccau.gorccau_pay_trans_id%TYPE,
                          p_rowid        gb_common.internal_record_id_type DEFAULT NULL)
  RETURN payment_ref

Selects one record and locks it.

Parameters
p_pay_trans_id   The unique transaction id associated with the external vendor payment. NUMBER Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
A cursor variable for one record, locking the record.

p_create 

PROCEDURE p_create(p_id               gorccau.gorccau_id%TYPE,
                   p_pidm             gorccau.gorccau_pidm%TYPE DEFAULT NULL,
                   p_term_code        gorccau.gorccau_term_code%TYPE DEFAULT NULL,
                   p_location         gorccau.gorccau_location%TYPE DEFAULT NULL,
                   p_detail           gorccau.gorccau_detail%TYPE DEFAULT NULL,
                   p_street_line1     gorccau.gorccau_street_line1%TYPE DEFAULT NULL,
                   p_street_line2     gorccau.gorccau_street_line2%TYPE DEFAULT NULL,
                   p_stat_code        gorccau.gorccau_stat_code%TYPE DEFAULT NULL,
                   p_zip              gorccau.gorccau_zip%TYPE DEFAULT NULL,
                   p_natn_code        gorccau.gorccau_natn_code%TYPE DEFAULT NULL,
                   p_merchant_id      gorccau.gorccau_merchant_id%TYPE DEFAULT NULL,
                   p_debug_msg        gorccau.gorccau_debug_msg%TYPE DEFAULT NULL,
                   p_status           gorccau.gorccau_status%TYPE DEFAULT NULL,
                   p_street_line3     gorccau.gorccau_street_line3%TYPE DEFAULT NULL,
                   p_street_line4     gorccau.gorccau_street_line4%TYPE DEFAULT NULL,
                   p_pay_trans_id     gorccau.gorccau_pay_trans_id%TYPE,
                   p_vendor_status    gorccau.gorccau_vendor_status%TYPE DEFAULT NULL,
                   p_banner_status    gorccau.gorccau_banner_status%TYPE DEFAULT NULL,
                   p_vendor_error_msg gorccau.gorccau_vendor_error_msg%TYPE DEFAULT NULL,
                   p_application_data gorccau.gorccau_application_data%TYPE DEFAULT NULL,
                   p_update_function  gorccau.gorccau_update_function%TYPE DEFAULT NULL,
                   p_success_url      gorccau.gorccau_success_url%TYPE DEFAULT NULL,
                   p_failure_url      gorccau.gorccau_failure_url%TYPE DEFAULT NULL,
                   p_vendor_auth_code gorccau.gorccau_vendor_auth_code%TYPE DEFAULT NULL,
                   p_last_name        gorccau.gorccau_last_name%TYPE DEFAULT NULL,
                   p_first_name       gorccau.gorccau_first_name%TYPE DEFAULT NULL,
                   p_middle_name      gorccau.gorccau_middle_name%TYPE DEFAULT NULL,
                   p_surname_prefix   gorccau.gorccau_surname_prefix%TYPE DEFAULT NULL,
                   p_name_prefix      gorccau.gorccau_name_prefix%TYPE DEFAULT NULL,
                   p_name_suffix      gorccau.gorccau_name_suffix%TYPE DEFAULT NULL,
                   p_sub_code         gorccau.gorccau_sub_code%TYPE DEFAULT NULL,
                   p_proc_code        gorccau.gorccau_proc_code%TYPE DEFAULT NULL,
                   p_sysi_code        gorccau.gorccau_sysi_code%TYPE DEFAULT NULL,
                   p_appl_no          gorccau.gorccau_appl_no%TYPE DEFAULT NULL,
                   p_city             gorccau.gorccau_city%TYPE DEFAULT NULL,
                   p_house_number     gorccau.gorccau_house_number%TYPE DEFAULT NULL,
                   p_aidm             gorccau.gorccau_aidm%TYPE DEFAULT NULL,
                   p_gift_no          gorccau.gorccau_gift_no%TYPE DEFAULT NULL,
                   p_vendor_refer_no  gorccau.gorccau_vendor_refer_no%TYPE DEFAULT NULL,
                   p_amount           gorccau.gorccau_amount%TYPE DEFAULT NULL,
                   p_cart_id          gorccau.gorccau_cart_id%TYPE DEFAULT NULL,
                   p_rowid_out        OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_id   ID of user requesting credit card transaction. VARCHAR2(9) Required
p_pidm   PIDM of user requesting credit card transaction. NUMBER(8)
p_term_code   Term Code associated with credit card transaction. VARCHAR2(6)
p_location   Point in transaction when record was created. VARCHAR2(120)
p_detail   Detail/Gift Code associated with transaction. VARCHAR2(20)
p_street_line1   Street line 1 of address data for transaction. VARCHAR2(75)
p_street_line2   Street line 2 of address data for transaction. VARCHAR2(75)
p_stat_code   State/Province of address data for transaction. VARCHAR2(3)
p_zip   Zip/Postal Code of address data for transaction. VARCHAR2(30)
p_natn_code   Nation code of address data for transaction. VARCHAR2(5)
p_merchant_id   3rd party trans code for transaction. VARCHAR2(20)
p_debug_msg   Debug message for troubleshooting process. VARCHAR2(100)
p_status   Status of transaction. VARCHAR2(40)
p_street_line3   Street line 3 of address data for transaction. VARCHAR2(75)
p_street_line4   Street line 4 of address data for transaction. VARCHAR2(75)
p_pay_trans_id   The unique transaction id associated with the external vendor payment. NUMBER Required Key
p_vendor_status   The last status associated with the transaction from a payment vendor perspective. VARCHAR2(40)
p_banner_status   The last status associated with the transaction from a Banner perspective. VARCHAR2(40)
p_vendor_error_msg   The error message from the payment vendor, if applicable, related to a failed transaction. VARCHAR2(4000)
p_application_data   Any extra information that may be associated with this specific transaction. VARCHAR2(4000)
p_update_function   The name of the function that will be called upon a successful pre-authorization return from the payment vendor. VARCHAR2(100)
p_success_url   The URL that will be used upon a successful transaction. VARCHAR2(1020)
p_failure_url   The URL that will be used upon an unsuccessful transaction. VARCHAR2(1020)
p_vendor_auth_code   The authorization code returned from the payment vendor that can be tied back to the payment transaction. VARCHAR2(50)
p_last_name   The last name associated with this transaction. VARCHAR2(60)
p_first_name   The first name associated with this transaction. VARCHAR2(60)
p_middle_name   The middle name associated with this transaction. VARCHAR2(60)
p_surname_prefix   The surname prefix associated with this transaction. VARCHAR2(60)
p_name_prefix   The name prefix associated with this transaction. VARCHAR2(20)
p_name_suffix   The name suffix associated with this transaction. VARCHAR2(20)
p_sub_code   Merchant Id based upon calling application. VARCHAR2(20)
p_proc_code   Process Name Code associated with the transaction. VARCHAR2(30)
p_sysi_code   System Code associated with the transaction. VARCHAR2(2)
p_appl_no   Person Application Sequence Number. NUMBER(3)
p_city   City of address data for transaction. VARCHAR2(50)
p_house_number   House number of address data for transaction. VARCHAR2(10)
p_aidm   AIDM of user requesting credit card transaction. NUMBER(8)
p_gift_no   Advancement gift number associated with the transaction. VARCHAR2(07)
p_vendor_refer_no   The reference number returned from the payment vendor that can be tied back to the payment transaction. VARCHAR2(30)
p_amount   Payment amount of transaction. NUMBER(12,2)
p_cart_id   The shopping cart id associated with the external vendor payment. VARCHAR2(60)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

PROCEDURE p_delete(p_pay_trans_id gorccau.gorccau_pay_trans_id%TYPE,
                   p_rowid        gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_pay_trans_id   The unique transaction id associated with the external vendor payment. NUMBER Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

PROCEDURE p_lock(p_pay_trans_id gorccau.gorccau_pay_trans_id%TYPE,
                 p_rowid_inout  IN OUT NOCOPY gb_common.internal_record_id_type)

Locks a record.
If the ROWID is not passed in, the record is located using the key values and the ROWID of the locked row is passed in p_rowid_inout.

Parameters
p_pay_trans_id   The unique transaction id associated with the external vendor payment. NUMBER Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

PROCEDURE p_update(p_id               gorccau.gorccau_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_pidm             gorccau.gorccau_pidm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_term_code        gorccau.gorccau_term_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_location         gorccau.gorccau_location%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_detail           gorccau.gorccau_detail%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street_line1     gorccau.gorccau_street_line1%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street_line2     gorccau.gorccau_street_line2%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_stat_code        gorccau.gorccau_stat_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_zip              gorccau.gorccau_zip%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_natn_code        gorccau.gorccau_natn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_merchant_id      gorccau.gorccau_merchant_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_debug_msg        gorccau.gorccau_debug_msg%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_status           gorccau.gorccau_status%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street_line3     gorccau.gorccau_street_line3%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street_line4     gorccau.gorccau_street_line4%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_pay_trans_id     gorccau.gorccau_pay_trans_id%TYPE,
                   p_vendor_status    gorccau.gorccau_vendor_status%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_banner_status    gorccau.gorccau_banner_status%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_vendor_error_msg gorccau.gorccau_vendor_error_msg%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_application_data gorccau.gorccau_application_data%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_update_function  gorccau.gorccau_update_function%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_success_url      gorccau.gorccau_success_url%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_failure_url      gorccau.gorccau_failure_url%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_vendor_auth_code gorccau.gorccau_vendor_auth_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_last_name        gorccau.gorccau_last_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_first_name       gorccau.gorccau_first_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_middle_name      gorccau.gorccau_middle_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_surname_prefix   gorccau.gorccau_surname_prefix%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_name_prefix      gorccau.gorccau_name_prefix%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_name_suffix      gorccau.gorccau_name_suffix%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sub_code         gorccau.gorccau_sub_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_proc_code        gorccau.gorccau_proc_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sysi_code        gorccau.gorccau_sysi_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_appl_no          gorccau.gorccau_appl_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_city             gorccau.gorccau_city%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_house_number     gorccau.gorccau_house_number%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_aidm             gorccau.gorccau_aidm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_gift_no          gorccau.gorccau_gift_no%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_vendor_refer_no  gorccau.gorccau_vendor_refer_no%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_amount           gorccau.gorccau_amount%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_cart_id          gorccau.gorccau_cart_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid            gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_id   ID of user requesting credit card transaction. VARCHAR2(9) Required
p_pidm   PIDM of user requesting credit card transaction. NUMBER(8)
p_term_code   Term Code associated with credit card transaction. VARCHAR2(6)
p_location   Point in transaction when record was created. VARCHAR2(120)
p_detail   Detail/Gift Code associated with transaction. VARCHAR2(20)
p_street_line1   Street line 1 of address data for transaction. VARCHAR2(75)
p_street_line2   Street line 2 of address data for transaction. VARCHAR2(75)
p_stat_code   State/Province of address data for transaction. VARCHAR2(3)
p_zip   Zip/Postal Code of address data for transaction. VARCHAR2(30)
p_natn_code   Nation code of address data for transaction. VARCHAR2(5)
p_merchant_id   3rd party trans code for transaction. VARCHAR2(20)
p_debug_msg   Debug message for troubleshooting process. VARCHAR2(100)
p_status   Status of transaction. VARCHAR2(40)
p_street_line3   Street line 3 of address data for transaction. VARCHAR2(75)
p_street_line4   Street line 4 of address data for transaction. VARCHAR2(75)
p_pay_trans_id   The unique transaction id associated with the external vendor payment. NUMBER Required Key
p_vendor_status   The last status associated with the transaction from a payment vendor perspective. VARCHAR2(40)
p_banner_status   The last status associated with the transaction from a Banner perspective. VARCHAR2(40)
p_vendor_error_msg   The error message from the payment vendor, if applicable, related to a failed transaction. VARCHAR2(4000)
p_application_data   Any extra information that may be associated with this specific transaction. VARCHAR2(4000)
p_update_function   The name of the function that will be called upon a successful pre-authorization return from the payment vendor. VARCHAR2(100)
p_success_url   The URL that will be used upon a successful transaction. VARCHAR2(1020)
p_failure_url   The URL that will be used upon an unsuccessful transaction. VARCHAR2(1020)
p_vendor_auth_code   The authorization code returned from the payment vendor that can be tied back to the payment transaction. VARCHAR2(50)
p_last_name   The last name associated with this transaction. VARCHAR2(60)
p_first_name   The first name associated with this transaction. VARCHAR2(60)
p_middle_name   The middle name associated with this transaction. VARCHAR2(60)
p_surname_prefix   The surname prefix associated with this transaction. VARCHAR2(60)
p_name_prefix   The name prefix associated with this transaction. VARCHAR2(20)
p_name_suffix   The name suffix associated with this transaction. VARCHAR2(20)
p_sub_code   Merchant Id based upon calling application. VARCHAR2(20)
p_proc_code   Process Name Code associated with the transaction. VARCHAR2(30)
p_sysi_code   System Code associated with the transaction. VARCHAR2(2)
p_appl_no   Person Application Sequence Number. NUMBER(3)
p_city   City of address data for transaction. VARCHAR2(50)
p_house_number   House number of address data for transaction. VARCHAR2(10)
p_aidm   AIDM of user requesting credit card transaction. NUMBER(8)
p_gift_no   Advancement gift number associated with the transaction. VARCHAR2(7)
p_vendor_refer_no   The reference number returned from the payment vendor that can be tied back to the payment transaction. VARCHAR2(30)
p_amount   Payment amount of transaction. NUMBER(12,2)
p_cart_id   The shopping cart id associated with the external vendor payment. VARCHAR2(60)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)