This chapter provides reference information for Oracle Communications Billing and Revenue Management (BRM) payment utilities.
Use this utility to load the merchant information for all credit card processor and automated clearing house (ACH) vendors into the /config/ach object in the BRM database. You define the payment processor and merchant information in the BRM_Home/sys/data/pricing/example/pin_ach file.
For information about configuring merchants and payment processors, see "Setting Up Merchants and Payment Processors".
Note:
You cannot load separate /config/ach objects for each brand. All brands use the same object.Caution:
When you run the load_pin_ach utility, it replaces the existing payment processor and merchant information. If you are updating a set of processors and merchants, you cannot load new information only. You load complete sets of information each time you run the load_pin_ach utility.Important:
To connect to the BRM database, the load_pin_ach utility needs a configuration file in the directory from which you run the utility. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.Creates a log file for debugging purposes. Use this parameter for debugging when the utility appears to have run with no errors, but the ACH merchant data has not been loaded into the database.
Displays information about successful or failed processing as the utility runs.
Runs a test to check the input to the utility. It verifies that the input file exists and validates the information contained in the input file.
The name and location of the file that defines payment processor merchants. The default pin_ach file is in BRM_Home/sys/data/pricing/example.
If you copy the pin_ach file to the same directory from which you run the load_pin_ach utility, you do not have to specify either the path or the file name.
If you run the command in a different directory from where the pin_ach file is located, you must include the entire path for the file.
The load_pin_ach utility notifies you when it successfully creates the /config/ach storable object.
If the load_pin_ach utility does not notify you that it was successful, look in the utility log file (default.pinlog) to find any errors. The log file is either in the directory from which the utility was started, or in a directory specified in the configuration file.
Use this utility to perform all automatic sponsored top-ups that are scheduled to occur within the time range specified in the utility's command line parameters.
For information about automatic sponsored top-ups, see the following topics:
Performing Automatic Sponsored Top-Ups
Important:
To connect to the BRM database, this utility needs a configuration file in the directory from which you run the utility. For information about creating configuration files for BRM utilities, see "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.Displays information about successful or failed processing as the utility runs.
Note:
This parameter is always used with other parameters and commands. It is not position dependent. For example, you can enter -verbose at the beginning or end of a command to initiate the verbose parameter. To redirect the output to a log file, use the following syntax with the verbose parameter. Replace filename.log with the name of the log file:pin_balance_transfer other_parameter –verbose > filename.log
Tests the utility, but does not affect accounts. Use this parameter to see which accounts will receive automatic sponsored top-ups without actually transferring funds from group owner accounts to member accounts.
Start date. For information on using this parameter, see "Specifying Start and End Times" in BRM Configuring and Running Billing.
End date. For information on using this parameter, see "Specifying Start and End Times" in BRM Configuring and Running Billing.
Use this utility to replace the credit or debit card numbers stored in the /payinfo/cc objects with tokens. This utility does the following:
Selects the /payinfo/cc objects that contain credit or debit card numbers.
Sends the credit or debit card numbers to Paymentech requesting for tokens for each credit or debit card number.
Replaces the credit or debit card numbers stored in the /payinfo/cc objects with the tokens returned by Paymentech.
Important:
Ensure that the outstanding payments for credit card accounts are closed before running this utility.This utility does not process the credit or debit card numbers stored in any other storable objects; for example, /event/billing/charge/cc, /event/billing/validate/cc, and /au_payinfo/cc objects. It is recommended that you purge the old event and audit trial objects after you run this utility. See "About Purging Old Credit Card Event and Audit Trail Objects" for more information.
When you use multiple payment processors, you run this utility for each payment processor. See "Using More Than One Payment Processor" for more information.
For more information on credit card tokenization, see the following topics:
pin_cc_migrate -vendor payment_processor_name [-num number] [-account account_POID] [-start_date mm/dd/yy] [-end_date mm/dd/yy] [-verbose] [-report] [-help]
Specifies the credit card processor or automated clearing house (ACH) to use for validating credit cards and debit cards. This parameter is used to get the payment processor information from the /config/ach storable object.
For information on configuring payment processor information, see "Setting Up Merchants and Payment Processors".
Specifies the number of /payinfo/cc objects to be selected for tokenization.
Specifies the account POID. Use this parameter to replace the credit or debit card numbers with tokens for only a single account.
Specifies the start date. The start and end dates specify the time range for selecting the objects for tokenization. The pin_cc_migrate utility selects only the objects whose PIN_FLD_CREATED_T value falls between the start and end dates. Note that the start date is automatically the current date if you do not specify a value for the -start_date parameter. If a start date is specified, the entire day is included.
Specifies the end date. Note that the end date is automatically the current date if you do not specify a value for the -end_date parameter. If an end date is specified, that entire day is included, ending at, but not including, the 0th (first) second of the next day (00:00:00 a.m.).
Displays information about successful or failed processing as the utility runs.
Note:
This parameter is always used with other parameters and commands. It is not position dependent. For example, you can enter -verbose at the beginning or end of a command to initiate the verbose parameter. To redirect the output to a log file, use the following syntax with the verbose parameter. Replace filename.log with the name of the log file:pin_cc_migrate other_parameter –verbose > filename.log
Displays more information than the verbose parameter. Requires the verbose option. Returns a list of the /payinfo/cc objects for which tokenization has been completed.
Displays syntax and parameters for this utility.
Use this utility to find all unresolved credit card and direct debit payments recorded in the BRM database.
For more information about unresolved payment transactions, see "Resolving Failed BRM-Initiated Payment Transactions".
Note:
To connect to the BRM database, the pin_clean utility needs a configuration file in the directory from which you run the utility. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.Important:
For multischema systems, you must run the utility separately against each database schema in your system. See "Running Non-MTA Utilities in Multischema Systems" in BRM System Administrator's Guide.Displays the total number of each type of unresolved credit card transactions. In this example, there are three verification errors, three authorization errors, and two refund errors. For more information about these errors, see Table 14-1, "Types of Failed Credit Card Transactions".
CheckPoint Log Summary: PIN_CHARGE_CMD_VERIFY 3 PIN_CHARGE_CMD_AUTH_ONLY 3 PIN_CHARGE_CMD_CONDITION 0 PIN_CHARGE_CMD_DEPOSIT 0 PIN_CHARGE_CMD_REFUND 2
Without the summary option, the log summary is displayed and a menu if there are checkpoints to resolve.
Specifies the number of records to return.
Specifies the number of records with the auth pending status. This is only applicable to nontransactional payments.
Displays information about successful or failed processing as the utility runs.
Note:
This parameter is always used with other parameters and commands. It is not position dependent. For example, you can enter -verbose at the beginning or end of a command to initiate the verbose parameter. To redirect the output to a log file, use the following syntax with the verbose parameter. Replace filename.log with the name of the log file:pin_clean other_parameter –verbose > filename.log
Displays syntax and parameters for this utility.
Use this utility to collect the balance due for accounts that use credit card and direct debit, and SEPA payment methods.
This process does not collect against any bills that have been corrected. After a corrective bill has been finalized, BRM collects all subsequent payments against the due amount on the bill items of the corrective bill.
For corrective bills, the payment collection is triggered based on the payment collection date. You can configure the payment collection date to be the bill finalization date, the due date or a specific number of days before the due date (as with regular bills).
This utility does not any process payments against original bills after a corrective bill has been issued. It processes payments against the corrective bill depending on the configuration of the RejectPaymentsForPreviousBill business parameter. If there are multiple corrective bills, any payment against any past bill for the same period is applied to the latest corrective bill.
When you use multiple payment processors, you run this utility for each one. See "Using More Than One Payment Processor" for more information.
By default, this utility collects payments for bills whose payment collection date is on the day the utility is run and on the day before the utility is run. For example, if you run pin_collect on 01/01/06, payments are collected from 00:00:00 a.m. on 12/31/05 to 00:00:00 a.m. on 01/02/06.
To collect BRM-initiated payments for bills whose payment collection date is on a day other than the days listed above, use this utility's start and end parameters. See "Specifying Start and End Times" in BRM Configuring and Running Billing.
Note:
The payment collection date of a bill (/bill object) is stored in the /billinfo object with which the bill is associated.For more information on collecting BRM-initiated payments, see the following topics:
Configuring Payment Collection Dates for Automatic Payments
Note:
To connect to the BRM database, the pin_collect utility needs a configuration file in the directory from which you run the utility. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.pin_collect -pay_type payment_method [-vendor] payment_processor_name [-active | -close | -inactive] [-start [mm/dd/yy | number_of_days]] [-end [mm/dd/yy | number_of_days]] [-report] [-rebill] [-test] [-verbose] [-help]
Specifies the payment method. The possible values are:
10003 for credit card
10005 for direct debit
10018 for SEPA
Payment methods are defined in BRM_Home/include/pin_pymt.h.
Specifies the credit card processor or automated clearing house (ACH) to use for validating credit cards, debit cards, and direct debit transactions. This parameter is used to get the payment processor information from the /config/ach storable object.
This parameter is not applicable for SEPA payment type.
For information on configuring payment processor information, see "Setting Up Merchants and Payment Processors" for more information.
Specifies the status of the accounts to collect payments from.
Runs a test to find out how many accounts meet the criteria without performing the collection. The test has no effect on the accounts. This is most useful when run with the -verbose and -report options.
Displays information about successful or failed processing as the utility runs.
Note:
This parameter is always used with other parameters and commands. It is not position dependent. For example, you can enter -verbose at the beginning or end of a command to initiate the verbose parameter. To redirect the output to a log file, use the following syntax with the verbose parameter. Replace filename.log with the name of the log file:pin_collect other_parameter –verbose > filename.log
Displays more information than the verbose parameter. Requires the verbose option. Returns a list of the accounts being charged and the amount of each charge. This is an important verification tool when used with the -test and -verbose options: you can check the list of accounts and charges before charging them. See "Running Billing Utilities Manually" in BRM Configuring and Running Billing.
Collects any outstanding bills for a given account status. See "Running Weekly Billing" and "Running Monthly Billing" in BRM Configuring and Running Billing.
Start date. Collects payments on the day utility is run and the day before the utility is run. For information on using this parameter, see "Specifying Start and End Times" in BRM Configuring and Running Billing.
End date. For information on using this parameter, see "Specifying Start and End Times" in BRM Configuring and Running Billing.
Displays syntax and parameters for this utility.
If the pin_collect utility doesn't notify you that it was successful, look in the utility log file (default.pinlog) to find any errors. The log file is either in the directory from which the utility was started, or in a directory specified in the configuration file.
When it is called internally by the pin_bill_day script, the pin_collect utility logs error information in the pin_mta.pinlog file.
Use this utility to deposit all pre-authorized credit card and direct debit transactions made within the past 30 days (from yesterday).
When you use multiple payment processors, you run this utility for each one. See "Setting Up Merchants and Payment Processors" for more information.
Note:
To connect to the BRM database, the pin_deposit utility needs a configuration file in the directory from which you run the utility. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.See "About Collecting BRM-Initiated Payments" for more information on collecting BRM-initiated payments.
Important:
For multischema systems, you must run the utility separately against each database schema in your system. See "Running Non-MTA Utilities in Multischema Systems" in BRM System Administrator's Guide.pin_deposit -pay_type payment_method -vendor payment_processor_name [-start mm/dd/yy | number_of_days ] [-end mm/dd/yy | number_of_days ] [-test] [-verbose] [-help]
Specifies the payment method. There are two possible values:
10003 for credit card
10005 for direct debit
Payment methods are defined in BRM_Home/include/pin_pymt.h.
Specifies the credit card processor or automated clearing house (ACH) to use for validating credit cards, debit cards, and direct debit transactions. This parameter is used to get the payment processor information from the /config/ach storable object.
See "Setting Up Merchants and Payment Processors" for more information on configuring payment processor information.
Start and end date. For information on using start and end parameters, see "Specifying Start and End Times" in BRM Configuring and Running Billing.
Runs a test to find out how many accounts meet the criteria without performing the deposit. The test has no effect on the accounts.
Displays information about successful or failed processing as the utility runs.
Note:
This parameter is always used with other parameters and commands. It is not position dependent. For example, you can enter -verbose at the beginning or end of a command to initiate the verbose parameter. To redirect the output to a log file, use the following syntax with the verbose parameter. Replace filename.log with the name of the log file:pin_deposit other_parameter –verbose > filename.log
Displays syntax and parameters for this utility.
If the pin_deposit utility doesn't notify you that it was successful, look in the utility log file (default.pinlog) to find any errors. The log file is either in the directory from which the utility was started, or in a directory specified in the configuration file.
When it is called internally by the pin_bill_day script, the pin_deposit utility logs error information in the pin_billd.pinlog file.
Use this utility to resolve failed credit card and direct debit transactions.
See "Resolving Failed BRM-Initiated Payment Transactions" for more information about resolving failed credit card and direct debit transactions.
Note:
To connect to the BRM database, the pin_recover utility needs a configuration file in the directory from which you run the utility. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.Important:
For multischema systems, you must run the utility separately against each database schema in your system. See "Running Non-MTA Utilities in Multischema Systems" in BRM System Administrator's Guide.Note:
When resubmitting failed credit card and direct debit transactions, the pin_recover utility takes the billinfo's current payment type while, which must be either 10003 for credit cards or 10005 for direct debit transactions.pin_recover -pay_type payment_method -vendor payment_processor_name [-rfr | -resubmit batch_ID | -recover_payment] [-verbose] [-test] [-help]
Specifies the payment method. There are two possible values:
10003 for credit card
10005 for direct debit
Payment methods are defined in BRM_Home/include/pin_pymt.h.
Specifies the credit card processor or automated clearing house (ACH) to use for validating credit cards, debit cards, and direct debit transactions. This parameter is used to get the payment processor information from the /config/ach storable object.
See "Setting Up Merchants and Payment Processors" for more information on configuring payment processor information.
Uses the Paymentech request for response (RFR) file to retrieve and reprocess an incomplete batch. See "Resolving Transactions by Using a Request for Response (RFR) File" for more information.
Resends the original batch with the same batch ID to avoid double authorization. To find the batch ID, run the pin_clean utility. See "Resubmitting Transactions" for more information.
Note:
If you use a transaction processing service or credit card processing service other than Paymentech, ensure that it uses duplicate transaction detection. If not, using -resubmit can cause customers to be billed twice.Creates payment events for payments that have been successfully charged, but not recorded. See "Resolving Payments" for more information.
Displays information about successful or failed processing as the utility runs.
Note:
This parameter is always used with other parameters and commands. It is not position dependent. For example, you can enter -verbose at the beginning or end of a command to initiate the verbose parameter. To redirect the output to a log file, use the following syntax with the verbose parameter. Replace filename.log with the name of the log file:pin_recover other_parameter –verbose > filename.log
Runs a test to find out how many accounts meet the criteria without performing the recovery. The test has no effect on the accounts.
Displays syntax and parameters for this utility.
Use this utility to generate and process SEPA request and response files.
You use this utility to generate the following SEPA request XML files:
SEPA Direct Debit payment request files
SEPA Credit Transfer payment request files
SEPA Direct Debit reversal payment request files
You use this utility to process the following SEPA response XML files:
SEPA Direct Debit payment response files
SEPA Credit Transfer payment response files
The SEPA request and response XML files must comply with the XML schema definitions (XSD) that are provided in the BRM_Home/apps/pin_sepa/xsd directory. The pin_sepa utility cannot process an XML file that uses a different XSD.
The pin_sepa utility uses the BRM_Home/apps/pin_sepa/Infranet.properties file, which provides the configuration information that the utility requires to create and process SEPA request and response files.
For more information about configuring the Infranet.properties file, see "Configuring the pin_sepa Utility for Generating and Processing SEPA XML Files".
For more information about creating and processing SEPA request and response files, see "About SEPA Payment Processing".
To generate SEPA request XML files:
pin_sepa [-sdd_req | -sct_req | -sepa_rev] [-verbose [>filename]] [-help]
To process SEPA response XML files:
pin_sepa -sepa_resp [-verbose] [-help]
To generate SEPA request XML files and process SEPA response XML files:
pin_sepa -all [-verbose] [-help]
Generates SEPA Direct Debit request XML files.
Generates SEPA Credit Transfer request XML files.
Generates SEPA Direct Debit reversal request XML files.
Processes SEPA response XML files for SEPA Direct Debit and SEPA Credit Transfer.
Generates SEPA request XML files for SEPA Direct Debit, SEPA Credit Transfer, and SEPA Direct Debit reversal and processes SEPA response XML files for SEPA Direct Debit and SEPA Credit Transfer.
Displays information about successful or failed processing as the utility runs. filename specifies the file to redirect the output to.
Note:
This parameter is always used in conjunction with other parameters and commands.Displays the syntax and parameters for this utility.
The pin_sepa utility uses the following file naming convention for the request XML files:
typedbno-YYYYMMDD-X.xml
where:
type is SDD for SEPA Direct Debit, SCT for SEPA Credit Transfer, or SDD-REV for SEPA Direct Debit reversal.
dbno is the database number.
YYYYMMDD is the year, month, and day on which the file was generated.
X is a unique, eight-digit sequence number.
If the pin_sepa utility does not notify you that it was successful, look in the log file (javapcm.log is the default log filename) to find any errors. The log file is either in the directory from which the utility was started or in a directory specified in the Infranet.properties configuration file.