DBA Data[Home] [Help]

PACKAGE: APPS.AR_PMT_PROCESS_WRAPPER

Source


1 package AR_PMT_PROCESS_WRAPPER AUTHID CURRENT_USER AS
2 /* $Header: ARIPAYWS.pls 115.2 2004/06/15 18:58:14 jypandey noship $ */
3 
4 
5 /*=======================================================================+
6  |  Declare PUBLIC Data Types and Variables
7  +=======================================================================*/
8 
9  /*--------------------------------------------------------------------------
10   | This is the record to capture the generic information related to a receipt.
11   | This can be useful for any customizations on this API.
12   |-------------------------------------------------------------------------*/
13   TYPE receipt_info_rec IS RECORD (
14   cash_receipt_id          ar_cash_receipts.cash_receipt_id%TYPE,
15   cr_amount                ar_cash_receipt_history.amount%TYPE,
16   cr_acctd_amount          ar_cash_receipt_history.acctd_amount%TYPE,
17   cust_bank_account_id     ar_cash_receipts.customer_bank_account_id%TYPE,
18   cash_receipt_history_id  ar_cash_receipt_history.cash_receipt_history_id%TYPE,
19   pay_from_customer        ar_cash_receipts.pay_from_customer%TYPE,
20   site_use_id              ar_cash_receipts.customer_site_use_id%TYPE);
21 
22  /*--------------------------------------------------------------------------
23   | This record contains all the parameters that are required to by iPayments
24   | Authorize API IBY_Payment_Adapter_pub.OraPmtReq.
25   |-------------------------------------------------------------------------*/
26   TYPE authorize_input_rec IS RECORD (
27   customer_bank_branch_id ap_bank_accounts.bank_branch_id%TYPE,
28   merchant_ref            ar_receipt_methods.merchant_ref%TYPE,
29   cus_bank_act_name       ap_bank_accounts.bank_account_name%TYPE,
30   cus_bank_act_num        ap_bank_accounts.bank_account_num%TYPE,
31   cus_bank_exp_date       ap_bank_accounts.inactive_date%TYPE,
32   payment_server_order_num  ar_cash_receipts.payment_server_order_num%TYPE,
33   receipt_amount          ar_cash_receipts.amount%TYPE,
34   receipt_number          ar_cash_receipts.receipt_number%TYPE,
35   currency_code           ar_cash_receipts.currency_code%TYPE,
36   payment_mode            VARCHAR2(30) DEFAULT 'ONLINE' ,
37   auth_TYPE               VARCHAR2(80)  DEFAULT 'AUTHONLY',
38   unique_reference        ar_cash_receipts.unique_reference%type
39  );
40 
41  /*--------------------------------------------------------------------------
42   | This record contains the output record returned by iPayments
43   |  Authorize API IBY_Payment_Adapter_pub.OraPmtReq.
44   |-------------------------------------------------------------------------*/
45   TYPE  authorize_output_rec IS RECORD (
46   x_reqresp_rec    IBY_Payment_Adapter_pub.ReqResp_rec_type);
47 
48  /*--------------------------------------------------------------------------
49   | This record contains all the parameters that are required to by iPayments
50   |  Capture API IBY_Payment_Adapter_pub.OraPmtCapture.
51   |-------------------------------------------------------------------------*/
52   TYPE  capture_input_rec IS RECORD (
53   payment_server_order_num  ar_cash_receipts.payment_server_order_num%TYPE,
54   receipt_amount            ar_cash_receipts.amount%TYPE,
55   currency_code             ar_cash_receipts.currency_code%TYPE,
56   TrxnRef                   ar_cash_receipts.unique_reference%TYPE
57   );
58 
59  /*--------------------------------------------------------------------------
60   | This record contains the output record returned by iPayments
61   | Capture API IBY_Payment_Adapter_pub.OraPmtCapture.
62   |-------------------------------------------------------------------------*/
63   TYPE  capture_output_rec IS RECORD (
64   x_capresp_rec    IBY_Payment_Adapter_pub.CaptureResp_rec_type);
65 
66  /*========================================================================
67  | PUBLIC PROCEDURE Authorize_Payment
68  |
69  | DESCRIPTION
70  |      This procedure makes a  call to iPayment's API for Authorization
71  |      IBY_Payment_Adapter_pub.OraPmtReq.
72  |
73  |
74  | PSEUDO CODE/LOGIC
75  |
76  | PARAMETERS
77  |      p_receipt_info_rec IN
78  |         This parameter is for capturing certain receipt related information
79  |         that could be useful in customizations.
80  |
81  |      p_authorize_input_rec      IN
82  |         This parameter is for capturing all the information that is required
83  |         to send to iPayment for Authorizations.
84  |
85  |      x_authorize_output_rec     OUT
86  |         This is the output record and comprises of the output record
87  |         returned by iPayment API IBY_Payment_Adapter_pub.ReqResp_rec_type
88  |
89  | KNOWN ISSUES
90  |
91  |
92  |
93  | NOTES
94  |
95  |
96  |
97  | MODIFICATION HISTORY
98  | Date                  Author            Description of Changes
99  | 15-MAR-2004           Jyoti Pandey      Created
100  |
101  *=======================================================================*/
102 
103    PROCEDURE Authorize_Payment (
104    p_receipt_info_rec IN receipt_info_rec,
105    p_authorize_input_rec IN authorize_input_rec,
106    x_authorize_output_rec OUT NOCOPY authorize_output_rec,
107    x_return_status OUT NOCOPY VARCHAR2,
108    x_msg_count OUT NOCOPY NUMBER,
109    x_msg_data OUT NOCOPY VARCHAR2) ;
110 
111 
112 
113  /*========================================================================
114  | PUBLIC PROCEDURE Capture_Payment
115  |
116  | DESCRIPTION
117  |      This procedure makes a  call to iPayment's API for Capture
118  |      IBY_Payment_Adapter_pub.OraPmtCapture
119  |
120  |
121  | PSEUDO CODE/LOGIC
122  |
123  | PARAMETERS
124  |      p_receipt_info_rec IN
125  |         This parameter is for capturing certain receipt related information
126  |         that could be useful in customizations.
127  |
128  |      p_capture_input_rec      IN
129  |         This parameter is for capturing all the information that is required
130  |         to send to iPayment for Capture.
131  |
132  |      x_capture_output_rec     OUT
133  |        This is the output record and comprises of the output record
134  |        returned by iPayment API IBY_Payment_Adapter_pub.CaptureResp_rec_type
135  |
136  | KNOWN ISSUES
137  |
138  |
139  |
140  | NOTES
141  |
142  |
143  |
144  | MODIFICATION HISTORY
145  | Date                  Author            Description of Changes
146  | 15-MAR-2004           Jyoti Pandey      Created
147  |
148  *=======================================================================*/
149 
150    PROCEDURE Capture_payment (
151    p_receipt_info_rec IN receipt_info_rec,
152    p_capture_input_rec        IN capture_input_rec,
153    x_capture_output_rec       OUT NOCOPY capture_output_rec,
154    x_return_status            OUT NOCOPY VARCHAR2,
155    x_msg_count                OUT NOCOPY NUMBER,
156    x_msg_data                 OUT NOCOPY VARCHAR2);
157 
158 
159 
160 END AR_PMT_PROCESS_WRAPPER;
161