How can it be determined if an online user is enrolled in Bill Pay? If they are, how can they be unenrolled?

Question

A feature that is being built for a new SDK extension requires the functionality for our members to unenroll themselves from Bill Pay. To do this, we need to determine if a user is enrolled in Bill Pay and then unenroll them if they are enrolled.

The documentation has two pages that look like they could fit the bill for what we need:
GetBillPayData - https://docs.q2developer.com/_modules/q2_sdk/hq/hq_api/q2_api/GetBillPayData.html#ParamsObj

CancelBillPay - https://docs.q2developer.com/api_references/hq_api/q2_api/CancelBillPay.html?highlight=billpay#module-q2_sdk.hq.hq_api.q2_api.CancelBillPay

The issue that we are having is that it is not well defined exactly what these API calls do and what parameters are needed. For instance, GetBillPayData has a parameter for "password", but it is never defined what this password is supposed to be or how we can obtain it. Similarily, the export type is not defined in the CancelBillPay API parameters.

Are these APIs the correct things to use for determining if a person is enrolled in Bill Pay and then removing them from Bill Pay? If not, what are the alternatives? Some explanation of the parameters will be useful.

Thank you,
Ethan

		
				0
				
Posted 
	2 years ago

					⠿More
				  		
			 Report
		
					Ethan Pittman
				
					39
 × 2

Chase Dorsey · Answer

The recommended way to tell whether a user is enrolled in Bill Pay would be to check the isEnrolled flag that comes in with billpay capabilities on the UUX platform. Here's a code example for how you would request that object through Tecton.

await this.tectonSDK.sources
  .requestPlatformData({
    route: `mobilews/refreshCapabilities`,
    method: "GET",
  })
  .then((response) => {
    this.billPayRights = response.response.data.isBillpayEnrolled;
    this.userId = response.response.data.userId;
    this.tectonSDK.setUserId(this.userId);
    return response.response.data.isBillpayEnrolled;
  });

As for unenrollment, the process for that is going to depend heavily on the Bill Pay vendor you're using. The endpoints you referenced do not support all vendors. I looked up the vendor for your FI (avoiding sharing any potentially sensitive information through this channel), and it does not appear that we currently have an endpoint implemented for programmatically unenrolling a user. This could potentially be implemented in the future. Creating a ticket through the dev portal with the details of what you're looking for would help get the ball rolling on that.

		
				0
				
Posted 
	2 years ago

					⠿More
				  		
			 Report
		
					Chase Dorsey
				
					5
					Administrator

0

@<1607492208481538048|Chase Dorsey> For this method of viewing if a person is enrolled in Bill Pay, does this only work in Production or will this also work in Staging? If it does work in Staging, will the URL change for the route?

— Ethan Pittman 2 years ago

Answers