The PBT wrapper module.

Members

inner contact :Contact

inner customer :Customer

inner customer_account :CustomerAccount

inner days_before_due :String

The number of days before the payment due date on which the payment alert is to be sent to the enrolled customer to the contact phone provided here.

inner enrollment_status :String

The status of the payment enrolment.

inner funding_account :FundingAccount

inner payment_amount_type :String

The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.

Methods

forClient(client_key) → {module:wrappers/PBT}

Parameters:
Name Type Description
client_key String

The client_key of PBT.

Returns:
module:wrappers/PBT -

The instance of PBT.

forCustomer(customer) → {module:wrappers/PBT}

Parameters:
Name Type Description
customer Customer

The customer of PBT.

Returns:
module:wrappers/PBT -

The instance of PBT.

fromAccount(funding_account) → {module:wrappers/PBT}

Parameters:
Name Type Description
funding_account FundingAccount

The funding_account of PBT.

Returns:
module:wrappers/PBT -

The instance of PBT.

toAccount(customer_account) → {module:wrappers/PBT}

Parameters:
Name Type Description
customer_account CustomerAccount

The customer_account of PBT.

Returns:
module:wrappers/PBT -

The instance of PBT.

videChannel(channel) → {module:wrappers/PBT}

Parameters:
Name Type Description
channel String

The channel of PBT.

Returns:
module:wrappers/PBT -

The instance of PBT.

withContact(contact) → {module:wrappers/PBT}

Parameters:
Name Type Description
contact Contact

The contact of PBT.

Returns:
module:wrappers/PBT -

The instance of PBT.

withDaysBeforeDue(days_before_due) → {module:wrappers/PBT}

Parameters:
Name Type Description
days_before_due String

The days_before_due of PBT.

Returns:
module:wrappers/PBT -

The instance of PBT.

withEnrollmentStatus(enrollment_status) → {module:wrappers/PBT}

Parameters:
Name Type Description
enrollment_status String

The enrollment_status of PBT.

Returns:
module:wrappers/PBT -

The instance of PBT.

withPaymentAmountType(payment_amount_type) → {module:wrappers/PBT}

Parameters:
Name Type Description
payment_amount_type String

The payment_amount_type of PBT.

Returns:
module:wrappers/PBT -

The instance of PBT.