Register Consumer

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

Payer Institute's app developer makes use of this API to register consumer with Bill Pay Accelerator and optionally notification-token associated with a Push Notification Service provider can be passed. Bill Pay Accelerator stores app's notification-token associated with a Push Notification Service to deliver Push Notification messages to the app.

Body Params

consumer details are passed here.

consumerNumber

string

required

length between 10 and 28

Unique PI consumer number, BPX platform will required consumer ID communicate subsequent messages

notificationToken

string

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

Consumer status must be one of active | closed. Default value is active.

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

Language

Credentials


xxxxxxxxxx
1
curl --request POST \
2
     --url https://cfi.quest-global.com/consumer/v1.0/register \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200ok

400Bad request

401Unauthorized