dxp-ux
Retrieve Account Details(TMF-666)
/billingAccount/{id}
[GET]
This operation retrieves a billing account entity used by billingAccountNumber or msisdn or client account id or BAN-CAN.
Key considerations for DC markets.
Account status will be derived using the offers linked to account. if any of the Suspended offers are present in account, then the account state would be considered as "Suspended". Below are the offers list.
| OFFER_ID | DISPLAY_VALUE |
|---|---|
| 51002454 | CUR Wireline Barring |
| 51006038 | CUR Wireless Barring |
| 51006040 | CUR Wireless CHCO Barring |
| 51006047 | SXM Wireless Barring |
| 51006143 | CUR Data Connectivity Barring |
| 51007682 | CUR Wireless CHCO Barring up to 10 Members |
| 51007683 | CUR Wireless CHCO Barring 11 to 50 Members |
| 51007688 | BES Wireless CHCO Barring up to 10 Members |
| 51009190 | CUR Wireless Disconnection Fees for Collections |
| 51009192 | BES Wireless Disconnection Fees for Collections |
| 51009694 | SXM Wireless Disconnection Fees for Collections |
| 51009695 | FSXM Wireless Disconnection Fees for Collections |
| 51010077 | CUR Disconnection Fees for Collections |
| 51010078 | BES Wireline Disconnection Fees for Collections |
| 51010079 | SXM Wireline Disconnection Fees for Collections |
| 51010080 | FSXM Wireline Disconnection Fees for Collections |
URL
https://[localhost]:[port]/dxp-ux/v1/{businessId}/billingAccount/{id}URL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico | Y |
| id | string | To retrieve 'account' information provide Billing Account Number or msisdn To retrieve 'balance' information provide account number. Example: msisdn: 17874047209,billingAccountNumber: 33541396-33542750 | Y |
Header
Note:
1.To retrieve 'balance' information need to pass 'targetSystem'.
2.To retrieve 'account' information need to pass 'lob'.
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request | N It is Mandatory for business |
| channelId | string | Expected value APP | Y |
| lob | String | Enum: PREPAID, POSTPAID,FIXED Expected value : PREPAID, POSTPAID | Y |
| targetSystem | String | Expected value "aria". | Y |
Query Parameters
Note:
- To retrieve 'account' information need to pass 'extendedCharacteristics.name', 'extendedCharacteristics.value', 'type'.
| name | value | description | required |
|---|---|---|---|
| extendedCharacteristics.name | string | Expected value is sourceSystem | Y |
| extendedCharacteristics.value | string | Expected value is Digital | Y |
| type | string | Need to pass 'billingAccountNumber' or 'msisdn' | Y |
[GET] Retrieve Balance Response - CSG FIXED
From this operation we can fetch Auto Pay is enabled or disabled, auto-pay date and day, Delinquency status, payment status and payment method EFT or Card.
Note In the response if PaymentPlan.planType is AutoPay Enable, AutoPay Date can be displayed in the extended Characteristics else AutoPay Date cannot be displayed.
AutoPay Date Enable
{
"id": "8211990010018869",
"accountType": "RES",
"description": "MARIA VICTORIA MURILLO",
"lastModified": "2023-01-16T00:00:00.000Z",
"name": "MARIA VICTORIA MURILLO",
"paymentStatus": "",
"state": "NORMAL",
"accountBalance": [
{
"amount": {
"unit": "USD",
"value": -76.98
},
"balanceType": "ReceivableBalance",
"validFor": {
"startDateTime": "2023-01-16T00:00:00.000Z",
"endDateTime": "2023-02-15T00:00:00.000Z"
}
},
{
"amount": {
"unit": "USD",
"value": 80.00
},
"balanceType": "LastPaymentAmount",
"validFor": {
"endDateTime": "2022-12-26T00:00:00.000Z"
}
}
],
"accountRelationship": [
{
"relationshipType": "contains",
"account": {
"id": "8211990010018869",
"description": "RES MARIA VICTORIA MURILLO",
"name": "MARIA VICTORIA MURILLO",
"@type": "BillingAccount"
},
"validFor": {
"startDateTime": "2021-01-16T00:00:00.000Z",
"endDateTime": "2021-02-14T00:00:00.000Z"
}
}
],
"billStructure": {
"cycleSpecification": {
"name": "monthly Billing",
"dateShift": 16,
"frequency": "monthly"
},
"presentationMedia": [
{
"name": "Mail"
}
]
},
"contact": [
{
"contactName": "MARIA VICTORIA MURILLO",
"contactType": "Primary",
"partyRoleType": "Owner",
"contactMedium": [
{
"mediumType": "PostalAddress",
"preferred": true,
"ulmCharacteristic": {
"city": "SAN JUAN",
"country": "USA",
"postCode": "009171920",
"street1": "279 AVE PONCE DE LEON APT 2001"
},
"characteristic": {
"city": "SAN JUAN",
"country": "USA",
"postCode": "00917",
"street1": "279 AVE PONCE DE LEON APT 2001"
}
},
{
"mediumType": "Phone",
"characteristic": {
"contactType": "Home",
"phoneNumber": "7876552030"
}
},
{
"mediumType": "Phone",
"characteristic": {
"contactType": "Business",
"phoneNumber": "9059334010"
}
}
],
"relatedParty": {
"id": "6789",
"name": "MARIA VICTORIA MURILLO",
"role": "Owner",
"@type": "relatedParty"
}
}
],
"creditLimit": {
"unit": "USD",
"value": 100.00
},
"defaultPaymentMethod": {
"id": "E",
"name": "EFT"
},
"financialAccount": {
"id": "2063",
"accountBalance": {
"balanceType": "ReceivableBalance",
"amount": {
"unit": "USD",
"value": 16
},
"validFor": {
"startDateTime": "2023-01-16T00:00:00.000Z",
"endDateTime": "2023-02-15T00:00:00.000Z"
}
},
"@referredType": "financialAccount"
},
"paymentPlan": [
{
"paymentFrequency": "01",
"planType": "Auto Pay Enable"
}
],
"characteristic": [
{
"name": "DunningGroup",
"value": "090"
},
{
"name": "autoPayDate",
"value": "2023-02-03T00:00:00.000Z"
},
{
"name": "DebitDay",
"value": "03"
},
{
"name": "CreditScore",
"value": "A"
},
{
"name": "LocationId",
"value": "00917192001084"
}
],
"relatedParty": [
{
"id": "1101521721766",
"name": "MARIA VICTORIA MURILLO",
"role": "Customer",
"@referredType": "Customer"
}
],
"@type": "BillingAccount"
}AutoPay Disable
{
"id": "8211990010018869",
"accountType": "RES",
"description": "MARIA VICTORIA MURILLO",
"lastModified": "2023-01-16T00:00:00.000Z",
"name": "MARIA VICTORIA MURILLO",
"paymentStatus": "",
"state": "NORMAL",
"accountBalance": [
{
"amount": {
"unit": "USD",
"value": -76.98
},
"balanceType": "ReceivableBalance",
"validFor": {
"startDateTime": "2023-01-16T00:00:00.000Z",
"endDateTime": "2023-02-15T00:00:00.000Z"
}
},
{
"amount": {
"unit": "USD",
"value": 80.00
},
"balanceType": "LastPaymentAmount",
"validFor": {
"endDateTime": "2022-12-26T00:00:00.000Z"
}
}
],
"accountRelationship": [
{
"relationshipType": "contains",
"account": {
"id": "8211990010018869",
"description": "RES MARIA VICTORIA MURILLO",
"name": "MARIA VICTORIA MURILLO",
"@type": "BillingAccount"
},
"validFor": {
"startDateTime": "2021-01-16T00:00:00.000Z",
"endDateTime": "2021-02-14T00:00:00.000Z"
}
}
],
"billStructure": {
"cycleSpecification": {
"name": "monthly Billing",
"dateShift": 16,
"frequency": "monthly"
},
"presentationMedia": [
{
"name": "Mail"
}
]
},
"contact": [
{
"contactName": "MARIA VICTORIA MURILLO",
"contactType": "Primary",
"partyRoleType": "Owner",
"contactMedium": [
{
"mediumType": "PostalAddress",
"preferred": true,
"characteristic": {
"city": "SAN JUAN",
"country": "USA",
"postCode": "009171920",
"street1": "279 AVE PONCE DE LEON APT 2001"
}
},
{
"mediumType": "Phone",
"characteristic": {
"contactType": "Home",
"phoneNumber": "7876552030"
}
}
],
"relatedParty": {
"id": "6789",
"name": "MARIA VICTORIA MURILLO",
"role": "Owner",
"@type": "relatedParty"
}
}
],
"creditLimit": {
"unit": "USD",
"value": 100.00
},
"defaultPaymentMethod": {
"id": "E",
"name": "EFT"
},
"financialAccount": {
"id": "2063",
"accountBalance": {
"balanceType": "ReceivableBalance",
"amount": {
"unit": "USD",
"value": 16
},
"validFor": {
"startDateTime": "2023-01-16T00:00:00.000Z",
"endDateTime": "2023-02-15T00:00:00.000Z"
}
},
"@referredType": "financialAccount"
},
"paymentPlan": [
{
"paymentFrequency": "01",
}
],
"characteristic": [
{
"name": "DunningGroup",
"value": "090"
},
{
"name": "CreditScore",
"value": "A"
},
{
"name": "LocationId",
"value": "00917192001084"
}
],
"relatedParty": [
{
"id": "1101521721766",
"name": "MARIA VICTORIA MURILLO",
"role": "Customer",
"@referredType": "Customer"
}
],
"@type": "BillingAccount"
}Response Data Model:
Each of the response parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| id | string | Billing Account Number (Salesforce Record Id) | N |
| accountType | string | A categorization of an account, Possible Value - RES | N |
| description | string | name of the account owner | N |
| name | string | name of the billing account | N |
| state | string | Contains the lifecycle state such as: "voluntary disconnect", "Non-Pay Disc", "Chard Off", "NORMAL" | N |
| paymentStatus | string | The account's delinquency status or payment status may have the following values:, Possible Delinquency status values are NORMAL, C - VOLUNTARY DISC, E - NON-PAY DISC, A - OPEN NP EQPTACT, F - OPEN NP EQPT FT, P - PEND NP SVC RES,S - PND CHG SERV WO, T - PPV RESTRICTED, U - DWNGRD-SVCS, V - OPEN VOL DISC, W - OPEN NP EQPTDIS, Z -CHARGED OFF, OR payment status are "NORMAL","S" : Suspend, "B" : Balance is less than EFT minimum debit amount. The API will return a single character, such as "C" or "NORMAL," as obtained from CSG. The meaning of each character is given here for reference. | N |
| lastModified | string | Date of last modification of the account | N |
| accountBalance | array | Balances linked to the account | N |
| accountBalance.balanceType | string | Type of the balance ; DelinquentBalance, LastPaymentAmount, ReceivableBalance | N |
| accountBalance.amount | string | Balance amount | N |
| accountBalance.amount.unit | string | USD | N |
| accountBalance.validFor | object | A period, either as a deadline (endDateTime only) a startDateTime only, or both | N |
| accountBalance.validFor.endDateTime | datetime | End of the time period, using ISO 8601 format | N |
| accountBalance.validFor.startDateTime | datetime | Start of the period, using ISO 8601 format. If you define a start, you must also define an end | N |
| accountRelationship | array | Significant connection between accounts. For instance an aggregating account for a list of shop branches each having its billing account | N |
| accountRelationship.relationshipType | string | Type of relationship. | N |
| accountRelationship.account | object | An account may be a party account or a financial account. | N |
| accountRelationship.account.id | string | Unique identifier Id of the EntityDescriptionRef. | N |
| accountRelationship.account.description | string | Detailed description of the EntityDescriptionRef | N |
| accountRelationship.account.name | string | Name of the account. | N |
| accountRelationship.account.@type | string | When sub-classing, this defines the sub-class entity name | N |
| accountRelationship.validFor.endDateTime | datetime | End of the time period, using ISO 8601 format | N |
| accountRelationship.validFor.startDateTime | datetime | Start of the period, using ISO 8601 format. If you define a start, you must also define an end | N |
| billStructure | object | The structure of the bill for party accounts (billing or settlement). | N |
| billStructure.cycleSpecification | object | An attachment by value or by reference. | N |
| billStructure.cycleSpecification.name | string | Expected value "monthly Billing" "bi-monthly billing" | N |
| billStructure.cycleSpecification.dateShift | string | An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period. | N |
| billStructure.cycleSpecification.frequency | string | Possible values are "monthly" or "bi-monthly billing". | N |
| billStructure.presentationMedia.name | string | Possible values are "Mail" | N |
| contact | array | Contact point for a given account and accessed via some contact medium. | N |
| contact.name | string | name of the contact | N |
| contact.partyRoleType | string | Identifies what kind of party role type is linked to the contact Ex: Owner | N |
| contact.contactMedium | array | Indicates the contact medium that could be used to contact the party. Possible values are | N |
| contact.contactMedium.mediumType | string | Type of the contact medium, possible values are: "Phone" or "PostalAddress". | N |
| contact.contactMedium.preferred | boolean | If true, it indicates that it is the preferred contact medium. Ex: true,false | N |
| contact.contactMedium.characteristic | object | Any additional characteristic(s) of this contact medium. | N |
| contact.contactMedium.characteristic.contactType | string | if mediumType = "Phone" then possible values are "Home", "Business" | N |
| contact.contactMedium.characteristic.city | string | The city | N |
| contact.contactMedium. characteristic.country | string | The country | N |
| contact.contactMedium. characteristic.postCode | string | Postcode | N |
| contact.contactMedium. characteristic.stateOrProvince | string | State or province | N |
| contact.contactMedium. characteristic.street1 | string | Describes the street | N |
| contact.contactMedium. characteristic.phoneNumber | string | phone number of the customer | N |
| contact.contactMedium. characteristic.emailAddress | string | email address of the customer | N |
| contact.relatedParty | object | Related Entity reference | N |
| contact.relatedParty.id | string | last 4 digits of SSN number | N |
| contact.relatedParty.name | string | name of the customer account | N |
| contact.relatedParty.@type | string | hard-coded as "relatedParty" | N |
| creditLimit | object | The maximum amount of money that may be charged to an account | N |
| creditLimit.unit | string | USD | N |
| creditLimit.value | integer | value | N |
| defaultPaymentMethod | object | The maximum amount of money that may be charged on an account | N |
| defaultPaymentMethod.id | string | Unique identifier ID of the default payment method. Possible values are "C" "E" "" | N |
| defaultPaymentMethod.name | integer | Payment Method Name.Possible values are "Credit Card" "EFT" "Non Default Payment Method" | N |
| financialAccount | array | AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An account receivable aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party. | N |
| financialAccount.id | string | Hard coded as "2063" | N |
| financialAccount.accountBalance | object | ||
| financialAccount.accountBalance.balanceType | string | Type of the balance ; DelinquentBalance, LastPaymentAmount, ReceivableBalance | N |
| financialAccount.accountBalance.amount | string | Balance amount | N |
| financialAccount.accountBalance.amount.unit | string | USD | N |
| financialAccount.accountBalance.validFor | object | A period, either as a deadline (endDateTime only) a startDateTime only, or both | N |
| financialAccount.accountBalance.validFor.endDateTime | datetime | End of the time period, using ISO 8601 format | N |
| financialAccount.accountBalance.validFor.startDateTime | datetime | start of the time period | N |
| financialAccount.@referredType | string | possible value is "financialAccount" | N |
| paymentPlan | array | A list of payment plans | N |
| paymentPlan.paymentFrequency | string | Frequency of the payments, such as monthly and bimonthly | N |
| paymentPlan.planType | string | status of autopsy. possible values are "Auto Pay Enable" , "Auto Pay Disable | N |
| characteristic | array | Describes a given characteristic of an object or entity through a name/value pair. | N |
| characteristics.name | string | Name of the characteristic. "LocationId" "DunningGroup" "DelinquencyDays" "autoPayDate "DebitDay" "CreditScore" | N |
| characteristics.value | string | Value of the characteristic | N |
| relatedParty | array | Related Entity reference | N |
| relatedParty.id | string | CSG Customer Id | N |
| relatedParty.name | string | Customer name | N |
| relatedParty.role | string | role of the party. "customer" | N |
| relatedParty.@referredType | string | Reference type. "customer" | N |
| @type | string | Type of the reference. "BillingAccount" | N |
[ 200 ] PREPAID Salesforce
Retrieving account details and autopay status for a PREPAID account from Salesforce using billingAccountNumber:
Below is the response:
{
"id": "31515070-31513558",
"href": "https://cwc--propeac01.sandbox.my.salesforce.com/0016300001MwDHbAAN",
"ratingType": "Prepaid",
"name": "Connection Fee Prepaid",
"state": "Active",
"contact": [
{
"contactType": "BillingAddress",
"contactMedium": [
{
"preferred": true,
"characteristic": {
"city": "San Juan",
"country": "US",
"postCode": "00921",
"stateOrProvince": "PR",
"street1": "767 Calle 31 S O",
"emailAddress": "mobileconnectionfee@gmail.com"
}
}
]
},
{
"contactType": "customerAccount",
"contactMedium": [
{
"preferred": true,
"characteristic": {
"city": "San Juan",
"country": "US",
"postCode": "00921",
"stateOrProvince": "PR",
"street1": "767 Calle 31 S O"
}
}
],
"relatedParty": {
"id": "0016300001MwDHaAAN",
"name": "Connection Fee Prepaid",
"@type": "CustomerAccountRef"
}
},
{
"name": "Connection Fee Prepaid",
"contactType": "Primary",
"contactMedium": [
{
"preferred": true,
"characteristic": {
"phoneNumber": "3765786457",
"emailAddress": "mobileconnectionfee@gmail.com"
}
}
]
}
],
"paymentPlan": [
{
"planType": "Auto Pay disabled",
"paymentMethod": {
"id": "a6I63000000DV0xEAG"
},
"extendedCharacteristic": [
{
"name": "methodType",
"value": "BrainTreeToken"
},
{
"name": "externalCustomerIdentifier",
"value": "639338417"
},
{
"name": "token",
"value": "cGF5bWVudG1ldGhvZF9jY19hOWFxemd0aA"
},
{
"name": "externalPaymentMethodIdentifier",
"value": "2"
},
{
"name": "isPrimary",
"value": "Y"
}
]
}
],
"billStructure": {
"presentationMedia": [
{
"name": "eBill disabled"
}
]
},
"extendedCharacteristics": [
{
"name": "msisdn",
"valueType": "array",
"value": [
"12112221058"
]
}
],
"@type": "BillingAccount",
"relatedParty": [
{
"id": "0016300001MwDHbAAN",
"@type": "SalesforceBillingAccountRef"
}
]
}Response Data Model:
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| id | string | Billing Account Number (Salesforce Record Id) | N |
| href | string | URL reference of the billing account in Salesforce | N |
| ratingType | string | payment type of the billing account and the options are: Prepaid Postpaid | N |
| name | string | name of the billing account | N |
| state | string | Status of the account: Active Suspend Disconnected | N |
| autopayEnabled | string | indicator of the Auto Pay enabled | N |
| extendedCharacteristics | array | A list of characteristics that characterize this billingAccount | N |
| extendedCharacteristics.name | string | Name of the characteristic Example: methodType,token,externalPaymentMethodIdentifier | N |
| extendedCharacteristics.value | string | The value of the characteristic Example: BrainTreeToken,639338417,2 | N |
| contact | array | Contact point for a given account and accessed via some contact medium. | N |
| contact.partyRoleType | string | Identifies what kind of party role type is linked to the contact Ex:Owner | N |
| contact.contactMedium | array | Indicates the contact medium that could be used to contact the party. | N |
| contact.contactMedium.preferred | boolean | If true, indicates that is the preferred contact medium. Ex: true,false | N |
| contact.contactMedium.characteristic | object | Any additional characteristic(s) of this contact medium. | N |
| contact.contactMedium.characteristic.city | string | The city | N |
| contact.contactMedium. characteristic.country | string | The country | N |
| contact.contactMedium. characteristic.postCode | string | Postcode | N |
| contact.contactMedium. characteristic.stateOrProvince | string | State or province | N |
| contact.contactMedium. characteristic.street1 | string | Describes the street | N |
| contact.contactMedium. characteristic.phoneNumber | string | phone number of the customer | N |
| contact.contactMedium. characteristic.emailAddress | string | email address of the customer | N |
| contact.relatedParty | object | Related Entity reference | N |
| contact.relatedParty.id | string | Customer Account Number (Salesforce Record Id) | N |
| contact.relatedParty.name | string | name of the Customer account | N |
| contact.relatedParty.@type | string | type of reference | N |
| contact.name | string | name of the contact | N |
| paymentPlan | array | A list of payment plans | N |
| paymentPlan.planType | string | status of autopay | N |
| paymentPlan.paymentMethod | object | A payment method reference | N |
| paymentPlan.paymentMethod.id | string | internal reference id of the payment method in Salesforce | N |
| paymentPlan.extendedCharacteristics | array | A list of characteristics that characterize the payment method details | N |
| paymentPlan.extendedCharacteristics.name | string | Name of the characteristic | N |
| paymentPlan.extendedCharacteristics.value | string | Value of the characteristic | N |
| @type | string | Type of the reference | N |
| relatedParty | array | Related Entity reference | N |
| relatedParty.id | string | Salesforce reference Id of the billing account | N |
| relatedParty.@type | string | Referencetype | N |
| relatedParty.id | string | consumerPIN value | N |
| relatedParty.role | string | role of the party | N |
| relatedParty.@type | string | Reference type | N |
Retrieving account details for a PREPAID account from Salesforce using MSISDN:
Below is the response:
{
"contact": [
{
"name": "GUILHERME CLEVELAND",
"contactType": "Secondary",
"contactMedium": [
{
"preferred": true,
"characteristic": {
"city": "San Juan",
"country": "Colombia",
"postCode": "00907",
"stateOrProvince": "PR",
"street1": "1479 Ashford Avenue",
"phoneNumber": "+55 24 2104 8708",
"emailAddress": "guilherme.cleveland@orange.com"
}
}
]
}
],
"billStructure": {
"presentationMedia": [
{
"name": "eBill disabled"
}
]
},
"@type": "BillingAccount",
"relatedParty": [
{
"@type": "SalesforceBillingAccountRef"
}
]
}Response Data Model:
| name | type | description | required |
|---|---|---|---|
| contact | array | Contact point for a given account and accessed via some contact medium. | N |
| contact.contactType | string | Indicates the type of contact | N |
| contact.contactMedium | array | Indicates the contact medium that could be used to contact the party. | N |
| contact.contactMedium.preferred | boolean | If true, indicates that is the preferred contact medium. | N |
| contact.contactMedium.characteristic | object | Any additional characteristic(s) of this contact medium. | N |
| contact.contactMedium.characteristic.city | string | The city | N |
| contact.contactMedium. characteristic.country | string | The country | N |
| contact.contactMedium. characteristic.postCode | string | Postcode | N |
| contact.contactMedium. characteristic.stateOrProvince | string | State or province | N |
| contact.contactMedium. characteristic.street1 | string | Describes the street | N |
| contact.contactMedium. characteristic.phoneNumber | string | phone number of the customer | N |
| contact.contactMedium. characteristic.emailAddress | string | email address of the customer | N |
| contact.name | string | name of the contact | N |
| @type | string | Type of the reference | N |
| relatedParty | array | Related Entity reference | N |
| relatedParty.id | string | Salesforce reference Id of the billing account | N |
| relatedParty.@type | string | Referencetype | N |
| billStructure | Object | N | |
| billStructure.presentationMedia | Array | N | |
| billStructure.presentationMedia.name | String | ebill flag indicator | N |
[ 200 ] POSTPAID Salesforce
Retrieving account details and autopay status for a POSTPAID account from Salesforce using billingAccountNumber:
Below is the response:
{
"id": "21003695-21003694",
"href": "https://cwc--propeac01.sandbox.my.salesforce.com/0016300001MhqRXAAZ",
"ratingType": "Postpaid",
"name": "Prakash Prakash",
"state": "Active",
"contact": [
{
"contactType": "BillingAddress",
"contactMedium": [
{
"preferred": true,
"characteristic": {
"city": "San Juan",
"country": "US",
"postCode": "00907",
"stateOrProvince": "PR",
"street1": "1479 Ashford Avenue",
"emailAddress": "pra@com.com"
}
}
]
},
{
"contactType": "customerAccount",
"contactMedium": [
{
"preferred": true,
"characteristic": {
"city": "San Juan",
"country": "US",
"postCode": "00907",
"stateOrProvince": "PR",
"street1": "1479 Ashford Avenue"
}
}
],
"relatedParty": {
"id": "0016300001MhqRWAAZ",
"name": "Prakash Prakash",
"@type": "CustomerAccountRef"
}
},
{
"name": "Prakash Prakash",
"contactType": "Primary",
"contactMedium": [
{
"preferred": true,
"characteristic": {
"phoneNumber": "7655454545",
"emailAddress": "pra@com.com"
}
}
]
}
],
"paymentPlan": [
{
"planType": "Auto Pay enabled",
"paymentMethod": {
"id": "a6I63000000DTq7EAG"
},
"extendedCharacteristic": [
{
"name": "methodType",
"value": "BrainTreeToken"
},
{
"name": "externalCustomerIdentifier",
"value": "163429995"
},
{
"name": "token",
"value": "cGF5bWVudG1ldGhvZF9jY18yZ3NjZ2Zzeg"
},
{
"name": "isPrimary",
"value": "Y"
}
]
}
],
"billStructure": {
"presentationMedia": [
{
"name": "eBill disabled"
}
]
},
"extendedCharacteristics": [
{
"name": "msisdn",
"valueType": "array",
"value": [
"17874031934"
]
}
],
"@type": "BillingAccount",
"relatedParty": [
{
"id": "0016300001MhqRXAAZ",
"@type": "SalesforceBillingAccountRef"
}
]
}Response Data Model:
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| id | string | Billing Account Number (Salesforce Record Id) | N |
| href | string | URL reference of the billing account in Salesforce | N |
| ratingType | string | payment type of the billing account and the options are: Prepaid Postpaid | N |
| name | string | name of the billing account | N |
| state | string | Status of the account: Active Suspend Disconnected | N |
| autopayEnabled | string | indicator of the Auto Pay enabled | N |
| extendedCharacteristics | array | A list of characteristics that characterize this billingAccount | N |
| extendedCharacteristics.name | string | Name of the characteristic | N |
| extendedCharacteristics.value | string | The value of the characteristic | N |
| contact | array | Contact point for a given account and accessed via some contact medium. | N |
| contact.partyRoleType | string | Identifies what kind of party role type is linked to the contact | N |
| contact.contactMedium | array | Indicates the contact medium that could be used to contact the party. | N |
| contact.contactMedium.preferred | boolean | If true, indicates that is the preferred contact medium. | N |
| contact.contactMedium.characteristic | object | Any additional characteristic(s) of this contact medium. | N |
| contact.contactMedium.characteristic.city | string | The city | N |
| contact.contactMedium. characteristic.country | string | The country | N |
| contact.contactMedium. characteristic.postCode | string | Postcode | N |
| contact.contactMedium. characteristic.stateOrProvince | string | State or province | N |
| contact.contactMedium. characteristic.street1 | string | Describes the street | N |
| contact.contactMedium. characteristic.phoneNumber | string | phone number of the customer | N |
| contact.contactMedium. characteristic.emailAddress | string | email address of the customer | N |
| contact.relatedParty | object | Related Entity reference | N |
| contact.relatedParty.id | string | Customer Account Number (Salesforce Record Id) | N |
| contact.relatedParty.name | string | name of the Customer account | N |
| contact.relatedParty.@type | string | type of reference | N |
| contact.name | string | name of the contact | N |
| paymentPlan | array | A list of payment plans | N |
| paymentPlan.planType | string | status of autopay | N |
| paymentPlan.paymentMethod | object | A payment method reference | N |
| paymentPlan.paymentMethod.id | string | internal reference id of the payment method in Salesforce | N |
| paymentPlan.extendedCharacteristics | array | A list of characteristics that characterize the payment method details | N |
| paymentPlan.extendedCharacteristics.name | string | Name of the characteristic | N |
| paymentPlan.extendedCharacteristics.value | string | Value of the characteristic | N |
| @type | string | Type of the reference | N |
| relatedParty | array | Related Entity reference | N |
| relatedParty.id | string | Salesforce reference Id of the billing account | N |
| relatedParty.@type | string | Referencetype | N |
| relatedParty.id | string | consumerPIN value | N |
| relatedParty.role | string | role of the party | N |
| relatedParty.@type | string | Reference type | N |
Retrieving account details and autopay status for a POSTPAID account from Salesforce using MSISDN:
Below is the response:
{
"href": "https://cwc--qapeac.sandbox.my.salesforce.com/0013K000012fb7dQAA",
"ratingType": "Postpaid",
"name": "Hilda C. Alvarez",
"state": "Active",
"characteristic": [
{
"value": "Y",
"name": "autoPaymentEnabled"
}
],
"contact": [
{
"contactType": "BillingAddress",
"contactMedium": [
{
"preferred": true,
"characteristic": {
"city": "San Juan",
"country": "US",
"postCode": "00911",
"stateOrProvince": "PR",
"street1": "110 Calle del Parque",
"emailAddress": "testconsentaddline5@care.com"
}
}
]
},
{
"contactType": "customerAccount",
"contactMedium": [
{
"preferred": true,
"characteristic": {
"city": "San Juan",
"country": "US",
"postCode": "00911",
"stateOrProvince": "PR",
"street1": "110 Calle del Parque"
}
}
],
"relatedParty": {
"id": "23540074",
"name": "Hilda C. Alvarez",
"@type": "CustomerAccountRef"
}
},
{
"name": "Hilda Alvarez",
"contactType": "Primary",
"contactMedium": [
{
"preferred": true,
"characteristic": {
"phoneNumber": "13453454364",
"emailAddress": "testconsentaddline5@care.com"
}
}
]
}
],
"paymentPlan": [
{
"paymentMethod": {
"id": "PM-a6I3K0000009JgzUAE"
},
"extendedCharacteristic": [
{
"name": "methodType",
"value": "BrainTreeToken"
},
{
"name": "externalCustomerIdentifier",
"value": "19553474953"
},
{
"name": "token",
"value": "cGF5bWVudG1ldGhvZF9jY184amYzaDVneA"
},
{
"name": "externalPaymentMethodIdentifier",
"value": "PM-a6I3K0000009JgzUAE"
},
{
"name": "isPrimary",
"value": "Y"
}
]
},
{
"paymentMethod": {
"id": "PM-MWJkZmQ4ZDUtYjRlNS"
},
"extendedCharacteristic": [
{
"name": "methodType",
"value": "BrainTreeToken"
},
{
"name": "externalCustomerIdentifier",
"value": "88822287153"
},
{
"name": "token",
"value": "cGF5bWVudG1ldGhvZF9jY19xOXpleWd0cg"
},
{
"name": "externalPaymentMethodIdentifier",
"value": "PM-MWJkZmQ4ZDUtYjRlNS"
},
{
"name": "isPrimary",
"value": "N"
}
]
},
{
"paymentMethod": {
"id": "PM-a6I3K0000009JiMUAU"
},
"extendedCharacteristic": [
{
"name": "methodType",
"value": "Bank Account"
},
{
"name": "externalCustomerIdentifier",
"value": "89213959036"
},
{
"name": "token",
"value": "cGF5bWVudG1ldGhvZF91c2JfajBzcDJqOWg"
},
{
"name": "externalPaymentMethodIdentifier",
"value": "PM-a6I3K0000009JiMUAU"
},
{
"name": "isPrimary",
"value": "N"
}
]
}
],
"billStructure": {
"presentationMedia": [
{
"name": "eBill disabled"
}
]
},
"extendedCharacteristics": [
{
"name": "msisdn",
"valueType": "array",
"value": [
"12218000634",
"12218000752"
]
}
],
"@type": "BillingAccount",
"relatedParty": [
{
"id": "0013K000012fb7dQAA",
"@type": "SalesforceBillingAccountRef"
},
{
"id": "1234",
"role": "CustomerSecurity",
"@type": "ConsumerPIN"
}
]
}Response Data Model:
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| href | string | URL reference of the billing account in Salesforce | N |
| ratingType | string | payment type of the billing account and the options are: Prepaid Postpaid | N |
| name | string | name of the billing account | N |
| state | string | Status of the account: Active Suspend Disconnected | N |
| autopayEnabled | string | indicator of the Auto Pay enabled | N |
| extendedCharacteristics | array | A list of characteristics that characterize this billingAccount | N |
| extendedCharacteristics.name | string | Name of the characteristic | N |
| extendedCharacteristics.value | string | The value of the characteristic | N |
| contact | array | Contact point for a given account and accessed via some contact medium. | N |
| contact.partyRoleType | string | Identifies what kind of party role type is linked to the contact | N |
| contact.contactMedium | array | Indicates the contact medium that could be used to contact the party. | N |
| contact.contactMedium.preferred | boolean | If true, indicates that is the preferred contact medium. | N |
| contact.contactMedium.characteristic | object | Any additional characteristic(s) of this contact medium. | N |
| contact.contactMedium.characteristic.city | string | The city | N |
| contact.contactMedium. characteristic.country | string | The country | N |
| contact.contactMedium. characteristic.postCode | string | Postcode | N |
| contact.contactMedium. characteristic.stateOrProvince | string | State or province | N |
| contact.contactMedium. characteristic.street1 | string | Describes the street | N |
| contact.contactMedium. characteristic.phoneNumber | string | phone number of the customer | N |
| contact.contactMedium. characteristic.emailAddress | string | email address of the customer | N |
| contact.relatedParty | object | Related Entity reference | N |
| contact.relatedParty.id | string | Customer Account Number (Salesforce Record Id) | N |
| contact.relatedParty.name | string | name of the Customer account | N |
| contact.relatedParty.@type | string | type of reference | N |
| contact.name | string | name of the contact | N |
| paymentPlan | array | A list of payment plans | N |
| paymentPlan.paymentMethod | object | A payment method reference | N |
| paymentPlan.paymentMethod.id | string | internal reference id of the payment method in Salesforce | N |
| paymentPlan.extendedCharacteristics | array | A list of characteristics that characterize the payment method details | N |
| paymentPlan.extendedCharacteristics.name | string | Name of the characteristic | N |
| paymentPlan.extendedCharacteristics.value | string | Value of the characteristic | N |
| @type | string | Type of the reference | N |
| relatedParty | array | Related Entity reference | N |
| relatedParty.id | string | Salesforce reference Id of the billing account | N |
| relatedParty.@type | string | Referencetype | N |
| relatedParty.id | string | consumerPIN value | N |
| relatedParty.role | string | role of the party | N |
| relatedParty.@type | string | Reference type | N |
[ 200 ] ARIA Retrieve Balance Response
Retrieve the client account balance from Aria:
Below is the response:
{
"@type": "BillingAccount",
"relatedParty": [
{
"id": "123456-MA",
"@type": "MigratedAccountRef",
"name": "BAN"
}
],
"accountBalance": [
{
"amount": {
"unit": "USD",
"value": 0
}
}
],
"billStructure": {
"cycleSpecification": {
"paymentDueDateOffset": 0
}
},
"extendedCharacteristics": [
{
"name": "billDate",
"value": "2023-03-10"
},
{
"name": "autoPayDate",
"value": "2023-03-10"
}
]
}Response data model:
| name | type | description | required |
|---|---|---|---|
| @type | string | When sub-classing, this defines the sub-class entity name and value refers to "BillingAccount" | Y |
| accountBalance | object Array | Balances linked to the account | Y |
| accountBalance.amount | object | Balance amount | Y |
| accountBalance.amount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | Y |
| accountBalance.amount.value | number, float | A positive floating point number | Y |
| relatedParty | Array | Related Entity reference | Y |
| relatedParty.id | string | Aria reference Id of the billing account | Y |
| relatedParty.@type | string | Referencetype | Y |
| relatedParty.name | string | relatedParty Name | Y |
| billStructure | Object | Y | |
| billStructure.cycleSpecification | object | Y | |
| billStructure.cycleSpecification.paymentDueDateOffset | number | number of days between bill date and current date | Y |
| extendedCharacteristics | array | extendedCharacteristics. Example: billDate, autoPayDate | Y |
| extendedCharacteristics.value | string | name of the characteristics | Y |
| extendedCharacteristics.name | string | value of the characteristics | Y |
Possible Error Scenarios: :
IF WE ARE PASSING INVALID MSISDN IN URIPARAMS
{
"errors": [
{
"code": 400,
"message": "SF:GET_BillingAccount_BY_ID",
"description": "MSISDN provided is not valid"
}
]
}INVALID URL
{
"errors": [
{
"code": 404,
"message": "APIKIT:NOT_FOUND",
"description": "/PR/billingAccounts/CUSTOMER_8011"
}
]
}INVALID CHANNELID
{
"errors": [
{
"code": 501,
"message": "Not implemented",
"description": "Operation GET for Business Id: PR and channelId:ECOM not implemented"
}
]
}Expected values for CSG FIXED Auto Pay
For paymentStatus below are expected fields Delinquency Status or Payment Status
Delinquency Status
| Mule Field Value | BSS Field Value | Description |
|---|---|---|
| NORMAL | “” or null | NORMAL |
| C | C | VOLUNTARY DISC |
| E | E | NON-PAY DISC |
| A | A | OPEN NP EQPTACT |
| F | F | OPEN NP EQPT FT |
| P | P | PEND NP SVC RES |
| S | S | PND CHG SERV WO |
| T | T | PPV RESTRICTED |
| U | U | DWNGRD-SVCS |
| V | V | OPEN VOL DISC |
| W | W | OPEN NP EQPTDIS |
| Z | Z | CHARGED OFF |
Payment Status
| Mule Field Value | BSS Field Value | Description |
|---|---|---|
| NORMAL | “” or null | NORMAL |
| S | S | Suspended |
| B | B | Balance is less than EFT minimum debit amount |
| D | D | Debit Error |
| E | E | Prenote Error |
| G | G | EFT debit had been sent to ACH processor |
| P | P | Prenote Error |
| W | W | Waiting |