Retrieve Account Balance Details based on the provided parameters
Service URL: GET /accountbalances
Query Parameters:
*accountId | Account Id |
*accountType | Type of the account CustomerLoyaltyAccount, CustomerDepositAccount, CustomerCreditAccount, EmployeeAccount, etc. |
pan | Card Number |
hashedPan | Hashed Card Number |
currencyId | Currency Id |
Response Body: IAccountBalanceEnquiryOutput
| Key | Type | Description |
|---|
| Key | Type | Description |
|---|---|---|
| account | IAccount | Account corresponding to the provided accountType |
| accountDescription | String | Description of the account |
| customer | ICustomer | Corresponding Customer |
| outcome | IApplicationProcessOutcome | Outcome of the executed processSuccess – successfully executedFail – failed to execute the processNoAccount – No Account for the provided detailsUnknownAccountType – Provided accountType is an unknown type |
| customerCard | ICustomerCard | Corresponding CustomerCard |
| customerGroups | List<IGroupKey> | List of Groups relevant to the customer |
| messages | List<IMessage> | List of Messages |
| dynamicPromotions | List<IPromotionKey> | List of Dynamic Promotions |
| customerLoyaltyAccountTotal | ICustomerLoyaltyAccountTotal | Correspoinding CustomerLoyaltyAccountTotal |
Example Request:
Example Response:
{
"outcome": {
"name": "Success"
},
"account": {
"@type": "customerLoyaltyAccount",
"loyaltySchemeId": {
"id": "LOYALTY_UK"
},
"tierCode": "UK3",
"manualTierReview": false,
"accountId": "1",
"accountType": "customerLoyaltyAccount",
"accountOpenedDate": 1397516400000,
"status": "ACTIVE",
"customerNumber": "1",
"currencyId": {
"id": "EUR"
}
},
"customer": {
"addresses": [
{
"@type": "address",
"countryCodeId": {},
"isPreferred": true,
"organisation": "Enactor",
"isActive": false,
"typeId": {},
"county": "Hertfordshire",
"postCode": "SG141PB",
"street1": "1 Enactor House",
"street2": "Bluecoats Avenue",
"town": "Hertford",
"isTemplate": false,
"lastUpdated": 1624434389000,
"addressReferenceId": "c637-:19f34d5d541:4780d454:e6018e477d3b5ada"
}
],
"contactable": false,
"dateCreated": 1397580687000,
"noChildren": 0,
"customerNumber": "1",
"emailAddresses": [
{
"emailAddress": "demo@enactor.co.uk",
"lastUpdated": 1624434389000,
"preferred": true,
"typeId": {},
"active": true
}
],
"phoneNumbers": [
{
"lastUpdated": 1624434389000,
"number": "01295768256",
"preferred": true,
"typeId": {},
"active": true,
"phoneNumberReferenceId": "b637-:19f34d5d541:4780d454:e6018e477d3b5ada"
},
{
"lastUpdated": 1624434389000,
"number": "01992546873",
"preferred": false,
"typeId": {},
"active": true,
"phoneNumberReferenceId": "a637-:19f34d5d541:4780d454:e6018e477d3b5ada"
},
{
"lastUpdated": 1624434389000,
"number": "07595288030",
"preferred": false,
"typeId": {},
"active": true,
"phoneNumberReferenceId": "9637-:19f34d5d541:4780d454:e6018e477d3b5ada"
}
],
"customerName": {
"surname": "Harrison",
"forename": "Mark",
"initials": "N",
"title": "Mr",
"sex": "MALE",
"dateOfBirth": 304626600000
},
"allowInternalMarketing": true,
"allowExternalMarketing": true,
"privacyLevel": 25,
"employeeKey": {},
"lastUpdated": 1624434389000,
"customerType": {},
"createdBy": {},
"createdAt": {}
},
"accountBalance": {
"accountId": "1",
"accountType": "customerLoyaltyAccount"
},
"customerGroup": [
{
"groupTypeId": "customerGroup",
"groupHierarchyId": "CUSTOMER",
"variantGroupTypeId": "region",
"variantGroupId": "All",
"variantGroupHierarchyId": "All",
"id": "00"
},
{
"groupTypeId": "customerGroup",
"groupHierarchyId": "CUSTOMER",
"variantGroupTypeId": "region",
"variantGroupId": "All",
"variantGroupHierarchyId": "All",
"id": "VIP"
}
],
"dynamicPromotions": [
{
"promotionId": "TEST",
"groupKey": {}
}
],
"messages": [
{
"messageBase": "Pos/Birthday/BirthdayMessages",
"messageId": "CUSTOMER_BIRTHDAY"
}
]
}