C1-CCPYTSADS

This algorithm is invoked when it is attached to the Payment Tender Staging Distribution system event of the customer class to which the account belongs. In addition, it checks whether the payment received is the first payment for the account. If the payment happens to be the first payment for the account, the payment is applied against the binder contract, which is created using the contract type specified in the payment distribution algorithm of theBinder Payment match type.

This algorithm introduces the following new parameters which are used for individual binder payment functionality:

  • Check Binder Payment For Individual - Used when you want to transfer the payment to the binder contract. The valid values are:

    • Y

    • N

  • Membership Status Reason - Used to notify the status reason of the binder payment for the membership. The valid value is:

    • Awaiting Binder Payment

  • Exchange Assigned Subscriber Number Characteristic - Used while creating payment staging characteristic.

  • Exchange Assigned Subscriber Number Id Type - Used when you want to identify the membership from the membership identifier (CI_​MEMBERSHIP_​IDENTIFIER) table.

This algorithm considers the following scenarios:

If... Then...
The Check Promise To Pay parameter is set to Y The algorithm checks whether there is an active promise to pay for the account. If an active promise to pay exists, the payment is applied against the contract which is created using the contract type specified in the payment distribution algorithm of the On Account match type.
The Check Payment Agreement Request parameter is set to Y The algorithm checks whether there is an active payment agreement request for the account. If an active payment agreement exists, the payment is applied against the contract which is created using the contract type specified in the payment distribution algorithm of the On Account match type.
The Check Promise To Pay and Check Payment Agreement Request parameters are set to N The payment is applied to the account's unpaid bills in the order of the due date. If the payment amount is greater than the sum total of the account's billed balance plus the overpayment threshold amount, the entire payment amount is applied against the excess credit contract of the account.
The payment amount is greater than the account's billed balance, but less than the sum total of the account's billed balance plus the overpayment threshold amount The payment is first applied against the unpaid bills of the account and the overpayment amount is then applied against the excess credit contract of the account.
The Check Binder Payment for Individual parameter is set to Y The algorithm retrieves the membership by using the binder payment identification value which is received in the payment characteristics from the EDI 820 file.
The Membership Status Code for Pending Effectuation attribute is set to Pending Effectuation and the Membership Status Reason Hold / Awaiting Binder Payment attribute is set toAwaiting Binder Payment in the Field Mapping screen The algorithm performs the following steps:

  1. Retrieves the Binder Contract Type attribute and its value from the Field Mapping screen.

  2. If the contract information is not found in the Binder Contract Type attribute then a new contract Id of the type Binder Contract is created on the account. If the contract information is found, the contract Id of the account is retrieved using the Binder Contract Type attribute.

  3. Creates a payment staging record using the Binder Payment Match Type soft parameter and the value as the binder contract Id of the account, retrieved using the Binder Contract Type attribute.

  4. Stores the binder payment identification value as a characteristic on the payment.
If the Membership Status Code for Pending Effectuation attribute is not Pending Effectuation and the Membership Status Reason Hold / Awaiting Binder Payment attribute is not Awaiting Binder Payment in the Field Mapping screen The algorithm performs the following steps:

  1. The payment is applied against the bill.

  2. The binder payment identification value is added as a characteristic on the payment when the payment is received from the EDI 820 file against the bill Id.

  3. The already existing soft parameters related to binder payment are removed and the binder related parameters are retrieved from the Field Mapping screen.

It contains the following parameters:

  • Check Binder Payment - Used when you want to check whether the payment is the first payment for the account and the tender used for the payment is not an automatic payment. The valid values are:

    • Y

    • N

  • Check Promise To Pay - Used when you want to check whether there is an active promise to pay for the account. The valid values are:

    • Y

    • N

  • Check Payment Agreement Request - Used when you want to check whether there is an active payment agreement request for the account. The valid values are:

    • Y

    • N

  • Overpayment Threshold Amount - Used to specify the overpayment threshold amount.

  • Bill Match Type - Used to specify the match type using which you want to apply the payment against the unpaid bills of the account.

  • Binder Payment Match Type - Used to specify the match type using which you want to apply the first non-automatic payment against the contract of the account.

  • On Account Match Type - Used to specify the match type using which you want to apply the payment against the contract of the account.

  • Payment Review Reason Characteristic Type - Used to specify the characteristic type which you want to use to store the payment reason.

  • Payment Review Reason for Active Promise To Pay - Used to specify the characteristic value that must be specified when there is an active promise to pay for the account.

  • Payment Review Reason for Active Payment Agreement Request - Used to specify the characteristic value that must be specified when there is an active payment agreement request for the account.

  • Payment Review Reason for Overpayment - Used to specify the characteristic value that must be specified when the payment amount is greater than the sum total of account's billed balance plus overpayment threshold amount.

  • Excess Credit Contract Type - Used to specify the contract type using which the excess credit contract should be created if it does not exist for the account.