25 Payment Utilities
Learn about the Oracle Communications Billing and Revenue Management (BRM) payment utilities.
Topics in this document:
load_pin_ach
Use this utility to load the merchant account information for all credit card processor and automated clearing house (ACH) vendors into the BRM database. See "Setting Up Merchant Accounts".
Location
BRM_home/bin
Syntax
load_pin_ach [-d][-v][-t] pin_ach_file
Parameters
Results
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.
pin_balance_transfer
Use this utility to perform automatic sponsored top-ups or recurring standard top-ups.
For information about automatic sponsored top-ups, see "About Sponsored Top-Ups".
Location
BRM_home/bin
Syntax
pin_balance_transfer [-test] [-start mm/dd/yy] [-end mm/dd/yy] [-standard] [-verbose [file_name.log]]
Parameters
- -test
-
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 mm/dd/yy or yyyy
-
Specifies to perform top-ups scheduled on or after the specified start date.
- -end mm/dd/yy or yyyy
-
Specifies to perform top-ups scheduled on or before the specified end date.
- -standard
-
Performs standard recurring top-ups. See "About Standard Top-Ups".
The -start and -end parameters cannot be used with the -standard parameter.
- -verbose
-
Displays information as the utility runs.
Results
This utility notifies you only if it encounters errors. Look in the default.pinlog file for errors. This file is either in the directory from which the utility was started or in a directory specified in the utility configuration file.
pin_cc_migrate
Use this utility to replace credit or debit card numbers stored in /payinfo/cc objects with tokens. See "Replacing Credit Card Numbers with Tokens".
Note:
-
Ensure that the outstanding payments for credit card accounts are closed before running this utility.
-
The utility does not tokenize PINless debit card numbers.
Location
BRM_home/bin
Syntax
pin_cc_migrate -vendor payment_processor_name [-num number] [-account account_POID] [-start_date mm/dd/yy] [-end_date mm/dd/yy] [-verbose [file_name.log]] [-report] [-help]
Parameters
- -vendor payment_processor_name
-
Specifies the credit card processor or ACH to use for validating credit and debit cards.
See "Setting Up Merchant Accounts".
- -num number
-
Specifies the number of /payinfo/cc objects to select for tokenization.
- -account account_POID
-
Specifies the account POID. Use this parameter to replace credit or debit card numbers with tokens for a single account.
- -start_date mm/dd/yy
-
Specifies the start date. The start and end dates specify the time range for selecting objects for tokenization. If you do not specify a value for the -start_date parameter, the start date is set to the current date. If a start date is specified, the entire day is included.
- -end_date mm/dd/yy
-
Specifies the end date. If you do not specify a value for the -end_date parameter, the end date is set to the current date. If an end date is specified, the entire day is included, ending exclusively on the first second of the next day (00:00:00 a.m.).
- -verbose file_name.log
-
Displays information about successful or failed processing as the utility runs.
- -report
-
Returns a list of the /payinfo/cc objects for which tokenization has been completed. This parameter must be used with the -verbose parameter.
- -help
-
Displays syntax and parameters for this utility.
Results
If the pin_cc_migrate utility does not notify you that it was successful, look in the utility log file (default.pinlog) to find any errors.
pin_clean
Use this utility to find unresolved credit card and direct debit payments. See "Resolving Failed BRM-Initiated Payment Transactions".
Location
BRM_home/bin
Syntax
pin_clean [-summary] [-search_count_limit n] [-auth_pending] [-schema schema_number]
[-verbose] [file_name.log] [-help] Parameters
- -summary
-
Displays the total number of each type of unresolved credit card transaction.
Without the summary option, the log summary is displayed and a menu if there are checkpoints to resolve.
- -search_count_limit n
-
Specifies the number of records to return.
- -auth_pending
-
Specifies the number of records with the auth pending status.
- -schema schema_number
-
Specifies the schema on which to run the utility on multischema BRM systems: 1 specifies the primary schema, 2 specifies the second schema, and so on. By default, the utility runs on all schemas.
- -verbose
-
Displays information about successful or failed processing as the utility runs.
- -help
-
Displays syntax and parameters for this utility.
Results
If the pin_clean 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.
pin_collect
Use this utility to collect the balance due for accounts that use credit card and direct debit payment methods. See "Running the pin_collect Utility to Collect BRM-Initiated Payments".
Location
BRM_home/bin
Syntax
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[file_name.log]] [-help]
Parameters
- -pay_type payment_method
-
Specifies the payment method:
-
10003 for credit card
-
10005 for direct debit
-
10018 for SEPA
-
- -vendor payment_processor_name
-
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 not applicable for SEPA payment type.
- -active |- close | -inactive
-
Specifies the status of the accounts to collect payments from.
- -test
-
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.
- -verbose [file_name.log]
-
Displays information about successful or failed processing as the utility runs.
- -report
-
Displays more information than the verbose parameter. Requires the verbose option.
- -rebill
-
Collects any outstanding bills for a given account status.
- -start [mm/dd/yy or yyyy | number_of_days]
-
Start date. Collects payments on the day utility is run and the day before the utility is run.
If a start date is specified, the entire day is included. The end date is automatically the current date if you do not specify a value for the -end parameter.
- -end [mm/dd/yy or yyyy | number_of_days]
-
End date.
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.). The end date cannot be a future date.
- -help
-
Displays syntax and parameters for this utility.
Results
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 by the pin_bill_day script, the pin_collect utility logs error information in the pin_mta.pinlog file.
pin_deposit
Use this utility to deposit pre-authorized credit card transactions and PINless debit transactions made within the past 30 days (from yesterday).
When you use multiple payment processors, you run this utility for each one. See "Using More Than One Payment Processor" for more information.
Location
BRM_home/bin
Syntax
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[file_name.log]] [-help]
Parameters
- -pay_type payment_method
-
Specifies the payment method. There are two possible values:
-
10003 for credit card
-
10005 for direct debit
-
- -vendor payment_processor_name
-
Specifies the credit card processor or automated clearing house (ACH) to use for validating credit cards, debit cards, and direct debit transactions.
See "Setting Up Merchant Accounts" for more information on configuring payment processor information.
- -start [mm/dd/yy or yyyy | number_of_days]
- -end [mm/dd/yy or yyyy | number_of_days]
-
Start and end date.
If a start date is specified, the entire day is included. The end date is automatically the current date if you do not specify a value for the -end 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.). The end date cannot be a future date.
- -test
-
Runs a test to find out how many accounts meet the criteria without performing the deposit. The test has no effect on the accounts.
- -verbose
-
Displays information about successful or failed processing as the utility runs.
- -help
-
Displays syntax and parameters for this utility.
Results
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 by the pin_bill_day script, the pin_deposit utility logs error information in the pin_billd.pinlog file.
pin_installment_notifications
Note:
This utility is supported in BRM 12.0 Patch Set 5 only. In Patch Set 6 and later, use the pin_gen_notifications utility. See "pin_gen_notifications" in BRM Managing Customers.
Use this utility to trigger notifications for installments. This utility searches for installments whose end date or due date is in the next few days and then triggers either the /event/notification/installment/due or /event/notification/installment/end notification event.
It supports the due date and end date reminder notifications.
For more information, see "Sending Installment Reminders (Patch Set 5)".
Location
BRM_home/bin
Syntax
pin_installments_notifications [-verbose] [-due_date | -end_date] [-help]
Parameters
- -due_date
-
The parameter to run the utility for the installment due date notifications.
Note:
The utility considers the current date as the due date.
Results
If the pin_installment_notifications utility does not notify you that it was successful, look in the utility log file (pin_installment_notifications.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.
pin_installment_status_change
Use this utility to update a customer’s installment schedule status. This utility searches for installments with a due date on or before the current date and the installment schedule status Charged. When it finds an installment that meets the criteria, the utility changes the installment schedule status to one of the following:
-
Broken: If the installment amount is not paid by the specified due date or if only a part of the installment amount is paid, this utility changes the installment schedule status to Broken.
-
Canceled: If the customer decides to cancel an installment schedule, this utility is used to change the installment schedule status to Canceled. When this happens, any remaining installments are canceled, and any remaining installment amount gets reflected in the next bill.
Location
BRM_home/bin
Syntax
pin_installment_status_change [-verbose] [-test] [-help]
Parameters
Results
If the pin_installments_status_change utility does not notify you that it was successful, look in the utility log file (pin_installments_status_change.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.
pin_installments
Use this utility to apply the installment charges to the customer’s bills. This utility searches for installment schedules with an effective date on or before the current date and the installment status as Open. When it finds an installment that meets the criteria, the utility applies the installment charges to the customer’s bill and changes the installment’s status to Charged.
Note:
To connect to the BRM database, this utility needs a configuration (pin.conf) file in the directory from which it is being run. For information about creating configuration files for BRM utilities, see "Connecting BRM Utilities" in BRM System Administrator's Guide.
Location
BRM_home/bin
Syntax
pin_installments [-help] [-verbose] [-test]
Parameters
Results
If the pin_installments utility does not notify you that it was successful, look in the utility log file (pin_installments.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.
pin_recover
Use this utility to resolve failed credit card and direct debit transactions. See "Resolving Failed BRM-Initiated Payment Transactions" for more information.
Location
BRM_home/bin
Syntax
pin_recover -pay_type payment_method -vendor payment_processor_name
[-schema schema_number] [-rfr | -resubmit batch_ID | -recover_payment]
[-verbose [file_name.log]] [-test] [-help]Parameters
- -pay_type payment_method
-
Specifies the payment method. There are two possible values:
-
10003 for credit card
-
10005 for direct debit
-
- -vendor payment_processor_name
-
Specifies the credit card processor or automated clearing house (ACH) to use for validating credit cards, debit cards, and direct debit transactions.
See "Setting Up Merchant Accounts" for more information on configuring payment processor information.
- -schema schema_number
-
Specifies the schema on which to run the utility in multischema BRM systems: 1 specifies the primary schema, 2 specifies the second schema, 3 specifies the third schema, and so on. By default, the utility runs on all schemas.
- -rfr
-
Uses the Paymentech request for response (RFR) file to retrieve and reprocess an incomplete batch. See "Resolving Failed Deposits and Conditional Deposits" for more information.
- -resubmit batch_ID
-
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.
- -recover_payment
-
Creates payment events for payments that have been successfully charged, but not recorded. See "Resolving Payments" for more information.
- -verbose
-
Displays information about successful or failed processing as the utility runs.
- -test
-
Runs a test to find out how many accounts meet the criteria without performing the recovery. The test has no effect on the accounts.
- -help
-
Displays syntax and parameters for this utility.
Results
If the pin_recover 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.
pin_sepa
Use this utility to generate and process SEPA request and response files.
See "Implementing SEPA Payment Processing".
Location
BRM_home/apps/pin_sepa
Syntax
To generate SEPA request XML files:
pin_sepa [-sdd_req | -sct_req | -sepa_rev] [-verbose [file_name.log]] [-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]
Parameters
- -sdd_req
-
Generates SEPA Direct Debit request XML files.
- -sct_req
-
Generates SEPA Credit Transfer request XML files.
- -sepa_rev
-
Generates SEPA Direct Debit reversal request XML files.
- -sepa_resp
-
Processes SEPA response XML files for SEPA Direct Debit and SEPA Credit Transfer.
- -all
-
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.
- -verbose [>filename]
-
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.
- -help
-
Displays the syntax and parameters for this utility.
Results
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.