cisco-cvp-ux

(0 reviews)

Update BillingAccountById - TMF666 PUT

This operation enables / disables autopay.

Request

URL

http://[host]:[port]/cisco-cvp-ux/v1/{businessId}/billingAccount/{id}

Common Parameters

Base URI parameters and headers are common to all the resources as part of account management Biz API, listed below with details.

Base URI Parameter

Name	Type	M/O	Description
businessId	string	M	businessId is a Business unit identifier. Example: JM, BS, PR

Headers

name	value	description	required
X-Correlation-ID	String	This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers. Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b	M
lob	String	Enum: PREPAID, POSTPAID,FIXED Mobile users: PREPAID, POSTPAID Fixed users : FIXED	M
channelId	String	Channel to identify the business group. Eg:ivrB2C	O

Security Headers

Name	Type	M/O	Description
client_id	string	M	Client Id value for Client Id Enforcement policy. Environment Specific Value. Eg: 6f0ed16a7b494d76b2d60e05bc3b3332
client_secret	string	M	Client secret value for Client Id Enforcement policy. Environment Specific Value, eg: e4CD4D43449846aA9D8Cb9c43fAd324a

URI Param

name	type	description	required
id	string	a mandatory UriParam (accountNumber)	Y

Request Body

{
    "defaultPaymentMethod": {
        "@referredType": "AutoPay",
        "id": "PM-a6I63000000DZmrEAG"
    },
    "extendedCharacteristic": [{
        "value": "IVR",
        "name": "sourceSystem"
    }
    ],
    "relatedParty": [{
        "id": "1",
        "@type": "13332123212"
    }]
}

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

TMF Response for BillingAccountById

PR Success Response [ 200 ]

{
    "status": 200,
    "description": "Autopay change request received"
}