Update Consumer

put

https://cfi.quest-global.com/consumer/v1.0/register

Payer Institute's app developer can make use this API in 2 cases:

Bill Pay Accelerator stores app's notification-token associated with a Push Notification Service to deliver Push Notification messages to the app. Bill Pay Accelerator stores app's notification-token associated with a Push Notification Service to deliver Push Notification messages to the app. In case the notification-token is renewed by Push Notification Service provider, Payer Institute's app developer makes use of this API to notify Bill Pay Accelerator regarding the updated notification-token.

Whenever the consumer status changes from active to closed for example, this API can be used to notify the same to Bill Pay Accelerator.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

consumer details with notification token are passed here.

Consumer update request with consumer details.

consumerNumber

string

required

length between 10 and 28

Unique PI consumer number, BPX platform will require consumer number to communicate subsequent messages

notificationToken

string

required

Consumer’s app RNSID notification ID , BillpayConnectAPI will use this ID to send push notification on consumer device when Bill is presented. When it’s not provided then PI will have to integrate it’s push notification service, BillPayConnect provides Gateway Interface which can be used by PI to code and integrate with existing push notification service

status

string

enum

required

Consumer status must be one of active | closed. One can not update closed consumer status to active.

Allowed:

Headers

pi-x-customer-id

string

required

length between 36 and 36

Customer id of PI on-boarded in customer profile service. This header should be added by API consumer, mobile app in this case.

Responses

200ok

400Bad request

401Unauthorized

404Not found