Home > Tech Writers Hub > Knowledge Services Sandbox > Aria Media Publishing Suite > Interface and Integration Definitions for Account Management

Interface and Integration Definitions for Account Management

Overview

This document describes the API methods used for Account Management when integrating with the Aria Media and Publishing Suite - AMPS. The Account Management component of AMPS is a set of generic components that are designed for use within both standard AMPS implementations and customer-specific workflows. This document describes the Account Management functionality to manage accounts, and associated objects like billing groups and payment methods. 

Account Management

The following details the definition of the APIs provided by the Account Management component of AMPS. The following APIs are provided:

Each of the above APIs are described below

Search Account (JSON API)

Endpoint

This API can be called by making a POST call to the URL: 
https://[clienthost]/PostDataToFlow/ARIAMediaSuite/AccountManagement/AcctSearchAccount

AcctSearchAccountRequest

The AcctSearchAccountRequest message is a JSON formatted message used by the calling system to look for accounts that fulfill a set of criteria. The criteria are provided in the request and it is possible to provide several criteria at the same time. Criteria not used are left blank. To limit the number of accounts returned, the caller can provide a maximum number of records to return. Below several examples are given, namely:

  • Sample 1); Searching for customers having a specific email address.
  • Sample 2); Searching for customers having a specific telephone number.
  • Sample 3); Searching for customers having a last name of "Hansen" living in postal code "0444". 
  • Sample 4); Searching for customers having Postal Code as "QWDZPM" either in Delivery or Account Address.

Sample 1
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctSearchAccountCriteria": {
        "ariaAccountID": "",
        "ariaAccountNo": null,
        "userID": "",
        "phoneNumber": "",
        "emailAddress": "myemail@mydomain.com",
        "migratedCustomerID": null,
         "ariaPINo":0,
        "ariaPIID ": 0,
        "ariaInvoiceNo": 0,
        "ariaStatementNo":0,
        "ariaSeqStatementNo ": 0,
        "custInvoiceRef ": 0
    },
    "acctSearchAccountContactCriteria": {
        "firstName": "",
        "middleInitials": "",
        "lastName": "",
        "fullName": "",
        "addressLine1": "",
        "addressLine2": "",
        "addressLine3": "",
        "countryCode": "",
        "postalCode": "",
        "postalCity": "",
        "addrLocality": "",
        "addrStateProv": "",
        "streetName": "",
        "streetNo": "",
        "flatNo": "",
        "flatSpec": "",
        "flatFloor": "",
        "entranceNo": "",
        "homePhone": "",
        "cellPhone": "",
        "workPhone": "",
        "emailAddress": ""
    },
    "acctSearchAccountSpecDetails": {
        "returnLimitRows": 1
    }
}
 

Sample 2

{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctSearchAccountCriteria": {
        "ariaAccountID": "",
        "ariaAccountNo": null,
        "userID": "",
        "phoneNumber": "+4721212121",
        "emailAddress": "",
        "migratedCustomerID": null,
         "ariaPINo":0,
        "ariaPIID ": 0,
        "ariaInvoiceNo": 0,
        "ariaStatementNo":0,
        "ariaSeqStatementNo ": 0,
        "custInvoiceRef ": 0

    },
    "acctSearchAccountContactCriteria": {
        "firstName": "",
        "middleInitials": "",
        "lastName": "",
        "fullName": "",
        "addressLine1": "",
        "addressLine2": "",
        "addressLine3": "",
        "countryCode": "",
        "postalCode": "",
        "postalCity": "",
        "addrLocality": "",
        "addrStateProv": "",
        "streetName": "",
        "streetNo": "",
        "flatNo": "",
        "flatSpec": "",
        "flatFloor": "",
        "entranceNo": "",
        "homePhone": "",
        "cellPhone": "",
        "workPhone": "",
        "emailAddress": ""
    },
    "acctSearchAccountSpecDetails": {
        "returnLimitRows": 1
    }
}

Sample 3

{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctSearchAccountCriteria": {
        "ariaAccountID": "",
        "ariaAccountNo": null,
        "userID": "",
        "phoneNumber": "",
        "emailAddress": "",
        "migratedCustomerID": null,
         "ariaPINo":0,
        "ariaPIID ": 0,
        "ariaInvoiceNo": 0,
        "ariaStatementNo":0,
        "ariaSeqStatementNo ": 0,
        "custInvoiceRef ": 0

    },
    "acctSearchAccountContactCriteria": {
        "firstName": "",
        "middleInitials": "",
        "lastName": "Hansen",
        "fullName": "",
        "addressLine1": "",
        "addressLine2": "",
        "addressLine3": "",
        "countryCode": "",
        "postalCode": "0444",
        "postalCity": "",
        "addrLocality": "",
        "addrStateProv": "",
        "streetName": "",
        "streetNo": "",
        "flatNo": "",
        "flatSpec": "",
        "flatFloor": "",
        "entranceNo": "",
        "homePhone": "",
        "cellPhone": "",
        "workPhone": "",
        "emailAddress": ""
    },
    "acctSearchAccountSpecDetails": {
        "returnLimitRows": 1
    }
}
 

Sample 4
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctSearchAccountCriteria": {
        "ariaAccountID": "",
        "ariaAccountNo": null,
        "userID": "",
        "phoneNumber": "",
        "emailAddress": "",
        "migratedCustomerID": null,
         "ariaPINo":0,
        "ariaPIID ": 0,
        "ariaInvoiceNo": 0,
        "ariaStatementNo":0,
        "ariaSeqStatementNo ": 0,
        "custInvoiceRef ": 0
    },
    "acctSearchAccountContactCriteria": {
        "firstName": "",
        "middleInitials": "",
        "lastName": "",
        "fullName": "",
        "addressLine1": "",
        "addressLine2": "",
        "addressLine3": "",
        "countryCode": "",
        "postalCode": "",
        "postalCity": "",
        "addrLocality": "",
        "addrStateProv": "",
        "streetName": "",
        "streetNo": "",
        "flatNo": "",
        "flatSpec": "",
        "flatFloor": "",
        "entranceNo": "",
        "homePhone": "",
        "cellPhone": "",
        "workPhone": "",
        "emailAddress": ""
    },
    "acctSearchAccountSpecDetails": {
        "returnLimitRows": 1
    }
  "acctSearchAccountAddressCriteria": {
    "searchFirstName ": "",
    "searchLastName ": "",
    "searchFullName ": "",
    "searchStreetName ": "",
    "searchStreetNo ": -,
    "searchPostalCode ": "QWDZPM",
    "searchCity ": "",
    "searchCountryCode ": ""
  }
}
 

The individual data elements of msgAuthDetails are defined as follows:

  • clientNo - contains the Aria specific identification of the instance in which the solution currently operates. Varies from test to production. This value is required in all API calls to Aria to authenticate the caller. 
  • authKey - contains the Aria specified authentication key. This key is required in all API calls to Aria to authenticate the caller.  
  • requestDateTime - contains the date and time when the message was built. 
  • signatureValue - contains the signature value calculated by the sending solution. Using the private key the receiving solution will validate the information retrieved, and if no match is found, the call will fail. 
  • ariaAccountID - contains the defined identification of the customer account, for example a number from a CRM system or other customer master.  Used for the signature value calculation.
  • ariaAccountNo - contains the Aria generated identification of the account. Will always be zero as the account has not been created yet. 

The individual data elements of acctSearchAccountCriteria are defined as follows:

  • ariaAccountID – the search is performed on the defined identification of the customer account, for example the AID ID.
  • ariaAccountNo – the search is performed on the Aria generated identification of the customer account. If used only a single account will be returned. 
  • userID – the search is performed on the defined user identification, if used. 
  • phoneNumber – the search is performed on a phone number registered for the customers. Any of the account owner, statement or billing contacts may be used. 
  • emailAddress – the search is performed on an email address registered for the customers. Any of the account owner, statement or billing email addresses may be used. 
  • migratedCustomerID – the search is performed on the supplemental field "MigratedCustomerID" found on the account. 
  • ariaPINo - attribute allows caller to search on Aria Plan instance numbers. Plan instance numbers can be a reference to a master plan instance or a supplemental plan instance.
  • ariaPIID - attribute allows caller to search on Aria Plan Instance ID. The plan instance ID is defined either by the solution or by the client and may reference a master plan instance or supplemental plan instance.
  • ariaInvoiceNo - attribute allows caller to search on the Aria generated invoice number. The account where the invoice is defined will be returned.
  • ariaStatementNo – attribute allow caller to search on the ARIA generated statement number. The accounts where a match is found will be returned. 
  • ariaSeqStatementNo – attribute allow caller to search on the ARIA generated sequential statement number. This number is generated automatically based on client configuration. 
  • custInvoiceRef – attribute allow caller to search for the customer invoice reference number, i.e. KID number or similar and return the account associated with that invoice. 
     

The individual data elements of acctSearchAccountContactCriteria are defined as follows:

  • firstName – the search is performed on the first name of the customer. 
  • middleInitials - the search is performed the middle initials of the customer.
  • lastName - the search is performed the last name (given name) of the customer. 
  • fullName - the search is performed the full name of the customer or it contains the company name of the customer. 
  • addressLine1 - the search is performed the first line of the customer’s address. 
  • addressLine2 - the search is performed the second line of the customer’s address. 
  • addressLine3 - the search is performed the third line of the customer’s address. 
  • postalCode - the search is performed the postal code of the customer’s address. 
  • postalCity - the search is performed the postal city of the customer’s address. 
  • addrLocality – the search is performed the locality of the current address.
  • addrStateProv – the search is performed the code identifying the state or province.
  • streetName – the search is performed only the name of the street. Numbers, floors, etc. are not included. 
  • streetNo – the search is performed only the street number and no other part of the address.
  • flatNo –  the search is performed the number of the flat.
  • flatSpec – the search is performed the specification of the flat, for example left, right, center, etc. 
  • flatFloor – the search is performed the floor where the flat is found.
  • entranceNo – the search is performed the number of the entrance to the flat.
  • homePhone - the search is performed the home phone number of the customer. 
  • cellPhone - the search is performed the cell phone number of the customer. 
  • workPhone - the search is performed the work phone number of the customer. 
  • emailAddress - the search is performed the email address associated with the customer. 

The individual data elements of acctSearchAccountSpecDetails are defined as follows:

  • returnLimitRows – specifies the maximum number of rows that will be returned by the search. If not provided, the value defaults to 1. If more rows that fulfill the search criteria exist, then this is indicated in the result code. 
     

The Individual data elements of acctSearchAccountAddressCriteria are defined as follows:

  • searchFirstName – the first name of the customer to be searched for. When using the first name only ARIA account address will be searched. "Like" will be used for the search.
  • searchLastName – the last name of the customer to be searched for. When using the last name only ARIA account address will be searched. "Like" will be used for the search.
  • searchFullName – the full name of the ARIA account or any registered delivery addresses having a "Like" match will be returned. 
  • searchStreetName – the street name of the ARIA account (address lines 1, 2, 3 or 4) and any registered delivery addresses having a like match will be returned. 
  • searchStreetNo – the street number of the ARIA account (address lines 1,2,3 or 4) and any registered delivery addresses having the specified street number will be returned. Should only be used if searchStreetName is present. 
  • searchPostalCode – the search is done on the postal code registered for an ARIA account or any of the delivery addresses. An exact match is required. 
  • searchCity – the search is done on the city registered for an ARIA account or any of the delivery addresses. A "Like" search is made. 
  • searchCountryCode – the country where the customer resides with either account or delivery addresses.
     

AcctSearchAccountResponse

The AcctSearchAccountResponse message is a JSON formatted message used to return accounts that match the criteria provided in the request. The sample below shows a typical response holding two accounts, which was the maximum requested, though more accounts exist.  

Sample 1
{
    "resultInfo": {
        "resultCode": 1,
        "resultText": "MORE"
    },
    "acctSearchAccountResponseDetails": {
        "accountResultSet": [
            {
                "ariaAccountID": "6669c9c5-218c-4da6-8da2-4fd96b3d98d1",
                "ariaAccountNo": 11122233,
                "userID": "",
                "acctCurrencyCode": "NOK",
                "acctBalance": -199.00,
                "acctStatusCode": 1,
                "contactDetails": {
                    "firstName": "Hans",
                    "middleInitials": "",
                    "lastName": "Hansen",
                    "fullName": "Hans Hansen",
                    "addressLine1": "Akersgt. 23",
                    "addressLine2": "",
                    "addressLine3": "",
                    "countryCode": "NO",
                    "postalCode": "0444",
                    "postalCity": "Oslo",
                    "addrLocality": "",
                    "addrStateProv": "",
                    "streetName": "Akersgt.",
                    "streetNo": "23",
                    "flatNo": "",
                    "flatSpec": "",
                    "flatFloor": "",
                    "entranceNo": "",
                    "homePhone": "+4721212121",
                    "cellPhone": "+4721212121",
                    "workPhone": "+4722222222",
                    "emailAddress": "myemail@mydomain.com"
                }
            },
            {
                "ariaAccountID": " 8f5c36ea-03ff-401e-9b54-e9012eb1cc35",
                "ariaAccountNo": 11122244,
                "userID": "",
                "acctCurrencyCode": "NOK",
                "acctBalance": -299.00,
                "acctStatusCode": 1,
                "contactDetails": {
                    "firstName": "Ivar",
                    "middleInitials": "",
                    "lastName": "Hansen",
                    "fullName": "Ivar Hansen",
                    "addressLine1": "Akersgt. 55",
                    "addressLine2": "",
                    "addressLine3": "",
                    "countryCode": "NO",
                    "postalCode": "0444",
                    "postalCity": "Oslo",
                    "addrLocality": "",
                    "addrStateProv": "",
                    "streetName": "Akersgt.",
                    "streetNo": "55",
                    "flatNo": "",
                    "flatSpec": "",
                    "flatFloor": "",
                    "entranceNo": "",
                    "homePhone": "+4731313131",
                    "cellPhone": "+4731313131",
                    "workPhone": "+4733333333",
                    "emailAddress": "myemail@mydomain.com"
                }
            }
        ]
    }
}

The individual data elements of the resultInfo structure are defined as follows:

  • resultCode - contains a code indicating the outcome of the operation. The following result codes may be returned:
    • 0 – All the accounts matching the criteria has been returned without errors.
    • 1 – The number of accounts up to the row limit request has been returned, but more accounts fulfill the criteria. 
    • <0 – the call failed for some reason. 
  • resultText - If success is returned, this element contains "OK". For other return codes, the element contains a description of the problem. 

The individual data elements of the acctSearchAccountResponseDetails structure are defined as follows:

  • ariaAccountID - contains the client defined identification of the new account. This is the AID ID, if one is present.
  • ariaAccountNo - contains the Aria generated unique account identifier. This identifier may be used in subsequent API calls. 
  • userID - contains the userid defined for the account, if present. 
  • acctCurrencyCode - contains the currency the customers account is operated in.  
  • acctBalance – contains the current balance of the account. A negative value indicates that the customers owes the Client. A positive number indicates that Client owes the customer. 
  • acctStatusCode – contains the status of the account. The following codes apply:
    • 0 – Account is inactive.
    • 1 – Account is active.
    • 32 – Account is registered, but pending activation.
    • 99 – Account status is permanent.
    • -99 – Account is archived.
  • contactDetails – contains the general contact details of the account. 
    • firstName - contains the first name of the customer. If not available, it will be blank. 
    • middleInitials - contains the middle initials of the customer. if not available, it will be blank.
    • lastName - contains the last name (given name) of the customer. If not available, it will be blank.
    • fullName - contains the full name of the customer or it contains the company name of the customer. 
    • addressLine1 - contains the first line of the customer’s address. If not present, it will be blank. 
    • addressLine2 - contains the second line of the customer’s address. If not present, it will be blank. 
    • addressLine3 - contains the third line of the customer’s address. If not present, it will be blank. 
    • postalCode - contains the postal code of the customer’s address. If not present, it will be blank.
    • postalCity - contains the postal city of the customer’s address. If not present, it will be blank.
    • addrLocality – contains the locality of the current address.
    • addrStateProv – for addresses in the United States (US), Australia (AU) and Canada (CA) this field contains the code identifying the state or province.
    • streetName – if present, this field contains only the name of the street. Numbers, floors, etc. are not included. 
    • streetNo – if present, this field contains only the street number and no other part of the address.
    • flatNo – if present, this field contains the number of the flat.
    • flatSpec – if present, this field contains the specification of the flat, for example left, right, center, etc. 
    • flatFloor – if present, this field contains the floor where the flat is found.
    • entranceNo – if present, this field contains the number of the entrance to the flat.
    • homePhone - contains the home phone number of the customer. If not present, it will be blank.
    • cellPhone - contains the cell phone number of the customer. If not present, it will be blank.
    • workPhone - contains the work phone number of the customer. If not present, it will be blank.
    • emailAddress - contains the email address associated with the customer. 
       

Manage Account (JSON API) 

Endpoint

This API can be called by making a POST call to the URL: 
https://[clienthost]/PostDataToFlow/ARIAMediaSuite/AccountManagement/AcctManageAccount

AcctManageAccountRequest

The AcctManageAccountRequest message is a JSON formatted message used to update, modify or cancel an existing account. The following functions are provided by the service:

  • ASSIGN – used when the caller needs to assign a new client defined account id or client defined user id. When using this option, the Aria generated account number must be provided. 
  • MODIFY – used when the caller needs to update general parts of the account. 
  • CANCEL – used when the caller needs to cancel the account and any associated subscriptions.
  • STATUS – used when the caller needs to update the status of the account, other than cancellation, for example to re-activate the account. 

Below several examples are given, namely:

  • Sample 1); Update assigning a new client defined account ID.
  • Sample 2); Modify general information on the account.
  • Sample 3); Cancelling the account.
  • Sample 4); Change the status of the account.

Sample 1
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctManageAccountDetails": [
        {
            "actionDirective": "ASSIGN",
            "acctManageAccountDetailsASSIGN": {
                "ariaAccountNo": 112233,
                "ariaAccountID": "OLD-ACCTID-1",
                "newAriaAccountID": "NEW-ACCTID-1",
                "newUserID": null
            }
        }
    ]
}

Sample 2
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctManageAccountDetails": [
        {
            "actionDirective": "MODIFY",
            "acctManageAccountDetailsMODIFY": {
                "ariaAccountNo": 112233,
                "ariaAccountID": "NEW-ACCTID-1",
                "ownerTitleCode": "SA",
                "ownerTitleDomain": "www.sandeavis.no", 
                "accountContact": {
                    "firstName": "Niels Kristian",
                    "middleInitials": "",
                    "lastName": "Nielsen",
                    "fullName": "Niels Kristian Nielsen",
                    "addressLine1": "",
                    "addressLine2": "",
                    "addressLine3": "",
                    "countryCode": "NO",
                    "postalCode": "",
                    "postalCity": "",
                    "addrLocality": "",
                    "addrStateProv": "",
                    "streetName": "",
                    "streetNo": "",
                    "flatNo": "",
                    "flatSpec": "",
                    "flatFloor": "",
                    "entranceNo": "",
                    "homePhone": "",
                    "cellPhone": "+4422334466",
                    "workPhone": "",
                    "emailAddress": "myemail@mydomain.com"
                    "birthDate": "1965-04-13"
                },
                "channelCode": "NONE",
                "reservationCode": "NONE",
                "sourceCode": "NONE"
            }
        }
    ]
}

Sample 3
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctManageAccountDetails": [
        {
            "actionDirective": "CANCEL",
            "acctManageAccountDetailsCANCEL": {
                "ariaAccountNo": 112233,
                "ariaAccountID": "NEW-ACCTID-1"
            }
        }
    ]
}

Sample 4
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctManageAccountDetails": [
        {
            "actionDirective": "STATUS",
            "acctManageAccountDetailsCANCEL": {
                "ariaAccountNo": 112233,
                "ariaAccountID": "NEW-ACCTID-1",
                "ariaStatusCode": "ACTIVATE"
            }
        }
    ]
}

The individual data elements of msgAuthDetails are defined as follows:

  • clientNo - contains the Aria specific identification of the instance in which the solution currently operates. Varies from test to production. This value is required in all API calls to Aria to authenticate the caller. 
  • authKey - contains the Aria specified authentication key. This key is required in all API calls to Aria to authenticate the caller.  
  • requestDateTime - contains the date and time when the message was built. 
  • signatureValue -  contains the signature value calculated by the sending solution. Using the private key the receiving solution will validate the information retrieved, and if no match is found, the call will fail. 
  • ariaAccountID - contains the client defined identification of the customer account, for example a number from a CRM system or other customer master.  Used for the signature value calculation.
  • ariaAccountNo - contains the Aria generated identification of the account. Will always be zero as the account has not been created yet. 

The individual data elements of acctManageAccountDetails are defined as follows:

  • actionDirective – contains a code indicate the action to take on the account provided. The following codes are supported:
    • "ASSIGN" – used to assign a new client defined account id or user id.
    • "MODIFY" – used to modify the general information on the account.
    • "CANCEL" – used to cancel the current account. 
    • "STATUS" – used to modify the status of the account, for example reactivating the account. 
  • acctManageAccountDetailsASSIGN – the structure holding the necessary information to support the ASSIGN action. Is present only if the ASSIGN directive is used. 
  • acctManageAccountDetailsMODIFY – the structure holding the necessary information to support the MODIFY action. Is present only if the MODIFY directive is used. 
  • acctManageAccountDetailsCANCEL – the structure holding the necessary information to support the CANCEL action. Is present only if the CANCEL directive is used. 
  • acctManageAccountDetailsSTATUS – the structure holding the necessary information to support the STATUS action. Is present only if the STATUS directive is used.

The individual data elements of acctManageAccountDetailsASSIGN are defined as follows:

  • ariaAccountNo – contains the Aria generated number identifying the account. 
  • ariaAccountID – contains the current client defined identification of the account. If present, this field takes precedence over ariaAccountNo if both have been provided. 
  • newAriaAccountID – contains the new client defined identification of the account.
  • newUserID – contains the new user identification of the account.

The individual data elements of acctManageAccountDetailsMODIFY are defined as follows:

  • ariaAccountNo – contains the Aria generated number identifying the account. 
  • ariaAccountID – contains the client defined identification of the account. If present, this field takes precedence over ariaAccountNo if both have been provided. 
  • ownerTitleCode – if present, the title provide will be assigned as the new owner title. The title code must exist in the Title Details (TD) table. 
  • ownerTitleDomain – if present, the title domain is used to assign the new owner title code. The title domain must exist in the Title Details (TD) table. If both ownerTitleDomain and ownerTitleCode is present, ownerTitleDomain takes precedence over ownerTitleCode.  
  • ownerContactDetails – the overall structure holding the contact details of the customer. 
    • firstName - contains the first name of the customer. If not available, leave blank. 
    • middleInitials - contains the middle initials of the customer. if not available, leave blank.
    • lastName - contains the last name (given name) of the customer. If not available, leave blank.
    • fullName - contains the full name of the customer or it contains the company name of the customer. Must be present. 
    • addressLine1 - contains the first line of the customer’s address. If not present, leave blank. 
    • addressLine2 - contains the second line of the customer’s address. If not present, leave blank. If present, addressLine1 must also be present. 
    • addressLine3 - contains the third line of the customer’s address. If not present, leave blank. If present, addressLine2 must also be present. 
    • postalCode - contains the postal code of the customer’s address. If not present, leave blank.
    • postalCity - contains the postal city of the customer’s address. If not present, leave blank.
    • addrLocality – contains the locality of the current address.
    • addrStateProv – for addresses in the United States (US), Australia (AU) and Canada (CA) this field contains the code identifying the state or province.
    • streetName – if present, this field contains only the name of the street. Numbers, floors, etc. are not included. 
    • streetNo – if present, this field contains only the street number and no other part of the address.
    • flatNo – if present, this field contains the number of the flat.
    • flatSpec – if present, this field contains the specification of the flat, for example left, right, center, etc. 
    • flatFloor – if present, this field contains the floor where the flat is found.
    • entranceNo – if present, this field contains the number of the entrance to the flat.
    • homePhone - contains the home phone number of the customer. If not present, leave blank.
    • cellPhone - contains the cell phone number of the customer. If not present, leave blank.
    • workPhone - contains the work phone number of the customer. If not present, leave blank.
    • emailAddress - contains the email address associated with the customer. Must contain a valid email address. 
    • birthDate – contains the date of birth of the person represented in the current contact. If not available, the attribute may contain "null".
  • channelCode – contains a code defined by the client representing the channel from where the customer was first created, for example WEB site, CSR, etc. Any display character is allowed. 
  • reservationCode – contains a code defined by the client representing whether the customer has made reservations against unsolicited communication from the client. 
  • sourceCode – contains a code defined by the client representing the source of the customer, for example a marketing campaign, etc.


The individual data elements of acctManageAccountDetailsCANCEL are defined as follows:

  • ariaAccountNo – contains the Aria generated number identifying the account to cancel. 
  • ariaAccountID – contains the client defined identification of the account to cancel. If present, this field takes precedence over ariaAccountNo if both have been provided. 

The individual data elements of acctManageAccountDetailsSTATUS are defined as follows:

  • ariaAccountNo – contains the Aria generated number identifying the account to have its status changed. 
  • ariaAccountID – contains the client defined identification of the account to have its status changed. If present, this field takes precedence over ariaAccountNo if both have been provided. 
  • newStatusCode – contains a code identifying the new status of the account. The following codes are supported:
    • ACTIVATE – makes the account activate and ready for use. 
    • DEACTIVATE – makes the account inactive.
    • BANNED – bans the account and makes it inactive and unavailable for use. 

AcctManageAccountResponse

The AcctManageAccountResponse message is a JSON formatted message used to the result of the update of the account. 
Below several examples are given, namely:

  • Sample 1); General response returned for an update.

Sample 1
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "acctManageAccountResponseDetails": [
        {
            "actionDirective": "ASSIGN",
            "actionResultInfo": {
                "resultCode": 0,
                "resultText": "OK"
            },
            "ariaAccountNo": 112233,
            "ariaAccountID": "NEW-ACCTID-1",
        },
        {
            "actionDirective": "STATUS",
            "actionResultInfo": {
            "ariaAccountNo": 112233,
            "ariaAccountID": "NEW-ACCTID-1",
            },
            "ariaAccountID": "a",
            "ariaAccountNo": 1
        }
    ]
}

The individual data elements of the resultInfo structure contains the overall result of the operation and it contains the following attributes:

  • resultCode - contains a code indicating the outcome of the operation. 0 indicates success; any other code indicates a failure. 
  • resultText - If success is returned, this element contains "OK". If a failure occurred, the element contains a description of the problem.

The individual data elements of the acctManageAccountResponseDetails structure contains the same number of rows as the request. The structure is defined as follows:

  • actionDirective – contains a code indicate the action to take on the account provided. The following codes are supported:
    • "ASSIGN" – used to assign a new client defined account id or user id.
    • "MODIFY" – used to modify the general information on the account.
    • "CANCEL" – used to cancel the current account. 
    • "STATUS" – used to modify the status of the account, for example reactivating the account. 
  • actionResultInfo – a structure defining the result of the individual operations executed by the service. 
    • resultCode - contains a code indicating the outcome of the specific operation. 0 indicates success; any other code indicates a failure. 
    • resultText - If success is returned, this element contains "OK". If a failure occurred, the element contains a description of the problem. 
  • ariaAccountID - contains the client defined identification of the account. 
  • ariaAccountNo - contains the Aria generated identification of the account.
     

Create Account (JSON API)

Endpoint

This API can be called by making a POST call to the URL 
https://[clienthost]/PostDataToFlow/ARIAMediaSuite/AccountManagement/AcctCreateAccount

AcctCreateAccountRequest

The AcctCreateAccountRequest message is a JSON formatted message used to create the customer and initial special subscription (required for technical purposes). Only information available on the website is transferred and various parameters may be set directly by the service. Below several examples are given, namely:

  • Sample 1); Customer with most details available.
  • Sample 2); Customer with only basic information available.

Sample 1
{

    "msgAuthDetails": {
        "clientNo": 99,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2019-10-19",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctCreateAccountRequestDetails": {
        "ariaAccountID": "ACCT1",
        "currencyCode": "NOK",
        "localeCode": "NO-BOKMAL",
        "languageCode": "NO",
        "userID": "ACCT1-USER",
        "notifyMethod": "PDF",
        "accountContact": {
            "firstName": "Niels Kristian",
            "middleInitials": "",
            "lastName": "Nielsen",
            "fullName": "Niels Kristian Nielsen",
            "addressLine1": "Pilestredet 17",
            "addressLine2": "",
            "addressLine3": "",
            "countryCode": "NO",
            "postalCode": "0444",
            "postalCity": "Oslo",
            "addrLocality": "",
            "addrStateProv": "",
            "streetName": "",
            "streetNo": "",
            "flatNo": "",
            "flatSpec": "",
            "flatFloor": "",
            "entranceNo": "",
            "homePhone": "+4422334455",
            "cellPhone": "+4422334466",
            "workPhone": "+4422334477",
            "emailAddress": "myemail@mydomain.com",
            "birthDate": "1965-04-13"
        },
        "ownerTitleCode": "RB",
        "ownerTitleDomain": "www.rb.no",
        "customerType": "CONSUMER",
        "paymentTerms": "BANKGIRO",
        "paymentEANNum": "",
        "paymentEANRequisitionNum": "",
        "acctBillDay": "1",
        "channelCode": "NONE",
        "consentCode": "NONE",
        "taxpayerID": "AB",
                     "taxpayerExemptionLevel": "NONE",
        "requestSource": "WEB",
        "acctCreateAccountPayOptionInfo": {
                 "payOptionID": "EHF",
                 "payOptionVariant": "STANDARD",
                 "paymentEANNum": "None",
                 "paymentEANRequisitionNum": "None",
        }
    }
         
}

Sample 2
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctCreateAccountRequestDetails": {
        "ariaAccountID": "ACCT2",
        "currencyCode": "NOK",
        "localeCode": "NO-BOKMAL",
        "languageCode": "NO",
        "userID": "ACCT2-USER",
        "notifyMethod": "PDF",
        "accountContact": {
            "firstName": "Niels Kristian",
            "middleInitials": "",
            "lastName": "Nielsen",
            "fullName": "Niels Kristian Nielsen",
            "addressLine1": "",
            "addressLine2": "",
            "addressLine3": "",
            "countryCode": "NO",
            "postalCode": "",
            "postalCity": "",
            "addrLocality": "",
            "addrStateProv": "",
            "streetName": "",
            "streetNo": "",
            "flatNo": "",
            "flatSpec": "",
            "flatFloor": "",
            "entranceNo": "",
            "homePhone": "",
            "cellPhone": "+4422334466",
            "workPhone": "",
            "emailAddress": "myemail@mydomain.com",
            "birthDate": "1965-04-13"
        },
        "ownerTitleCode": "RB",
        "ownerTitleDomain": "www.rb.no",
        "customerType": "CONSUMER",
        "paymentTerms": "BANKGIRO",
        "paymentEANNum": "",
        "paymentEANRequisitionNum": "",
        "acctBillDay": "1",
        "channelCode": "NONE",
        "reservationCode": "NONE",
        "sourceCode": "NONE",
                 "consentCode": "NONE",
        "taxpayerID": "AA",
                     "taxpayerExemptionLevel": "NONE"
        "requestSource": "WEB",
        "acctCreateAccountPayOptionInfo": {
             "payOptionID": "EHF",
             "payOptionVariant": "STANDARD",
             "paymentEANNum": "None",
             "paymentEANRequisitionNum": "None",
        }

    } 

}
 

The individual data elements of msgAuthDetails are defined as follows:

  • clientNo - contains the Aria specific identification of the instance in which the solution currently operates. Varies from test to production. This value is required in all API calls to Aria to authenticate the caller. 
  • authKey - contains the Aria specified authentication key. This key is required in all API calls to Aria to authenticate the caller.  
  • requestDateTime - contains the date and time when the message was built. 
  • signatureValue - contains the signature value calculated by the sending solution. Using the private key the receiving solution will validate the information retrieved, and if no match is found, the call will fail. 
  • ariaAccountID - contains the defined identification of the customer account, for example a number from a CRM system or other customer master.  Used for the signature value calculation.
  • ariaAccountNo - contains the Aria generated identification of the account. Will always be zero as the account has not been created yet.

The individual data elements of acctCreateAccountRequestDetails are defined as follows:

  • ariaAccountID - contains the defined identification of the customer account, for example a number from a CRM system or other customer master.  
  • currencyCode - contains the currency in which the customer account is operated. Most often this is set to "NOK" to represent Norwegian kroner. Note once an account has been created with a given currency it CANNOT be changed. Currency code must be a valid ISO currency code.
  • localeCode - contains a code (localeID) indicating which of the three default languages the customer has chosen. Valid locale codes can be obtained using API "Solution Retrieve Locales [SolmRetrieveLocales]"
  • languageCode - contains a code indicating the preferred language for the customer. If localeCode contains a value other than "OTHER", then set this field to "NO" indicating Norwegian. Otherwise set it to the ISO defined code representing the chosen language. 
  • userID - contains the userid which with the customer logs into the Customer websites. 
  • notifyMethod - contains a code indicating how the communication with the end-customer takes place. The following options exist:
    • "NONE" - no specific communication is set to the customer.
    • "HTML" - the communication is via HTML formatted emails.
    • "TEXT" - the communication is via TEXT formatted emails.
    • "PDF" - the communication is via PDF formatted documents and emails.
    • "XML" - the communication is managed via XML files sent to another solution for final delivery to the end-customer.
  • ownerTitleCode - contains the identification of the title considered the owner of this customer, i.e. the identification of the title first purchased by the customer. Set depending on the website from which the creation is made. 
  • ownerTitleDomain - contains the domain associated with the title considered the owner of this customer, i.e. the identification of the title first purchased by the customer. If present, this attribute takes precedence over the ownerTitleCode attribute. 
  • customerType - contains a code indicating the type of customer. The following options exist:
    • "CONSUMER" - the customer is a consumer customer.
    • "BUSINESS" - the customer is a business customer, i.e. a company. 
  • paymentTerms - contains a code indicating the initial payment method chosen by the customer or defaulted by the caller. The following codes are supported:
    • "BANKGIRO" – the default method where the customer must use a traditional bank transfer to pay the bills. If the customer wants to pay with credit card, this payment term will be overridden when the credit card is registered successfully.
    • "EHF" – a method allowing the customer to pay via electronic invoicing, provided the EAN and EAN requisition number has been provided. Used primarily for public and government companies. 
  • paymentEANNum – if paymentTerms contain "EHF" then this field must contain the identification of the customer with the EHF system. The number should be obtained from the customer. For other payment terms the field is not used. 
  • paymentEANRequisitionNum – if paymentTerms contain "EHF", then this field must contain the requisition number provided by the customer. Is used by the customer to correctly place the invoice when it is received. 
  • altBillDay – contains the day of the month when the customer would like to be billed. This attribute defines the date the customer is billed and does not impact the subscription period as such. If not present, the current day is used. 
  • channelCode – contains a code defined by the client representing the channel from where the customer was first created, for example WEB site, CSR, etc. Any display character is allowed. 
  • reservationCode – contains a code defined by the client representing whether the customer has made reservations against unsolicited communication from the client. 
  • sourceCode – contains a code defined by the client representing the source of the customer, for example a marketing campaign, etc.
  • reservationCodeDate – attribute contains the date the reservation code was last updated. Optional string field with format YYYY-MM-DD.
  • consentCodeDate – attribute contains the date the reservation code was last updated. Optional string field with format YYYY-MM-DD.
  • consentCode – attribute contains a code indicating the consent given by the customer. Codes are defined by the client. 
  • taxpayerID – attribute contains the identification of the customer with the tax authorities. Used only for business customer. 
  • taxpayerExemptionLevel – attribute contains a code indicating the level of tax exemption the customer may have. The following codes apply:
    • "NONE" – no tax (VAT) exemption is provided.
    • "FULL" – full tax (VAT) exemption is provided.
  • requestSource – a new optional attribute holding a code indicating the source of the request. The following options apply:
    • "WEB" – the payment option can be used to create new accounts and/or billing groups from the WEB only. This is the default value. 
    • "CSR" – the payment option can be used to create new accounts and/or billing groups from the CSR platform only. 
  • payOptionInfo – a new optional attribute holding the details on the payment options / variants to apply for the new account. The structure is defined in acctCreateAccountPayOptionInfo found later in this section.
  • paymentTerms – this attribute is deprecated and will in a future release be removed from the request. If payOptionInfo is not present in the request, paymentTerms will continue to provide backward compatibility. 

Original description is: "Contains a code indicating the initial payment method chosen by the customer or defaulted by the caller. The following codes are supported:

  • "BANKGIRO" – the default method where the customer must use a traditional bank transfer to pay the bills. If the customer wants to pay with credit card, this payment term will be overridden when the credit card is registered successfully.
  • "EHF" – a method allowing the customer to pay via electronic invoicing, provided the EAN and EAN requisition number has been provided. Used primarily for public and government companies.
  • paymentEANNum – this attribute is deprecated and will in a future release be removed from the request. If payOptionInfo is not present in the request, paymentEANNum will continue to provide backward compatibility. 

Original description is: "If paymentTerms contain "EHF" then this field must contain the identification of the customer with the EHF system. The number should be obtained from the customer. For other payment terms the field is not used".
 

  • paymentEANRequisitionNum – this attribute is deprecated and will in a future release be removed from the request. If payOptionInfo is not present in the request, paymentEANRequisitionNum will continue to provide backward           compatibility  in which case:

Original description is: "If paymentTerms contain "EHF", then this field must contain the requisition number provided by the customer. Is used by the customer to correctly place the invoice when it is received."

The structure acctCreateAccountPayOptionInfo included to the request structures:

  • acctCreateAccountPayOptionInfo – a structure holding the general information on the payment option to be managed. 
    • payOptionID – contains the identification of the payment option to be assigned to the initial billing group created for the new account. Only payment options that are allowed for new billing groups can be used, for example "BANKGIRO" or "EHF"
    • payOptionVariant – contains the identification of the payment option variant to be assigned to the initial billing group created for the new account. Is selected by the customer based on the choices presented. 
    • paymentEANNum – contains additional information used for some payment options.  
    • paymentEANRequisitionNum – contains additional information used for some payment options.

The individual data elements of accountContact (the accountContact details are used as the default account owner details within Aria) are defined as follows:

  • firstName - contains the first name of the customer. If not available, leave blank. 
  • middleInitials - contains the middle initials of the customer. if not available, leave blank.
  • lastName - contains the last name (given name) of the customer. If not available, leave blank.
  • fullName - contains the full name of the customer or it contains the company name of the customer. Must be present. 
  • addressLine1 - contains the first line of the customer’s address. If not present, leave blank. 
  • addressLine2 - contains the second line of the customer’s address. If not present, leave blank. If present, addressLine1 must also be present. 
  • addressLine3 - contains the third line of the customer’s address. If not present, leave blank. If present, addressLine2 must also be present. 
  • postalCode - contains the postal code of the customer’s address. If not present, leave blank.
  • postalCity - contains the postal city of the customer’s address. If not present, leave blank.
  • addrLocality – contains the locality of the current address.
  • addrStateProv – for addresses in the United States (US), Australia (AU) and Canada (CA) this field contains the code identifying the state or province.
  • streetName – if present, this field contains only the name of the street. Numbers, floors, etc. are not included. 
  • streetNo – if present, this field contains only the street number and no other part of the address.
  • flatNo – if present, this field contains the number of the flat.
  • flatSpec – if present, this field contains the specification of the flat, for example left, right, center, etc. 
  • flatFloor – if present, this field contains the floor where the flat is found.
  • entranceNo – if present, this field contains the number of the entrance to the flat.
  • homePhone - contains the home phone number of the customer. If not present, leave blank.
  • cellPhone - contains the cell phone number of the customer. If not present, leave blank.
  • workPhone - contains the work phone number of the customer. If not present, leave blank.
  • emailAddress - contains the email address associated with the customer. Must contain a valid email address. 
  • birthDate – contains the date of birth of the person represented in the current contact. If not available, the attribute may contain "null".

AcctCreateAccountResponse

The AcctCreateAccountResponse message is a JSON formatted message used to return customer and subscription details during the creation of a new customer. The response contains the various identifications of the account, subscription and other objects in Aria. The following is a sample structure returned on creation of a new customer. Note this structure contains more details than would normally be returned after account creation. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    " acctCreateAccountResponseDetails": {
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 2442345,
        "userID": "ACCT1-USER",
        "ariaAcctContactNo": 22445566,
        "ariaSpecPlanMPIID": "MPI-502b4dee-ff35-44be-bff6-282d416f2e57",
        "ariaSpecPlanMPINo": 11223344,
        "acctCreateAccountBillingGroupDetails": [
            {
                "ariaBillingGroupID": "BG-502b4dee-ff35-44be-bff6-282d416f2e57",
                "ariaStmtContactNo": 22445566,
                "billingGroupName": "Standard",
                "billingGroupDesc": "Standard",
                "notifyMethod": "PDF",
                "paymentTerms": "BANKGIRO",
                "paymentEANNum": "",
                "paymentEANRequisitionNum": "",
                "primaryPaymentMethodID": "",
                "backupPaymentMethodID": "",
                "ariaDunningGroupID": "DG-502b4dee-ff35-44be-bff6-282d416f2e57",
                "dunningGroupName": "DEFAULT",
                "dunningGroupDesc": "DEFAULT",
                "dunningProcessID": "AM-DEFAULT"
            }
        ],
        "acctCreateAccountPaymentMethodDetails": [
            {
                "ariaPaymentMethodID": "PM-502b4dee-ff35-44be-bff6-282d416f2e57",
                "ariaPaymentMethodNo": 1,
                "payMethodType": "CC",
                "ariaBillContactNo": 22445566,
                "creditCardMasked": "**** **** **** 1234",
                "creditCardType": "VISA",
                "creditCardExpMonth": "12",
                "creditCardExpYear": "2020"
              }
        ]
    }
}

The individual data elements of the resultInfo structure are defined as follows:

  • resultCode - contains a code indicating the outcome of the operation. 0 indicates success; any other code indicates a failure. 
  • resultText - If success is returned, this element contains "OK". If a failure occurred, the element contains a description of the problem.

The individual data elements of the acctCreateAccountResponseDetails structure are defined as follows:

  • ariaAccountID - contains the client defined identification of the new account. Is identical to the value passed in the request. 
  • ariaAccountNo - on return, the field contains the Aria generated unique account identifier. This identifier must be stored for later used in other API calls. 
  • userID - on return, the field contains either the userid provided in the request, or if not provided and Aria generated unique identifier.  
  • ariaAcctContactNo - on return, the field contains the Aria generated identification of the main contact details provided in the request. Will be used for later updates to the contact details.
  • ariaSpecPlanMPIID – on return, the field contains the solution generated unique identification of the special plan instance added for the account. Is used primarily when registering credit cards before any subscriptions are added. 
  • ariaSpecPlanMPINo – on return, the field contains the Aria generated unique identification of the special plan instance added for the account. 
  • acctCreateAccountBillingGroupDetails - on return, this array contains the billing groups created automatically when the account is created. The array will contain at least one billing group. Refer to the description of acctCreateAccountBillingGroupDetails for details on the elements in the structure. 
  • acctCreateAccountPaymentMethodDetails - on return, this array contains the payment methods created automatically when the account is created. This information is not available immediately after the account creation and will therefore be omitted. Refer to the description of acctCreateAccountPaymentMethodDetails for details on the elements in the structure. 

The response will contain one or more entries of the acctCreateCustomerBillingGroupDetails structure. The individual data elements of the acctCreateCustomerBillingGroupDetails structure are defined as follows:

  • ariaBillingGroupID - on return, the field contains the solution generated unique identification of the billing group. Will be used in subsequent API calls, so it must be stored for later use. 
  • ariaStmtContactNo - on return, the field contains the Aria generated identification of the main contact details provided in the request. This contain will be used to email statements and invoices. 
  • billingGroupName - on return, this field contains the solution generated name of the billing group. For the initial billing group, a value of "Default" is used. 
  • billingGroupDesc - on return, this field contains a brief description of the billing group. Initially it will contain "Default" indicating that this is the default billing group. 
  • notifyMethod - on return, this field contains the notification method assigned to the account. All communication is delivered to the customer using this method. The following values are possible:
    • "TEXT" - communication is sent as a text email
    • "HTML" - communication is sent as an html formatted email. 
    • "PDF" - communication is sent as text emails with PDF attachments
    • "XML" - communication is not sent directly but is output as an XML structure which can be processed by another solution. 
  • paymentTerms - contains a code indicating the initial payment method chosen by the customer or defaulted by the caller. The following codes are supported:
    • "BANKGIRO" – the default method where the customer must use a traditional bank transfer to pay the bills. 
    • "EHF" – a method allowing the customer to pay via electronic invoicing, provided the EAN and EAN requisition number has been provided. Used primarily for public and government companies. 
  • paymentEANNum – if paymentTerms contain "EHF" then this field must contain the identification of the customer with the EHF system. The number should be obtained from the customer. For other payment terms the field is not used. 
  • paymentEANRequisitionNum – if paymentTerms contain "EHF", then this field must contain the requisition number provided by the customer. Is used by the customer to correctly place the invoice when it is received. 
  • primaryPaymentMethodID - on return, this field contains the identification of the primary payment method assigned to this billing group. The field references one of the payment methods defined in the paymentMethods structure. If credit cards are used as the primary payment method, this field is blank immediately after account creation, as no credit is yet registered. 
  • backupPaymentMethodID - on return, this field contains the identification of the backup payment method assigned to this billing group. The payment method is used in case the primary method cannot be used. The field references one of the payment methods defined in the paymentMethods structure. If credit cards are used as the primary payment method, this field is blank immediately after account creation, as no credit is yet registered. 
  • ariaDunningGroupID - on return, the field contains the solution generated unique identification of the dunning group. Will be used in subsequent API calls, so it must be stored for later use. 
  • dunningGroupName - on return, this field contains the solution generated name of the dunning group. For the initial dunning group, a value of "Default" is used. 
  • dunningGroupDesc - on return, this field contains a brief description of the dunning group. Initially it will contain "Default" indicating that this is the default dunning group. 
  • dunningProcessID - on return, this field contains the unique identification of the dunning process to be used for subscriptions under this account.  

The response may contain zero, one or more entries of the acctCreateAccountPaymentMethodDetails structure. The individual data elements of the acctCreateAccountPaymentMethodDetails structure are defined as follows:

  • ariaPaymentMethodID - on return, the field contains the solution generated unique identification of the payment method. Will be used in subsequent API calls, so it must be stored for later use. 
  • ariaPaymentMethodNo - on return, this field contains the Aria generated payment method number. Will be used in subsequent API calls, so it must be stored for later use. 
  • payMethodType - on return, this field contains the payment method in use. The following values are possible:
    • "CC" - the payment method covers a credit card stored in Aria
    • "CC-TOKEN" - the payment method covers credit card stored in the payment providers solution. 
  • ariaBillContactNo - on return, the field contains the Aria generated identification of the main contact details provided in the request. This contain will be used to handle billing related emails. 
  • creditCardMasked - on return, this field contains the masked credit card. Only the last 4 digits are visible.  
  • creditCardType - on return, this field contains the type of credit card registered, for example "VISA", "MASTERCARD", "AMEX", etc. 
  • creditCardExpMonth - on return, this field contains the expiry month of the registered credit card. 
  • creditCardExpYear - on return, this field contains the expiry year of the registered credit card.
  • payOptionInfo – a new optional attribute holding the details on the payment options / variants to apply for the new account. The structure is defined in acctCreateAccountPayOptionInfo found later in this section
  • paymentTerms – this attribute is deprecated and will in a future release be removed from the request. If payOptionInfo is not present in the request, paymentTerms will continue to provide backward compatibility.

 
Original description is: "Contains a code indicating the initial payment method chosen by the customer or defaulted by the caller. The following codes are supported:

  • "BANKGIRO" – the default method where the customer must use a traditional bank transfer to pay the bills. If the customer wants to pay with credit card, this payment term will be overridden when the credit card is registered successfully.
  • "EHF" – a method allowing the customer to pay via electronic invoicing, provided the EAN and EAN requisition number has been provided. Used primarily for public and government companies.

 

  • paymentEANNum – this attribute is deprecated and will in a future release be removed from the request. If payOptionInfo is not present in the request, paymentEANNum will continue to provide backward compatibility. 

Original description is: "If paymentTerms contain "EHF" then this field must contain the identification of the customer with the EHF system. The number should be obtained from the customer. For other payment terms the field is not used" 

  • paymentEANRequisitionNum – this attribute is deprecated and will in a future release be removed from the request. If payOptionInfo is not present in the request, paymentEANRequisitionNum will continue to provide backward compatibility in which case:

Original description is: "If paymentTerms contain "EHF", then this field must contain the requisition number provided by the customer. Is used by the customer to correctly place the invoice when it is received."

The structure acctCreateAccountPayOptionInfo is included to the response structures:

  • acctCreateAccountPayOptionInfo – a structure holding the general information on the payment option to be managed. 
    • payOptionID – contains the identification of the payment option to be assigned to the initial billing group created for the new account. Only payment options that are allowed for new billing groups can be used, for example "BANKGIRO" or "EHF"
    • payOptionVariant – contains the identification of the payment option variant to be assigned to the initial billing group created for the new account. Is selected by the customer based on the choices presented. 
    • paymentEANNum – contains additional information used for some payment options.
    • paymentEANRequisitionNum – contains additional information used for some payment options.
       

Other attributes may be added at a later stage. 
 

Retrieve Account (JSON API)

Endpoint

This API can be called by making a POST call to the URL:
https://[clienthost]/PostDataToFlow/ARIAMediaSuite/AccountManagement/AcctRetrieveAccount

AcctRetrieveAccountRequest

The AcctRetrieveAccountRequest message is a JSON formatted message used to retrieve information on a single customer account. The account can be retrieved using either the Aria account number of the client defined account identifier. The following examples are provided:

  • Sample 1); Retrieving the account using a client defined ID
  • Sample 2); Retrieving the account using an Aria account number

Sample 1
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctRetrieveAccountCriteria": {
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": null,
        "titleFiltering": [
             {
                "titleCode": "",
                "titleDomain": "www.tangotidene.no"
            },
            {
                "titleCode": "RB",
                "titleDomain": ""
            },
        }
    }
}

Sample 2
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctRetrieveAccountCriteria": {
        "ariaAccountID": null,
        "ariaAccountNo": 11223344,
        "titleFiltering": [
            {
                "titleCode": "",
                "titleDomain": "www.tangotidene.no"
            }
        }
    }
}

The individual data elements of msgAuthDetails are defined as follows:

  • clientNo - contains the Aria specific identification of the instance in which the solution currently operates. Varies from test to production. This value is required in all API calls to Aria to authenticate the caller. 
  • authKey - contains the Aria specified authentication key. This key is required in all API calls to Aria to authenticate the caller.  
  • requestDateTime - contains the date and time when the message was built. 
  • signatureValue -  contains the signature value calculated by the sending solution. Using the private key the receiving solution will validate the information retrieved, and if no match is found, the call will fail. 
  • ariaAccountID - contains the defined identification of the customer account, for example a number from a CRM system or other customer master.  Used for the signature value calculation.
  • ariaAccountNo - contains the Aria generated identification of the account. Will always be zero as the account has not been created yet. 

The individual data elements of acctRetrieveAccountCriteria are defined as follows:

  • ariaAccountNo - contains the Aria generated identification of the account. Used only if ariaAccountID is not available. 
  • ariaAccountID - contains the defined identification of the customer account, for example a number from a CRM system or other customer master.  If present, this attribute takes precedence over the ariaAccountNo.

The individual data elements of titleFiltering are defined as follows, and the structure can hold multiple entries:

  • titleCode – holds the Title Code of the Title belonging to billing group of the account which needs to be retrieved. It can be Null/Blank.
  • titleDomain – holds the Title Domain of the Title belonging to the billing group of the account which needs to be retrieved. It can be Null/Blank.

AcctRetrieveAccountResponse

The AcctRetrieveAccountResponse message is a JSON formatted message used to return customer account details. The response contains the detailed information on the account and a list of associated billing groups.  

{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "acctRetrieveAccountResponseDetails": {
        "ariaAccountID": "NATESTNav",
        "ariaAccountNo": 42050256.0,
        "acctRetrieveAccountDetails": {
            "ariaStatusCode": 1,
            "ariaStatusCodeText": "ACTIVE",
            "taxExemptionLevel": null,
            "acctStartDate": "2019-09-19",
            "ownerTitleCode": "TTT",
            "ownerTitleDomain": "www.TestTitle.no",
            "acctCurrencyCode": "nok",
            "acctBalance": 33.0,
            "purchaseOrderNo": null,
            "masterPlanCount": 1,
            "acctLocaleName": "NO-BOKMAL",
            "userID": "NATESTNav",
            "acctContactNo": 103801801,
            "acctContactDetails": {
                "firstName": "Naveed",
                "middleInitials": "AN",
                "lastName": "Ahmed",
                "fullName": "Nav Ahmed",
                "addressLine1": "dv",
                "addressLine2": "AddrLine2",
                "addressLine3": "AddrLine3",
                "countryCode": "NO",
                "postalCode": "0444",
                "postalCity": "Oslo",
                "addrLocality": "AddrLocality",
                "addrStateProv": null,
                "streetName": null,
                "streetNo": null,
                "flatNo": null,
                "flatSpec": null,
                "flagFloor": null,
                "entranceNo": null,
                "homePhone": "565645",
                "cellPhone": "ewrwer",
                "workPhone": "03025753570",
                "emailAddress": "myemail@mydomain.com",
                "birthDate": "2000-01-01"
            },
            "ariaSpecPlanMPIID": "MPI-f477c320-a71b-4b8a-9fe4-3cfaf30cf9a7",
            "ariaSpecPlanMPINo": 130464279,
            "channelCode": "Channel1",
            "reservationCode": "RC1",
            "sourceCode": "SC1",
            "reservationCodeDate": "2019-10-12",
            "consentCodeDate": "2019-09-09",
            "consentCode": "NAN",
            "taxpayerID": "1234NA",
            "taxpayerExemptionLevel": null
        },
        "acctRetrieveAccountBillingGroupList": [
            {
                "ariaBillingGroupID": "BG-f477c320-a71b-4b8a-9fe4-3cfaf30cf9a7",
                "ariaBillingGroupNo": 41407257,
                "billingGroupName": "CREDITCARD",
                "billingGroupDesc": "CREDITCARD[TitleCode=TTT]/[Option=CREDITCARD]/[Variant=STANDARD]",
                "ariaDunningGroupID": "DG-f477c320-a71b-4b8a-9fe4-3cfaf30cf9a7",
                "ariaDunningGroupNo": 42996172,
                "dunningGroupName": "CREDITCARD",
                "dunningGroupDesc": "CREDITCARD[TitleCode=TTT]/[Option=CREDITCARD]/[Variant=STANDARD]",
                "dunningProcessID": "DUNNING-02",
                "payOptionInfo": null
            }
        ],
        "acctRetrieveAccountTitleInfo": null
    }

 

The individual data elements of the resultInfo structure are defined as follows:

  • resultCode - contains a code indicating the outcome of the operation. 0 indicates success; any other code indicates a failure. 
  • resultText - If success is returned, this element contains "OK". If a failure occurred, the element contains a description of the problem.

The individual data elements of the acctRetrieveAccountResponseDetails structure are defined as follows:

  • ariaAccountID - contains the client defined identification of the new account. Is identical to the value passed in the request. 
  • ariaAccountNo - on return, the field contains the Aria generated unique account identifier of the account. 
  • acctRetrieveAccountDetails - on return, this structure contains the detailed information on the account itself. 
  • acctRetrieveAccountBillingGroupList - on return, this array contains the billing groups currently in use by the current account. Detailed information on the billing group are not returned. 
  • acctRetrieveAccountTitleInfo – on return, this structure contains details on the title defined as the owner for the current customer. 

The individual data elements of the acctRetrieveAccountDetails structure are defined as follows:

  • ariaStatusCode - contains the current status of the account. The following options exist:
    • 0 – INACTIVE
    • 1 – ACTIVE
    • 32 – REGISTERED PENDING ACTIVATION
    • 99 – PERMANENT
    • -99 – ARCHIVED 
  • ariaStatusCode - contains the current status of the account in text format. The following options exist:
    • "INACTIVE" – the account is inactive and is not billed.
    • "ACTIVE" – the account is active and is being serviced.
    • "PENDING" – the account has been registered, but is pending activation from the customer.
    • "PERMANENT" – the account is in Permanent status.
    • "ARCHIVED" – the account is archived and cannot be used. If customer wants to reopen the account, a NEW account must be created. 
  • taxpayerID - the field contains the identification of the taxpayer. Used only for business customers.
  • taxExemptionLevel – contains a code indicating the exemption level of the customer. The following codes apply:
    • "NONE" – the customer is NOT tax exempt.
    • "PARTIAL" – the customer is partial tax exempt.
    • "FULL" – the customer is fully tax exempt.
  • acctStartDate – contains the date the customer was first created. Is in the format YYYY-MM-DD.
  • ownerTitleCode – contains the identification of the title where the customer was first registered. 
  • ownerTitleDomain – contains the domain of the title where the customer was first registered.
  • acctCurrencyCode – contains the currency in which the customer account is operated. Will in most cases contain "NOK". 
  • acctBalance – contains the current balance of the account. A positive number indicates that the customer owes money, while a negative number indicates that the customer is owed. 
  • purchaseOrderNo – contains the purchase order number given by the customer when the account was created. If not available, it will be blank. 
  • masterPlanCount – contains the number of subscriptions currently registered on the account. There is no distinction between active or inactive subscriptions. The SPECIAL plan instance is not included in this number; hence the total number can be 0 (zero). 
  • acctLocaleName – contains the identification of the locale which the customer has selected. The following options exist:
    • "NO-BOKMAL" – the customer has selected Norwegian – Bokmål as their preferred language
    • "NO-NYNORSK" – the customer has selected Norwegian – Nynorsk as their preferred language
    • "NO-BOKMAL-A-ENDING" – the customer has selected Norwegian – Bokmål med A-ending" as their preferred language. 
  • userID - contains the userid assigned to the customer.
  • acctContactNo - on return, the field contains the Aria generated identification of the main contact details provided in the request. Will be used for later updates to the contact details
  • acctContactDetails – the overall structure holding the contact details for the account
    • firstName - contains the first name of the customer. If not available, leave blank. 
    • middleInitials - contains the middle initials of the customer. if not available, leave blank.
    • lastName - contains the last name (given name) of the customer. If not available, leave blank.
    • fullName - contains the full name of the customer or it contains the company name of the customer. Must be present. 
    • addressLine1 - contains the first line of the customer’s address. If not present, leave blank. 
    • addressLine2 - contains the second line of the customer’s address. If not present, leave blank. If present, addressLine1 must also be present. 
    • addressLine3 - contains the third line of the customer’s address. If not present, leave blank. If present, addressLine2 must also be present. 
    • postalCode - contains the postal code of the customer’s address. If not present, leave blank
    • postalCity - contains the postal city of the customer’s address. If not present, leave blank
    • addrLocality – contains the locality of the current address
    • addrStateProv – for addresses in the United States (US), Australia (AU) and Canada (CA) this field contains the code identifying the state or province
    • streetName – if present, this field contains only the name of the street. Numbers, floors, etc. are not included. 
    • streetNo – if present, this field contains only the street number and no other part of the address
    • flatNo – if present, this field contains the number of the flat 
    • flatSpec – if present, this field contains the specification of the flat, for example left, right, center, etc. 
    • flatFloor – if present, this field contains the floor where the flat is found
    • entranceNo – if present, this field contains the number of the entrance to the flat
    • homePhone - contains the home phone number of the customer. If not present, leave blank
    • cellPhone - contains the cell phone number of the customer. If not present, leave blank
    • workPhone - contains the work phone number of the customer. If not present, leave blank
    • emailAddress - contains the email address associated with the customer. Must contain a valid email address. 
    • birthDate – contains the birthday of the current contact. If not available, the field is empty. 
  • ariaSpecPlanMPIID – on return, the field contains the solution generated unique identification of the special plan instance added for the account. Is used primarily when registering credit cards before any subscriptions are added. 
  • ariaSpecPlanMPINo – on return, the field contains the Aria generated unique identification of the special plan instance added for the account. 
  • channelCode – contains a code defined by the client representing the channel from where the customer was first created, for example WEB site, CSR, etc. Any display character is allowed. 
  • reservationCode – contains a code defined by the client representing whether the customer has made reservations against unsolicited communication from the client. 
  • sourceCode – contains a code defined by the client representing the source of the customer, for example a marketing campaign, etc. 
  • reservationCodeDate - contains date defined by the client representing date customer has made reservations against unsolicited communication from the client.
  • consentCode - contains a code defined by the client indicating what level of consent the customer has given to the operator.
  • consentCodeDate - contains date defined by the client representing date customer has made reservations against unsolicited communication from the client.

The response will contain one or more entries in the acctRetrieveAccountBillingGroupList structure. Each entry contains general information on the billing groups and dunning groups defined for the current account. The structure is defined as follows:

  • ariaBillingGroupID - contains the solution generated unique identification of the billing group. 
  • ariaBillingGroupNo – contains the Aria generated unique identification of the billing group. 
  • billingGroupName - contains the solution generated name of the billing group. 
  • billingGroupDesc - contains a brief description of the billing group.
  • ariaDunningGroupID - on return, the field contains the solution generated unique identification of the dunning group. 
  • ariaDunningGroupNo – on return, the field contains the Aria generated unique identification of the dunning group. 
  • dunningGroupName - on return, this field contains the solution generated name of the dunning group. 
  • dunningGroupDesc - on return, this field contains a brief description of the dunning group. 
  • dunningProcessID - on return, this field contains the unique identification of the dunning process to be used for subscriptions under this account.  

The response will contain details on the title defined as the title owner for the current customers. The structure is defined as follows:

  • titleCode – contains the unique identification of the title being returned.
  • titleName – contains the name of the title being returned.
  • titleDesc – contains the full description of the title being returned. 
  • titleNameTranslations – contains the translations for the title name for each locale defined.
  • titleDescTranslations – contains the translations for the title description for each locale defined.
  • titleDomain – contains the title domain (URL) associated with the current title. 

 

Manage Billing Group (JSON API)

Endpoint

This API can be called by making a POST call to the URL:
https://[clienthost]/PostDataToFlow/ARIAMediaSuite/AccountManagement/AcctManageBillingGroup

AcctManageBillingGroupRequest

The AcctManageBillingGroupRequest message is a JSON formatted message used to update, modify or remove billing groups and associated dunning groups. The following functions are provided by the service:

  • ADD – used when the caller wants to add a new billing group. A dunning group will also be created
  • MODIFY – used when the caller wants to update a billing group and associated dunning group. 
  • REMOVE – used when the caller wants to remove (deactivate) a billing group and associated dunning group.  

Below several examples are given, namely:

  • Sample 1); Add a new billing group and dunning group.
  • Sample 2); Modify an existing billing group and dunning group.
  • Sample 3); Removing an existing billing group and dunning group.

Sample 1

{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctManageBillingGroupDetails": [
        {
            "actionDirective": "ADD",
            "ariaAccountNo": 11223344,
            "ariaAccountID": "502b4dee-ff35-44be-bff6-282d416f2e57",
            "acctManageBillingGroupDetailsADD": {
                "billingGroupStatus": "ACTIVE",
                "notifyMethod": "PDF",
                "paymentOption": "METHODS",
                "payOptionInfo": {
                    "payOptionID": "BANKGIRO-01",
                    "payOptionVariant": "STANDARD",
                    "paymentEANNum": "",
                    "paymentEANRequisitionNum": ""
                },
                "paymentMethodInfo": {
                    "primaryPaymentMethodID": "1",
                    "backupPaymentMethodID": ""
                },
                "requestSourceID": "WEB",
                "statementContactDetails": {
                    "firstName": "Niels Kristian",
                    "middleInitials": "",
                    "lastName": "Nielsen",
                    "fullName": "Niels Kristian Nielsen",
                    "addressLine1": "Akersgt. 4",
                    "addressLine2": "",
                    "addressLine3": "",
                    "countryCode": "NO",
                    "postalCode": "0444",
                    "postalCity": "Oslo",
                    "addrLocality": "",
                    "addrStateProv": "",
                    "streetName": "Akersgt.",
                    "streetNo": "4",
                    "flatNo": "",
                    "flatSpec": "",
                    "flatFloor": "",
                    "entranceNo": "",
                    "homePhone": "+4722334455",
                    "cellPhone": "+4722334455",
                    "workPhone": "",
                    "emailAddress": "myemail@mydomain.com"
                }
            }
        }
    ]
 

Sample 2

{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctManageBillingGroupDetails": [
        {
            "actionDirective": "MODIFY",
            "ariaAccountNo": 11223344,
            "ariaAccountID": "502b4dee-ff35-44be-bff6-282d416f2e57",
            "acctManageBillingGroupDetailsMODIFY": {
                "ariaBillingGroupNo": 11223344,
                "ariaBillingGroupID": "BG-502b4dee-ff35-44be-bff6-282d416f2e57",
                "billingGroupName": "BANKTRANSFER",
                "billingGroupDesc": "BANKTRANSFER: OCR",
                "billingGroupStatus": "ACTIVE",
                "notifyMethod": "PDF",
                "paymentOption": "METHODS",
                "payOptionInfo": {
                    "payOptionID": "BANKGIRO-01",
                    "payOptionVariant": "STANDARD",
                    "paymentEANNum": "",
                    "paymentEANRequisitionNum": ""
                },
                "paymentMethodInfo": {
                    "primaryPaymentMethodID": "1",
                    "backupPaymentMethodID": ""
                },
                "requestSourceID": "WEB",
                "statementContactNo": 11223344,
                "statementContactDetails": {
                    "firstName": "Niels Kristian",
                    "middleInitials": "",
                    "lastName": "Nielsen",
                    "fullName": "Niels Kristian Nielsen",
                    "addressLine1": "Akersgt. 4",
                    "addressLine2": "",
                    "addressLine3": "",
                    "countryCode": "NO",
                    "postalCode": "0444",
                    "postalCity": "Oslo",
                    "addrLocality": "",
                    "addrStateProv": "",
                    "streetName": "Akersgt.",
                    "streetNo": "4",
                    "flatNo": "",
                    "flatSpec": "",
                    "flatFloor": "",
                    "entranceNo": "",
                    "homePhone": "+4722334455",
                    "cellPhone": "+4722334455",
                    "workPhone": "",
                    "emailAddress": "myemail@mydomain.com"
                },
                "ariaDunningGroupID": "DG-502b4dee-ff35-44be-bff6-282d416f2e57",
                "ariaDunningGroupNo": 11223355,
                "dunningGroupName": "Standard",
                "dunningGroupDesc": "Standard",
                "dunningProcessID": "DEFAULT"
            }
        }
    ]
}

Sample 3
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctManageBillingGroupDetails": [
        {
            "actionDirective": "REMOVE",
            "ariaAccountNo": 11223344,
            "ariaAccountID": "502b4dee-ff35-44be-bff6-282d416f2e57",
            "acctManageBillingGroupDetailsREMOVE": {
                "ariaBillingGroupNo": 11223344,
                "ariaBillingGroupID": "BG-502b4dee-ff35-44be-bff6-282d416f2e57",
                "ariaDunningGroupID": "DG-502b4dee-ff35-44be-bff6-282d416f2e57",
                "ariaDunningGroupNo": 11223355,
            }
        }
    ]
}

The individual data elements of msgAuthDetails are defined as follows:

  • clientNo - contains the Aria specific identification of the instance in which the solution currently operates. Varies from test to production. This value is required in all API calls to Aria to authenticate the caller. 
  • authKey - contains the Aria specified authentication key. This key is required in all API calls to Aria to authenticate the caller.  
  • requestDateTime - contains the date and time when the message was built. 
  • signatureValue -  contains the signature value calculated by the sending solution. Using the private key the receiving solution will validate the information retrieved, and if no match is found, the call will fail. 
  • ariaAccountID - contains the defined identification of the customer account, for example a number from a CRM system or other customer master.  Used for the signature value calculation.
  • ariaAccountNo - contains the Aria generated identification of the account. Will always be zero as the account has not been created yet.

The individual data elements of acctManageBillingGroupDetails are defined as follows:

  • actionDirective – contains a code indicate the action to take on the account provided. The following codes are supported:
    • "ADD" – used to create a new billing and dunning group.
    • "MODIFY" – used to modify an existing billing and dunning group.
    • "REMOVE" – used to remove a billing and dunning group.
  • ariaAccountNo – contains the Aria generated number identifying the account for which the billing and dunning groups are maintained. 
  • ariaAccountID – contains the current client defined identification of the account. If present, this field takes precedence over ariaAccountNo if both have been provided. 
  • acctManageBillingGroupDetailsADD – the structure holding the necessary information to support the ADD action. Is present only if the ADD directive is used. 
  • acctManageBillingGroupDetailsMODIFY – the structure holding the necessary information to support the MODIFY action. Is present only if the MODIFY directive is used. 
  • acctManageBillingGroupDetailsREMOVE – the structure holding the necessary information to support the REMOVE action. Is present only if the REMOVE directive is used. 

The individual data elements of acctManageBillingGroupDetailsADD are defined as follows:

  • titleCode - an optional attribute specifying the title code for which the new billing group is defined. If not present, the billing group is not dedicated to a specific title. The title code specified must exist in the TitleDetails table.
  • billingGroupStatus - this field contains a code indicating the status of the billing group. The following values are possible:
    • "ACTIVE" – the billing group is active and in use.
    • "INACTIVE" – the billing group is inactive and is not in use. 
  • notifyMethod - this field contains the notification method assigned to the account. All communication is delivered to the customer using this method. The following values are possible:
    • "TEXT" - communication is sent as a text email
    • "HTML" - communication is sent as an html formatted email. 
    • "PDF" - communication is sent as text emails with PDF attachments
    • "XML" - communication is not sent directly but is output as an XML structure which can be processed by another solution. This code is used if an invoice, receipts, dunning notices, etc. are sent to the customer via normal mail. 
  • paymentOption - contains a code indicating whether payment terms or payment methods are used for this billing group. The following codes are supported:
    • "TERMS" – the billing group has payment terms assigned, for example BANKGIRO, AVTALEGIRO, etc. The payment terms are found in the paymentTermInfo structure.
    • "METHODS" – the billing group has payment methods assigned, for example credit cards managed by Aria. The payment methods are found in the paymentMethodInfo structure. 
  • paymentTermInfo – a structure holding information on the payment terms defined for the billing group. Is present only if paymentOption contains "TERMS". 
    • paymentTerms - contains a code indicating the initial payment method chosen by the customer or defaulted by the caller. The following codes are supported:
      • "BANKGIRO" – the default method where the customer must use a traditional bank transfer to pay the bills. 
      • "EHF" – a method allowing the customer to pay via electronic invoicing, provided the EAN and EAN requisition number has been provided. Used primarily for public and government companies. 
      • "CREDITCARD" – a method indicating that the customer is using the Credit card payment option. 
      • "AVTALEGIRO" – a method indicating that the customer is using the AvtaleGiro payment option. 
      • "EFAKTURA" – a method indicating that the customer is using the eFaktura payment option. 
      • "EFAKTURA/AVTALEGIRO" – a method indicating that the customer is using the eFaktura/Avtalegiro payment option. 
      • "VIPPS" – a method indicating that the customer is using VIPPS as the payment option. 
    • paymentEANNum – if paymentTerms contain "EHF" then this field must contain the identification of the customer with the EHF system. The number should be obtained from the customer. For other payment terms the field is not used. 
    • paymentEANRequisitionNum – if paymentTerms contain "EHF", then this field must contain the requisition number provided by the customer. Is used by the customer to correctly place the invoice when it is received. 
  • paymentMethodInfo – a structure holding information on the payment methods defined for the billing group. Is present only if paymentOption contains "METHODS". 
    • primaryPaymentMethodID - this field contains the identification of the primary payment method (credit card) to be assigned to this billing group. The field references one of the payment methods returned by another API call. If empty, the payment method will be added later. 
    • backupPaymentMethodID - this field contains the identification of the backup payment method (credit card) assigned to this billing group. The field references one of the payment methods returned by another API call. If empty, the payment method will be added later. 
  • payOptionInfo - a new optional attribute holding the details on the payment options / variants to apply for the new account.
    • payOptionID - contains the identification of the payment option to be assigned to the billing group. Only payment options that are allowed for existing billing groups can be used, for example "BANKGIRO" or "EHF"
    • payOptionVariant - contains the identification of the payment option variant to be assigned to the billing group created. Is selected by the customer based on the choices presented.
    • paymentEANNum - contains additional information used for some payment options.
    • paymentEANRequisitionNum - contains additional information used for some payment options.
  • requestSourceID – a new optional attribute holding a code indicating the source of the request. The following options apply:
    • "WEB" – the payment option can be used to create new accounts and/or billing groups from the WEB only. This is the default value. 
    • "CSR" – the payment option can be used to create new accounts and/or billing groups from the CSR platform only.
       
  • statementContactNo - the field contains the Aria generated identification of the statement contact defined for another billing group and which must be reused for the new billing group. If not present, the statementContactDetails structure holds the detail of contact information for the new billing group. 
  • statementContactDetails – the structure contains the detail of the statement contact information. 
    • firstName - contains the first name of the customer. If not available, leave blank. 
    • middleInitials - contains the middle initials of the customer. if not available, leave blank.
    • lastName - contains the last name (given name) of the customer. If not available, leave blank.
    • fullName - contains the full name of the customer or it contains the company name of the customer. Must be present. 
    • addressLine1 - contains the first line of the customer’s address. If not present, leave blank. 
    • addressLine2 - contains the second line of the customer’s address. If not present, leave blank. If present, addressLine1 must also be present. 
    • addressLine3 - contains the third line of the customer’s address. If not present, leave blank. If present, addressLine2 must also be present. 
    • postalCode - contains the postal code of the customer’s address. If not present, leave blank.
    • postalCity - contains the postal city of the customer’s address. If not present, leave blank.
    • addrLocality – contains the locality of the current address.
    • addrStateProv – for addresses in the United States (US), Australia (AU) and Canada (CA) this field contains the code identifying the state or province.
    • streetName – if present, this field contains only the name of the street. Numbers, floors, etc. are not included. 
    • streetNo – if present, this field contains only the street number and no other part of the address.
    • flatNo – if present, this field contains the number of the flat. 
    • flatSpec – if present, this field contains the specification of the flat, for example left, right, center, etc. 
    • flatFloor – if present, this field contains the floor where the flat is found.
    • entranceNo – if present, this field contains the number of the entrance to the flat.
    • homePhone - contains the home phone number of the customer. If not present, leave blank.
    • cellPhone - contains the cell phone number of the customer. If not present, leave blank.
    • workPhone - contains the work phone number of the customer. If not present, leave blank.
    • emailAddress - contains the email address associated with the customer. Must contain a valid email address.

The individual data elements of acctManageBillingGroupDetailsMODIFY are defined as follows:

  • titleCode - an optional attribute specifying the title code for which the new billing group is defined. If not present, the billing group is not dedicated to a specific title. The title code must exist in the TitleDetails table.
  • ariaBillingGroupID - the field contains the solution generated unique identification of the billing group to modify. Will be used in subsequent API calls, so it must be stored for later use. 
  • ariaBillingGroupNo - on return, the field contains the solution generated unique identification of the billing group to modify. Will be used in subsequent API calls, so it must be stored for later use. 
  • billingGroupName - this field contains the solution generated name of the billing group. 
  • billingGroupDesc - this field contains a brief description of the billing group. 
  • billingGroupStatus - this field contains a code indicating the status of the billing group. The following values are possible:
    • "ACTIVE" – the billing group is active and in use.
    • "INACTIVE" – the billing group is inactive and is not in use. 
  • notifyMethod - this field contains the notification method assigned to the account. All communication is delivered to the customer using this method. The following values are possible:
    • "TEXT" - communication is sent as a text email.
    • "HTML" - communication is sent as an html formatted email. 
    • "PDF" - communication is sent as text emails with PDF attachments.
    • "XML" - communication is not sent directly but is output as an XML structure which can be processed by another solution. This code is used if an invoice, receipts, dunning notices, etc. are sent to the customer via normal mail. 
  • paymentOption - contains a code indicating whether payment terms or payment methods are used for this billing group. The following codes are supported:
    • "TERMS" – the billing group has payment terms assigned, for example BANKGIRO, AVTALEGIRO, etc. The payment terms are found in the paymentTermInfo structure.
    • "METHODS" – the billing group has payment methods assigned, for example credit cards managed by Aria. The payment methods are found in the paymentMethodInfo structure. 
  • paymentTermInfo – a structure holding information on the payment terms defined for the billing group. Is present only if paymentOption contains "TERMS". 
    • paymentTerms - contains a code indicating the initial payment method chosen by the customer or defaulted by the caller. The following codes are supported:
      • "BANKGIRO" – the default method where the customer must use a traditional bank transfer to pay the bills. "EHF" – a method allowing the customer to pay via electronic invoicing, provided the EAN and EAN requisition number has been provided. Used primarily for public and government companies. 
      • "CREDITCARD" – a method indicating that the customer is using the Credit card payment option. 
      • "AVTALEGIRO" – a method indicating that the customer is using the AvtaleGiro payment option. 
      • "EFAKTURA" – a method indicating that the customer is using the eFaktura payment option. 
      • "EFAKTURA/AVTALEGIRO" – a method indicating that the customer is using the eFaktura/Avtalegiro payment option. 
      • "VIPPS" – a method indicating that the customer is using VIPPS as the payment option. 
    • paymentTermID – contains the client defined identifier of the current payment term. This attribute identifies a variant of the terms given in paymentTerms, each having specific characteristics. May be overridden depending on the value provided in paymentTerms.
    • paymentEANNum – if paymentTerms contain "EHF" then this field contains the identification of the customer with the EHF system. The number should be obtained from the customer. For other payment terms the field is not used. 
    • paymentEANRequisitionNum – if paymentTerms contain "EHF", then this field contains the requisition number provided by the customer. Is used by the customer to correctly place the invoice when it is received. 
  • paymentMethodInfo – a structure holding information on the payment methods defined for the billing group. Is present only if paymentOption contains "METHODS". 
    • primaryPaymentMethodID - this field contains the identification of the primary payment method (credit card) to be assigned to this billing group. The field references one of the payment methods returned by another API call. If empty, the payment method will be added later. 
    • backupPaymentMethodID - this field contains the identification of the backup payment method (credit card) assigned to this billing group. The field references one of the payment methods returned by another API call. If empty, the payment method will be added later. 
  • payOptionInfo - a new optional attribute holding the details on the payment options / variants to apply for the new account.
    • payOptionID - contains the identification of the payment option to be assigned to the billing group. Only payment options that are allowed for existing billing groups can be used, for example "BANKGIRO" or "EHF"
    • payOptionVariant - contains the identification of the payment option variant to be assigned to the billing group created. Is selected by the customer based on the choices presented.
    • paymentEANNum - contains additional information used for some payment options.
    • paymentEANRequisitionNum - contains additional information used for some payment options.
  • requestSourceID – a new optional attribute holding a code indicating the source of the request. The following options apply:
    • "WEB" – the payment option can be used to create new accounts and/or billing groups from the WEB only. This is the default value. 
    • "CSR" – the payment option can be used to create new accounts and/or billing groups from the CSR platform only.
  • statementContactNo - the field contains the Aria generated identification of the statement contact defined for another billing group and which must be reused for the new billing group. If not present, the statementContactDetails structure holds the detail of contact information for the new billing group. 
  • statementContactDetails – on return, the structure contains the detail of the statement contact information. 
    • firstName - contains the first name of the customer. If not available, leave blank. 
    • middleInitials - contains the middle initials of the customer. if not available, leave blank.
    • lastName - contains the last name (given name) of the customer. If not available, leave blank.
    • fullName - contains the full name of the customer or it contains the company name of the customer. Must be present. 
    • addressLine1 - contains the first line of the customer’s address. If not present, leave blank. 
    • addressLine2 - contains the second line of the customer’s address. If not present, leave blank. If present, addressLine1 must also be present. 
    • addressLine3 - contains the third line of the customer’s address. If not present, leave blank. If present, addressLine2 must also be present. 
    • postalCode - contains the postal code of the customer’s address. If not present, leave blank.
    • postalCity - contains the postal city of the customer’s address. If not present, leave blank.
    • addrLocality – contains the locality of the current address.
    • addrStateProv – for addresses in the United States (US), Australia (AU) and Canada (CA) this field contains the code identifying the state or province.
    • streetName – if present, this field contains only the name of the street. Numbers, floors, etc. are not included. 
    • streetNo – if present, this field contains only the street number and no other part of the address.
    • flatNo – if present, this field contains the number of the flat.
    • flatSpec – if present, this field contains the specification of the flat, for example left, right, center, etc. 
    • flatFloor – if present, this field contains the floor where the flat is found.
    • entranceNo – if present, this field contains the number of the entrance to the flat
    • homePhone - contains the home phone number of the customer. If not present, leave blank
    • cellPhone - contains the cell phone number of the customer. If not present, leave blank
    • workPhone - contains the work phone number of the customer. If not present, leave blank
    • mailAddress - contains the email address associated with the customer. Must contain a valid email address. 
  • ariaDunningGroupID - the field contains the solution generated unique identification of the dunning group to modify. 
  • ariaDunningGroupNo – on return, the field contains the Aria generated unique identification of the dunning group to modify. 
  • dunningGroupName - this field contains the solution generated name of the dunning group. May be overridden by the solution depending on what is modified.
  • dunningGroupDesc - this field contains a brief description of the dunning group. May be overridden by the solution depending on what is modified.
  • dunningProcessID - this field contains the unique identification of the dunning process to be used for subscriptions under this account.  May be overridden by the solution depending on what is modified.

The individual data elements of acctManageBillingGroupDetailsREMOVE are defined as follows:

  • ariaBillingGroupID - the field contains the solution generated unique identification of the billing group to remove. Will be used in subsequent API calls, so it must be stored for later use. 
  • ariaBillingGroupNo - on return, the field contains the solution generated unique identification of the billing group to remove. Will be used in subsequent API calls, so it must be stored for later use. 
  • ariaDunningGroupID - the field contains the solution generated unique identification of the dunning group to remove. 
  • ariaDunningGroupNo – on return, the field contains the Aria generated unique identification of the dunning group to remove. 

AcctManageBillingGroupResponse

The AcctManageBillingGroupResponse message is a JSON formatted message used to return billing group and dunning group information for a given account. One entry is returned for each action given in the request. The following samples are provided: 

Sample 1); Shows the result of adding a new billing and dunning group.

Sample 1

{
    "resultInfo": {
        "resultCode": 1,
        "resultText": "a"
    },
    "acctManageBillingGroupResponseDetails": [
        {
            "actionDirective": "ADD",
            "ariaAccountID": "ACCT1-ID",
            "ariaAccountNo": 12345,
            "actionResultInfo": {
                "resultCode": 0, 
                "resultText": "OK"
            },
            "billingGroupResponseINFO": {
                "ariaBillingGroupID": "BG-502b4dee-ff35-44be-bff6-282d416f2e57",
                "ariaBillingGroupNo": 11223345,
                "billingGroupName": "Bankgiro",
                "billingGroupDesc": "Bankgiro",
                "billingGroupStatus": "ACTIVE", 
                "notifyMethod": "PDF",
                "paymentOption": "METHODS",
                "payOptionInfo": {
                    "payOptionID": "BANKGIRO-01",
                    "payOptionVariant": "STANDARD",
                    "paymentEANNum": "",
                    "paymentEANRequisitionNum": ""
                },
                "statementContactNo": 11223344,
                "statementContactDetails": {
                    "firstName": "Niels Kristian",
                    "middleInitials": "",
                    "lastName": "Nielsen",
                    "fullName": "Niels Kristian Nielsen",
                    "addressLine1": "Akersgt. 34",
                    "addressLine2": "",
                    "addressLine3": "",
                    "countryCode": "NO",
                    "postalCode": "0444",
                    "postalCity": "Oslo",
                    "addrLocality": "",
                    "addrStateProv": "",
                    "streetName": "",
                    "streetNo": "",
                    "flatNo": "",
                    "flatSpec": "",
                    "flatFloor": "",
                    "entranceNo": "",
                    "homePhone": "",
                    "cellPhone": "+4422334466",
                    "workPhone": "",
                    "emailAddress": "myemail@mydomain.com"
                },
                "ariaDunningGroupID": "DG-502b4dee-ff35-44be-bff6-282d416f2e57",
                "ariaDunningGroupNo": 11223345,
                "dunningGroupName": "DEFAULT",
                "dunningGroupDesc": "DEFAULT",
                "dunningProcessID": "AM-DEFAULT"
            }
        }
    ]
}
 

The individual data elements of the resultInfo structure are defined as follows:

  • resultCode - contains a code indicating the outcome of the operation. 0 indicates success; any other code indicates a failure. 
  • resultText - If success is returned, this element contains "OK". If a failure occurred, the element contains a description of the problem.

The individual data elements of the acctManageBillingGroupResponseDetails array (one entry is provided per action given in the call) are defined as follows:

  • actionDirective – contains a code indicate the action to take on the account provided. The following codes are supported:
    • "ADD" – used to add a new billing and dunning group.
    • "MODIFY" – used to modify the general information on an existing billing and dunning group.
    • "REMOVE" – used to remove a billing and dunning group. 
  • actionResultInfo – a structure defining the result of the individual operations executed by the service. 
    • resultCode - contains a code indicating the outcome of the specific operation. 0 indicates success; any other code indicates a failure. 
    • resultText - If success is returned, this element contains "OK". If a failure occurred, the element contains a description of the problem. 
  • ariaAccountID - contains the client defined identification of the new account. Is identical to the value passed in the request. 
  • ariaAccountNo - on return, the field contains the Aria generated unique account identifier. This identifier must be stored for later used in other API calls. 
  • billingGroupResponseINFO – on return, this structure contains the details on the billing and dunning group the action was performed on. 

The individual data elements of acctManageBillingGroupDetailsINFO are defined as follows:

  • titleDetails - a reference to the acctManageBillingGroupTitleInfo structure defined above. The structure is optional and is returned only if the billing group is related to a specific title.
  • ariaBillingGroupID - the field contains the solution generated unique identification of the billing group. Will be used in subsequent API calls, so it must be stored for later use. 
  • ariaBillingGroupNo - on return, the field contains the solution generated unique identification of the billing group. Will be used in subsequent API calls, so it must be stored for later use. 
  • billingGroupName - this field contains the solution generated name of the billing group. 
  • billingGroupDesc - this field contains a brief description of the billing group. 
  • billingGroupStatus - this field contains a code indicating the status of the billing group. The following values are possible:
    • "ACTIVE" – the billing group is active and in use.
    • "INACTIVE" – the billing group is inactive and is not in use. 
  • notifyMethod - this field contains the notification method assigned to the account. All communication is delivered to the customer using this method. The following values are possible:
    • "TEXT" - communication is sent as a text email.
    • "HTML" - communication is sent as an html formatted email. 
    • "PDF" - communication is sent as text emails with PDF attachments.
    • "XML" - communication is not sent directly but is output as an XML structure which can be processed by another solution. This code is used if an invoice, receipts, dunning notices, etc. are sent to the customer via normal mail. 
  • paymentOption - contains a code indicating whether payment terms or payment methods are used for this billing group. The following codes are supported:
    • "TERMS" – the billing group has payment terms assigned, for example BANKGIRO, AVTALEGIRO, etc. The payment terms are found in the paymentTermInfo structure.
    • "METHODS" – the billing group has payment methods assigned, for example credit cards managed by Aria. The payment methods are found in the paymentMethodInfo structure. 
  • paymentTermInfo – a structure holding information on the payment terms defined for the billing group. Is present only if paymentOption contains "TERMS". 
    • paymentTerms - contains a code indicating the initial payment method chosen by the customer or defaulted by the caller. The following codes are supported:
      • "BANKGIRO" – the default method where the customer must use a traditional bank transfer to pay the bills. 
      • "EHF" – a method allowing the customer to pay via electronic invoicing, provided the EAN and EAN requisition number has been provided. Used primarily for public and government companies. 
      • "CREDITCARD" – a method indicating that the customer is using the Credit card payment option. 
      • "AVTALEGIRO" – a method indicating that the customer is using the AvtaleGiro payment option. 
      • "EFAKTURA" – a method indicating that the customer is using the eFaktura payment option. 
      • "EFAKTURA/AVTALEGIRO" – a method indicating that the customer is using the eFaktura/Avtalegiro payment option. 
      • "VIPPS" – a method indicating that the customer is using VIPPS as the payment option. 
    • paymentTermID – contains the client defined identifier of the current payment term. This attribute identifies a variant of the terms given in paymentTerms, each having specific characteristics.
    • paymentEANNum – if paymentTerms contain "EHF" then this field contains the identification of the customer with the EHF system. 
    • paymentEANRequisitionNum – if paymentTerms contain "EHF", then this field contains the requisition number provided by the customer. 
  • paymentMethodInfo – a structure holding information on the payment methods defined for the billing group. Is present only if paymentOption contains "METHODS". 
    • primaryPaymentMethodID - this field contains the identification of the primary payment method (credit card) to be assigned to this billing group. 
    • backupPaymentMethodID - this field contains the identification of the backup payment method (credit card) assigned to this billing group. 
  • payOptionInfo - a new optional attribute holding the details on the payment options / variants to apply for the new account.
    • payOptionID - contains the identification of the payment option to be assigned to the billing group. Only payment options that are allowed for existing billing groups can be used, for example "BANKGIRO" or "EHF"
    • payOptionVariant - contains the identification of the payment option variant to be assigned to the billing group created. Is selected by the customer based on the choices presented.
    • paymentEANNum - contains additional information used for some payment options.
    • paymentEANRequisitionNum - contains additional information used for some payment options.
  • requestSourceID – a new optional attribute holding a code indicating the source of the request. The following options apply:
    • "WEB" – the payment option can be used to create new accounts and/or billing groups from the WEB only. This is the default value. 
    • "CSR" – the payment option can be used to create new accounts and/or billing groups from the CSR platform only. 
  • statementContactNo - the field contains the Aria generated identification of the statement contact defined for billing group. 
  • statementContactDetails – on return, the structure contains the detail of the statement contact information. 
    • firstName - contains the first name of the customer. If not available, leave blank. 
    • middleInitials - contains the middle initials of the customer. if not available, leave blank.
    • lastName - contains the last name (given name) of the customer. If not available, leave blank.
    • fullName - contains the full name of the customer or it contains the company name of the customer. Must be present. 
    • addressLine1 - contains the first line of the customer’s address. If not present, leave blank. 
    • addressLine2 - contains the second line of the customer’s address. If not present, leave blank. If present, addressLine1 must also be present. 
    • addressLine3 - contains the third line of the customer’s address. If not present, leave blank. If present, addressLine2 must also be present. 
    • postalCode - contains the postal code of the customer’s address. If not present, leave blank.
    • postalCity - contains the postal city of the customer’s address. If not present, leave blank.
    • addrLocality – contains the locality of the current address.
    • addrStateProv – for addresses in the United States (US), Australia (AU) and Canada (CA) this field contains the code identifying the state or province.
    • streetName – if present, this field contains only the name of the street. Numbers, floors, etc. are not included. 
    • streetNo – if present, this field contains only the street number and no other part of the address.
    • flatNo – if present, this field contains the number of the flat.
    • flatSpec – if present, this field contains the specification of the flat, for example left, right, center, etc. 
    • flatFloor – if present, this field contains the floor where the flat is found.
    • entranceNo – if present, this field contains the number of the entrance to the flat.
    • homePhone - contains the home phone number of the customer. If not present, leave blank.
    • cellPhone - contains the cell phone number of the customer. If not present, leave blank.
    • workPhone - contains the work phone number of the customer. If not present, leave blank.
    • emailAddress - contains the email address associated with the customer. Must contain a valid email address. 
  • ariaDunningGroupID - the field contains the solution generated unique identification of the dunning group. 
  • ariaDunningGroupNo – on return, the field contains the Aria generated unique identification of the dunning group. 
  • dunningGroupName - this field contains the solution generated name of the dunning group.
  • dunningGroupDesc - this field contains a brief description of the dunning group. 
  • dunningProcessID - this field contains the unique identification of the dunning process to be used for subscriptions under this account.

The attribute structure acctManageBillingGroupTitleInfo structure are defined as follows:

  • acctManageBillingGroupTitleInfo – the overall structure holding the title details.
    • titleCode – contains the unique identification of the title being returned.
    • titleName – contains the name of the title being returned.
    • titleDesc – contains the full description of the title being returned. 
    • titleNameTranslations – contains the translations for the title name for each locale defined.
    • titleDescTranslations – contains the translations for the title description for each locale defined.
    • titleDomain – contains the title domain (URL) associated with the current title. 
       

Retrieve Billing Group (JSON API)

Endpoint

This API can be called by making a POST call to the URL:
https://[clienthost]/PostDataToFlow/ARIAMediaSuite/AccountManagement/AcctRetrieveBillingGroup

AcctRetrieveBillingGroupRequest

The AcctRetrieveBillingGroupRequest message is a JSON formatted message used by the calling system to retrieve all billing groups defined for a single account. The identification of the account must be provided in the request. Below several examples are given, namely:

  • Sample 1); Searching for customers having a specific account id (AID ID)
  • Sample 2); Searching for customers having a specific account number (Aria Account Number)

Sample 1
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctRetrieveBillingGroupCriteria": {
        "ariaAccountID": "ACCT1-ID",
        "ariaAccountNo": null, 
        "titleFiltering": [
            {
                "titleCode": "",
                "titleDomain": "www.tangotidene.no"
            }
        }
    }
}

Sample 2
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctSearchAccountCriteria": {
        "ariaAccountID": null,
        "ariaAccountNo": 12345,
        "titleFiltering": [
            {
                "titleCode": "",
                "titleDomain": "www.tangotidene.no"
            },
            {
                "titleCode": "RB",
                "titleDomain": ""
            },
        }
    }
}

The individual data elements of msgAuthDetails are defined as follows:

  • clientNo - contains the Aria specific identification of the instance in which the solution currently operates. Varies from test to production. This value is required in all API calls to Aria to authenticate the caller. 
  • authKey - contains the Aria specified authentication key. This key is required in all API calls to Aria to authenticate the caller.  
  • requestDateTime - contains the date and time when the message was built. 
  • signatureValue -  contains the signature value calculated by the sending solution. Using the private key the receiving solution will validate the information retrieved, and if no match is found, the call will fail. 
  • ariaAccountID - contains the defined identification of the customer account, for example a number from a CRM system or other customer master.  Used for the signature value calculation.
  • ariaAccountNo - contains the Aria generated identification of the account. Will always be zero as the account has not been created yet. 

The individual data elements of acctRetrieveBillingGroupCriteria are defined as follows:

  • ariaAccountID – holds the defined identification of the customer account, for example the AID ID. If not present, the ariaAccountNo must contain an account number. If both ariaAccountID and ariaAccountNo is provided, the ariaAccountID will take precedence.
  • ariaAccountNo – holds the Aria generated identification of the account. If used only a single account will be returned. If not present, the ariaAccountID must contain an account identification. 

The individual data elements of titleFiltering are defined as follows, and the structure can hold multiple entries:

  • titleCode – holds the Title Code of the Title belonging to billing group which needs to be retrieved. It can be Null/Blank
  • titleDomain – holds the Title Domain of the Title belonging to the billing group which needs to be retrieved. It can be Null/Blank.

AcctRetrieveBillingGroupResponse

The AcctRetrieveBillingGroupResponse message is a JSON formatted message used to return billing group and payment method details for a given account. At least one billing group will be returned. The list of payment methods is optional as the payment term in some situations are defined by the billing group itself. The following samples are provided:

•    Sample 1); Shows two billing groups returned; one with a BANKGIRO as the payment method; the other with a credit card as payment method. 

Sample 1

{
    "resultInfo": {
        "resultCode": 1,
        "resultText": "a"
    },
    "acctRetrieveBillingGroupResponseDetails": {
        "ariaAccountID": "ACCT1-ID",
        "ariaAccountNo": 12345,
        "acctRetrieveBillingGroupList": [{
                "ariaBillingGroupID": "BG-502b4dee-ff35-44be-bff6-282d416f2e57",
                "ariaBillingGroupNo": 11223345,
                "billingGroupName": "Bankgiro",
                "billingGroupDesc": "Bankgiro",
                "billingGroupStatus": "ACTIVE",
                "notifyMethod": "PDF",
                "titleDetails": {
                    "titleCode": "test",
                    "titleName": "titlename test",
                    "titleDesc": "titleDesc",
                    "titleNameTranslations": {},
                    "titleDescTranslations": {},
                    "titleDomain": "www"
                },
                "paymentOption": "TERMS",
                "paymentTermInfo": {
                    "paymentTerms": "BANKGIRO",
                    "paymentTermID": "BANKGIRO-01",
                    "paymentEANNum": "",
                    "paymentEANRequisitionNum": ""
                },
                "statementContactNo": 11223344,
                "statementContactDetails": {
                    "firstName": "Niels Kristian",
                    "middleInitials": "",
                    "lastName": "Nielsen",
                    "fullName": "Niels Kristian Nielsen",
                    "addressLine1": "Akersgt. 34",
                    "addressLine2": "",
                    "addressLine3": "",
                    "countryCode": "NO",
                    "postalCode": "0444",
                    "postalCity": "Oslo",
                    "addrLocality": "",
                    "addrStateProv": "",
                    "streetName": "",
                    "streetNo": "",
                    "flatNo": "",
                    "flatSpec": "",
                    "flatFloor": "",
                    "entranceNo": "",
                    "homePhone": "",
                    "cellPhone": "+4422334466",
                    "workPhone": "",
                    "emailAddress": "myemail@mydomain.com"
                },
                "ariaDunningGroupID": "DG-502b4dee-ff35-44be-bff6-282d416f2e57",
                "ariaDunningGroupNo": 11223345,
                "dunningGroupName": "DEFAULT",
                "dunningGroupDesc": "DEFAULT",
                "dunningProcessID": "AM-DEFAULT"
            },
            {
                "ariaBillingGroupID": "BG-502b4dee-ff35-44be-bff6-282d416f2e58",
                "ariaBillingGroupNo": 11223346,
                "billingGroupName": "KREDITTKORT",
                "billingGroupDesc": "KREDITTKORT",
                "billingGroupStatus": "ACTIVE",
                "notifyMethod": "PDF",
                "titleDetails": {
                    "titleCode": "test",
                    "titleName": "titlename test",
                    "titleDesc": "titleDesc",
                    "titleNameTranslations": {},
                    "titleDescTranslations": {},
                    "titleDomain": "www"
                },
                "paymentOption": "METHODS",
                "paymentMethodInfo": {
                    "primaryPaymentMethodID": "PM-502b4dee-ff35-44be-bff6-282d416f2e57",
                    "backupPaymentMethodID": ""
                },
                "payOptionInfo": {
                    "payOptionID": "BANKGIRO-01",
                    "payOptionVariant": "STANDARD",
                    "paymentOptionEANNum": "",
                    "paymentOptionEANRequisitionNum": "",
                    "payOptionName": "BANKGIRO",
                    "payOptionNameTranslations": [{
                        "solmRefTransNo": "3249",
                        "solmTranslationEntry": [{
                                "localeID": "NO-BOKMAL",
                                "objectName": "Drammens Tidende"
                            },
                            {
                                "localeID": "NO-BOKMAL-A-ENDING",
                                "objectName": "Drammens Tidende"
                            },
                            {
                                "localeID": "NO-NYNORSK",
                                "objectName": "Drammens Tidende"
                            }

                        ]
                    }],
                    "payOptionDesc": "Bankgiro",
                    "payOptionDescTranslations": [{
                        "solmRefTransNo": "3248",
                        "solmTranslationEntry": [{
                                "localeID": "NO-BOKMAL",
                                "objectName": "Drammens Tidende"
                            },
                            {
                                "localeID": "NO-BOKMAL-A-ENDING",
                                "objectName": "Drammens Tidende"
                            },
                            {
                                "localeID": "NO-NYNORSK",
                                "objectName": "Drammens Tidende"
                            }

                        ]
                    }],
                    "payOptionVariantName": "STANDARD",
                    "payOptionVariantNameTranslations": [{
                        "solmRefTransNo": "3244",
                        "solmTranslationEntry": [{
                                "localeID": "NO-BOKMAL",
                                "objectName": "Drammens Tidende"
                            },
                            {
                                "localeID": "NO-BOKMAL-A-ENDING",
                                "objectName": "Drammens Tidende"
                            },
                            {
                                "localeID": "NO-NYNORSK",
                                "objectName": "Drammens Tidende"
                            }
                        ]
                    }],
                    "payOptionVariantDesc": "Standard",
                    "payOptionVariantDescTranslations": [{
                        "solmRefTransNo": "3243",
                        "solmTranslationEntry": [{
                                "localeID": "NO-BOKMAL",
                                "objectName": "Drammens Tidende"
                            },
                            {
                                "localeID": "NO-BOKMAL-A-ENDING",
                                "objectName": "Drammens Tidende"
                            },
                            {
                                "localeID": "NO-NYNORSK",
                                "objectName": "Drammens Tidende"
                            }
                        ]
                    }]
                },
                "statementContactNo": 11223344,
                "statementContactDetails": {
                    "firstName": "Niels Kristian",
                    "middleInitials": "",
                    "lastName": "Nielsen",
                    "fullName": "Niels Kristian Nielsen",
                    "addressLine1": "Akersgt. 34",
                    "addressLine2": "",
                    "addressLine3": "",
                    "countryCode": "NO",
                    "postalCode": "0444",
                    "postalCity": "Oslo",
                    "addrLocality": "",
                    "addrStateProv": "",
                    "streetName": "",
                    "streetNo": "",
                    "flatNo": "",
                    "flatSpec": "",
                    "flatFloor": "",
                    "entranceNo": "",
                    "homePhone": "",
                    "cellPhone": "+4422334466",
                    "workPhone": "",
                    "emailAddress": "myemail@mydomain.com"
                },
                "ariaDunningGroupID": "DG-502b4dee-ff35-44be-bff6-282d416f2e57",
                "ariaDunningGroupNo": 11223345,
                "dunningGroupName": "DEFAULT",
                "dunningGroupDesc": "DEFAULT",
                "dunningProcessID": "AM-DEFAULT"
            }
        ],
        "acctRetrieveBillingGroupPayMethodList": [{
            "ariaPaymentMethodID": "PM-502b4dee-ff35-44be-bff6-282d416f2e57",
            "ariaPaymentMethodNo": 1,
            "payMethodType": "CC",
            "creditCardMasked": "**** **** **** 1234",
            "creditCardType": "VISA",
            "creditCardExpMonth": "12",
            "creditCardExpYear": "2020",
            "billContactNo": 11223377,
            "billContactDetails": {
                "firstName": "Niels Kristian",
                "middleInitials": "",
                "lastName": "Nielsen",
                "fullName": "Niels Kristian Nielsen",
                "addressLine1": "Akersgt. 34",
                "addressLine2": "",
                "addressLine3": "",
                "countryCode": "NO",
                "postalCode": "0444",
                "postalCity": "Oslo",
                "addrLocality": "",
                "addrStateProv": "",
                "streetName": "",
                "streetNo": "",
                "flatNo": "",
                "flatSpec": "",
                "flatFloor": "",
                "entranceNo": "",
                "homePhone": "",
                "cellPhone": "+4422334466",
                "workPhone": "",
                "emailAddress": "myemail@mydomain.com"
            }
        }]
    }
}

The individual data elements of the resultInfo structure are defined as follows:

  • resultCode - contains a code indicating the outcome of the operation. 0 indicates success; any other code indicates a failure. 
  • resultText - If success is returned, this element contains "OK". If a failure occurred, the element contains a description of the problem. 

The individual data elements of the acctRetrieveBillingGroupResponseDetails structure are defined as follows:

  • ariaAccountID - contains the client defined identification of the new account. Is identical to the value passed in the request. 
  • ariaAccountNo - on return, the field contains the Aria generated unique account identifier. This identifier must be stored for later use in other API calls. 
  • acctRetrieveBillingGroupList - on return, this array contains the list of billing groups defined for the given account. At least one entry is returned. The attributes defined in this structure is found later in this section. 
  • acctRetrieveBillingGroupPayMethodList – on return, this array contains the list of payment methods defined for the current account. The array may be omitted if no payment methods are defined. The active payment method is referenced from within the acctRetrieveBillingGroupList entries. The attributes defined in this structure is found later in this section.

The response will contain at least one entry in the acctRetrieveBillingGroupList array. Each entry contains the following attributes:

  • titleDetails - a reference to the acctRetrieveBillingGroupTitleInfo structure defined above. The structure is optional and is returned only if the billing group is related to a specific title.
  • ariaBillingGroupID - on return, the field contains the solution generated unique identification of the billing group. Will be used in subsequent API calls, so it must be stored for later use. 
  • ariaBillingGroupNo - on return, the field contains the solution generated unique identification of the billing group. Will be used in subsequent API calls, so it must be stored for later use. 
  • billingGroupName - on return, this field contains the solution generated name of the billing group. 
  • billingGroupDesc - on return, this field contains a brief description of the billing group. 
  • billingGroupStatus - on return, this field contains a code indicating the status of the billing group. The following values are possible:
    • "ACTIVE" – the billing group is active and in use.
    • "INACTIVE" – the billing group is inactive and is not in use. 
  • notifyMethod - on return, this field contains the notification method assigned to the account. All communication is delivered to the customer using this method. The following values are possible:
    • "TEXT" - communication is sent as a text email
    • "HTML" - communication is sent as an html formatted email. 
    • "PDF" - communication is sent as text emails with PDF attachments
    • "XML" - communication is not sent directly but is output as an XML structure which can be processed by another solution. This code is used if a invoices, receipts, dunning notices, etc. are sent to the customer via normal mail. 
  • paymentOption - contains a code indicating whether payment terms or payment methods are used for this billing group. The following codes are supported:
    • "TERMS" – the billing group has payment terms assigned, for example BANKGIRO, AVTALEGIRO, etc. The payment terms are found in the paymentTermInfo structure.
    • "METHODS" – the billing group has payment methods assigned, for example credit cards managed by Aria. The payment methods are found in the paymentMethodInfo structure. 
  • paymentTermInfo – a structure holding information on the payment terms defined for the billing group. Is present only if paymentOption contains "TERMS". 
    • paymentTerms - contains a code indicating the initial payment method chosen by the customer or defaulted by the caller. The following codes are supported:
      • "BANKGIRO" – the default method where the customer must use a traditional bank transfer to pay the bills. 
      • "EHF" – a method allowing the customer to pay via electronic invoicing, provided the EAN and EAN requisition number has been provided. Used primarily for public and government companies. 
      • "CREDITCARD" – a method indicating that the customer is using the Credit card payment option. 
      • "AVTALEGIRO" – a method indicating that the customer is using the AvtaleGiro payment option. 
      • "EFAKTURA" – a method indicating that the customer is using the eFaktura payment option. 
      • "EFAKTURA/AVTALEGIRO" – a method indicating that the customer is using the eFaktura/Avtalegiro payment option. 
      • "VIPPS" – a method indicating that the customer is using VIPPS as the payment option. 
    • paymentTermID – contains the client defined identifier of the current payment term. This attribute identifies a variant of the terms given in paymentTerms, each having specific characteristics. 
    • paymentEANNum – if paymentTerms contain "EHF" then this field must contain the identification of the customer with the EHF system. The number should be obtained from the customer. For other payment terms the field is not used. 
    • paymentEANRequisitionNum – if paymentTerms contain "EHF", then this field must contain the requisition number provided by the customer. Is used by the customer to correctly place the invoice when it is received. 
  • paymentMethodInfo – a structure holding information on the payment methods defined for the billing group. Is present only if paymentOption contains "METHODS". 
    • primaryPaymentMethodID - on return, this field contains the identification of the primary payment method assigned to this billing group. The field references one of the payment methods (identified by attribute ariaPaymentMethodID) defined in the acctRetrieveBillingGroupPayMethodList structure. One payment method may be referenced from several billing groups.  
    • backupPaymentMethodID - on return, this field contains the identification of the backup payment method assigned to this billing group. The field references one of the payment methods (identified by attribute ariaPaymentMethodID) defined in the acctRetrieveBillingGroupPayMethodList structure. One payment method may be referenced from several billing groups.  
  • payoptioninfo - a structure holding the general information on the payment option to be managed.
    • payOptionID- contains the identification of the payment option assigned to the billing group.
    • payOptionVariant - contains the identification of the payment option variant assigned to the billing group.
    • paymentEANNum - contains additional information used for some payment options.
    • paymentEANRequisitionNum - contains additional information used for some payment options.
    • payOptionName - contains the name of the payment option for which information is returned.
    • payOptionNameTranslations - contains the translations related to the payment option name.
      • solmRefTransNo - contains the identification of the translation for this payment option name is returned in.
      • solmTranslationEntry - an array containing an element for each locale the payment option name is returned in.
        • solmLocaleID - contains the ID of the locale in which the payment option name is returned.
        • solmRefTransText - contains the name of the payment option name in the locale (language) described by solmLocaleID.
    • payOptionDesc - contains the description of the payment option for which information is returned.
    • payOptionDescTranslations - contains the translations related to the payment option description.
      • solmRefTransNo - contains the identification of the translation for this payment option description.
      • solmTranslationEntry - an array containing an element for each locale the payment option description is returned in.
        • solmLocaleID - contains the ID of the locale in which the payment option description is returned.
        • solmRefTransText - contains the name of the payment option description in the locale (language) described by solmLocaleID.
    • payOptionVariantName - contains the name of the of the payment option variant for which information is returned.
    • payOptionVariantNameTranslations - contains the translations related to the payment option variant name.
      • solmRefTransNo - contains the identification of the translation for this payment option variant name.
      • solmTranslationEntry - an array containing an element for each locale the payment option variant name is returned in.
        • solmLocaleID - contains the ID of the locale in which the payment option variant name is returned.
        • solmRefTransText - contains the name of the payment option variant name in the locale (language) described by solmLocaleID.
    • payOptionVariantDesc – contains the description of the payment option variant for which information is returned.
    • payOptionVariantDescTranslations– contains the translations related to the payment option variant description.
      • solmRefTransNo – contains the identification of the translation for this payment option variant description.
      • solmTranslationEntry – an array containing an element for each locale the payment option variant description is returned in.
        • solmLocaleID – contains the ID of the locale in which the payment option variant description is returned.
        • solmRefTransText– contains the name of the payment option variant description in the locale (language) described by solmLocaleID
  • statementContactNo - on return, the field contains the Aria generated identification of the statement contact defined for the current billing group. This contain will be used to email statements and invoices. If present, the statementContactDetails structure holds the detail of contact information. 
  • statementContactDetails – on return, the structure contains the detail of the statement contact information. 
    • firstName - contains the first name of the customer. If not available, leave blank. 
    • middleInitials - contains the middle initials of the customer. if not available, leave blank.
    • lastName - contains the last name (given name) of the customer. If not available, leave blank.
    • fullName - contains the full name of the customer or it contains the company name of the customer. Must be present. 
    • addressLine1 - contains the first line of the customer’s address. If not present, leave blank. 
    • addressLine2 - contains the second line of the customer’s address. If not present, leave blank. If present, addressLine1 must also be present. 
    • addressLine3 - contains the third line of the customer’s address. If not present, leave blank. If present, addressLine2 must also be present. 
    • postalCode - contains the postal code of the customer’s address. If not present, leave blank.
    • postalCity - contains the postal city of the customer’s address. If not present, leave blank.
    • addrLocality – contains the locality of the current address.
    • addrStateProv – for addresses in the United States (US), Australia (AU) and Canada (CA) this field contains the code identifying the state or province.
    • streetName – if present, this field contains only the name of the street. Numbers, floors, etc. are not included. 
    • streetNo – if present, this field contains only the street number and no other part of the address.
    • flatNo – if present, this field contains the number of the flat. 
    • flatSpec – if present, this field contains the specification of the flat, for example left, right, center, etc. 
    • flatFloor – if present, this field contains the floor where the flat is found.
    • entranceNo – if present, this field contains the number of the entrance to the flat.
    • homePhone - contains the home phone number of the customer. If not present, leave blank.
    • cellPhone - contains the cell phone number of the customer. If not present, leave blank.
    • workPhone - contains the work phone number of the customer. If not present, leave blank.
    • emailAddress - contains the email address associated with the customer. Must contain a valid email address. 
  • ariaDunningGroupID - on return, the field contains the solution generated unique identification of the dunning group. 
  • ariaDunningGroupNo – on return, the field contains the Aria generated unique identification of the dunning group. 
  • dunningGroupName - on return, this field contains the solution generated name of the dunning group. 
  • dunningGroupDesc - on return, this field contains a brief description of the dunning group. 
  • dunningProcessID - on return, this field contains the unique identification of the dunning process to be used for subscriptions under this account.  

The response will contain zero, one or more entries in the acctRetrieveBillingGroupPayMethodList array. Each entry contains the following attributes:

  • ariaPaymentMethodID - on return, the field contains the solution generated unique identification of the payment method. 
  • ariaPaymentMethodNo - on return, this field contains the Aria generated payment method number. 
  • payMethodType - on return, this field contains the payment method in use. The following values are possible:
    • "CC" - the payment method covers a credit card stored in Aria
    • "CC-TOKEN" - the payment method covers credit card stored in the payment providers solution. 
  • creditCardMasked - on return, this field contains the masked credit card. Only the last 4 digits are visible.  
  • creditCardType - on return, this field contains the type of credit card registered, for example "VISA", "MASTERCARD", "AMEX", etc. 
  • creditCardExpMonth - on return, this field contains the expiry month of the registered credit card. 
  • creditCardExpYear - on return, this field contains the expiry year of the registered credit card. 
  • billContactNo - on return, the field contains the Aria generated identification of the billing contact defined for the current payment method. This contain will be used to email statements and invoices. If present, the billContactDetails structure holds the detail of contact information. 
  • billContactDetails – on return, the structure contains the detail of the billing contact information. 
    • firstName - contains the first name of the customer. If not available, leave blank. 
    • middleInitials - contains the middle initials of the customer. if not available, leave blank.
    • lastName - contains the last name (given name) of the customer. If not available, leave blank.
    • fullName - contains the full name of the customer or it contains the company name of the customer. Must be present. 
    • addressLine1 - contains the first line of the customer’s address. If not present, leave blank. 
    • addressLine2 - contains the second line of the customer’s address. If not present, leave blank. If present, addressLine1 must also be present. 
    • addressLine3 - contains the third line of the customer’s address. If not present, leave blank. If present, addressLine2 must also be present. 
    • postalCode - contains the postal code of the customer’s address. If not present, leave blank.
    • postalCity - contains the postal city of the customer’s address. If not present, leave blank.
    • addrLocality – contains the locality of the current address.
    • addrStateProv – for addresses in the United States (US), Australia (AU) and Canada (CA) this field contains the code identifying the state or province.
    • streetName – if present, this field contains only the name of the street. Numbers, floors, etc. are not included. 
    • streetNo – if present, this field contains only the street number and no other part of the address.
    • flatNo – if present, this field contains the number of the flat. 
    • flatSpec – if present, this field contains the specification of the flat, for example left, right, center, etc. 
    • flatFloor – if present, this field contains the floor where the flat is found.
    • entranceNo – if present, this field contains the number of the entrance to the flat.
    • homePhone - contains the home phone number of the customer. If not present, leave blank.
    • cellPhone - contains the cell phone number of the customer. If not present, leave blank.
    • workPhone - contains the work phone number of the customer. If not present, leave blank.
    • emailAddress - contains the email address associated with the customer. Must contain a valid email address. 

The following attributes are added to  acctRetrieveBillingGroupTitleInfo structure are defined as follows:

  • acctManageBillingGroupTitleInfo – the overall structure holding the title details.
    • titleCode – contains the unique identification of the title being returned.
    • titleName – contains the name of the title being returned.
    • titleDesc – contains the full description of the title being returned. 
    • titleNameTranslations – contains the translations for the title name for each locale defined.
    • titleDescTranslations – contains the translations for the title description for each locale defined.
    • titleDomain – contains the title domain (URL) associated with the current title. 
       

Prepare Credit Card Update (JSON API)

Endpoint

This API can be called by making a POST call to the URL: 
https://[clienthost]/PostDataToFlow/ARIAMediaSuite/AccountManagement/AcctPrepareCCUpdate

AcctPrepareCCUpdateRequest

The acctPrepareCCUpdateRequest message is a JSON formatted message used to retrieve the account specific session ID which is a required parameter when using the Aria Direct Post functionality. The sessionID is passed to the Direct Post services and will be used when the Direct Post service communicates directly with Aria.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctPrepareCCUpdateDetails": {
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 24423445
    }
}

The individual data elements of msgAuthDetails are defined as follows:

  • clientNo - contains the Aria specific identification of the instance in which the solution currently operates. Varies from test to production. This value is required in all API calls to Aria to authenticate the caller. 
  • authKey - contains the Aria specified authentication key. This key is required in all API calls to Aria to authenticate the caller.  
  • requestDateTime - contains the date and time when the message was built. 
  • signatureValue -  contains the signature value calculated by the sending solution. Using the private key, the receiving solution will validate the information retrieved, and if no match is found, the call will fail. 
  • ariaAccountID - contains the defined identification of the customer account, for example a number from a CRM system or other customer master.  Used for the signature value calculation.
  • ariaAccountNo - contains the Aria generated identification of the account. Used for the signature value calculation. 

The individual data elements of acctPrepareCCUpdateDetails are defined as follows:

  • ariaAccountID - contains the defined identification of the customer account, for example a number from a CRM system or other customer master.  This is the identification of the account on which the credit card should be registered. 
  • ariaAccountNo - contains the Aria generated identification of the account. This is the identification of the account on which the credit card should be registered. If present, this field takes precedence over the ariaAccountID. 

AcctPrepareCCUpdateResponse

The acctPrepareCCUpdateResponse message is a JSON formatted message used to return the account specific session ID and other parameters which are required parameters for the Aria Direct Post functionality. The sessionID is passed to the Direct Post services and will be used when the Direct Post service communicates directly with Aria.
{
"resultInfo": {
    "resultCode": 0,
    "resultText": "OK"
},
"acctPrepareCCUpdateResponseDetails": {
    "ariaAccountID": "ACCT1",
    "ariaAccountNo": 24423445,
    "ariaSessionID": "acXKhw4s47RRXs535VYYWbvfQ8uWaeFp"
}

The individual data elements are defined as follows:

  • resultCode - contains a code indicating the outcome of the operation. 0 indicates success; any other code indicates a failure. 
  • resultText - If success is returned, this element contains "OK". If a failure occurred, the element contains a description of the problem.

The individual data elements of acctPrepareCCUpdateResponseDetails are defined as follows:

  • ariaAccountID - contains the defined identification of the customer account, for example a number from a CRM system or other customer master.  This is the identification of the account on which the credit card should be registered. 
  • ariaAccountNo - contains the Aria generated identification of the account. This is the identification of the account on which the credit card should be registered. 
  • ariaSessionID - if success is returned, this element contains the Aria generated session ID. This ID must be used when invoking the HTML form used to register the credit card details. 

 

Complete Credit Card Update (JSON API)

Endpoint

This API can be called by making a POST call to the URL:
https://[clienthost]/PostDataToFlow/ARIAMediaSuite/AccountManagement/AcctCompleteCCUpdate

AcctCompleteCCUpdateRequest

The acctCompleteCCUpdateRequest message is a JSON formatted message used to update the payment method and billing group after the registration of a new credit card or an update of an existing credit card. The service is called after the Direct Post form has completed with an error_code of 0 (indicating success). 
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": "acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX",
        "requestDateTime": "2017-08-16T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "acctCompleteCCUpdateDetails": {
        "titleCode": "Test",
        "ariaAccountID": "ACCT1",
        "ariaAccountNo": 24423445, 
        "createNewBillingGroup": false, 
        "ariaPaymentMethodNo": 1,
        "ariaBillingGroupID": "BG-123455", 
        "ariaBillingGroupNo": 223344
    }
}

The individual data elements of msgAuthDetails are defined as follows:

  • clientNo - contains the Aria specific identification of the instance in which the solution currently operates. Varies from test to production. This value is required in all API calls to Aria to authenticate the caller. 
  • authKey - contains the Aria specified authentication key. This key is required in all API calls to Aria to authenticate the caller.  
  • requestDateTime - contains the date and time when the message was built. 
  • signatureValue - contains the signature value calculated by the sending solution. Using the private key, the receiving solution will validate the information retrieved, and if no match is found, the call will fail. 
  • ariaAccountID - contains the client defined identification of the customer account, for example a number from a CRM system or other customer master.  Used for the signature value calculation.
  • ariaAccountNo - contains the Aria generated identification of the account. Used for the signature value calculation. 

The individual data elements of acctCompleteCCUpdateDetails are defined as follows:

  • ariaAccountID - contains the client defined identification of the customer account, for example a number from a CRM system or other customer master.  This is the identification of the account on which the credit card should be registered. 
  • ariaAccountNo - contains the Aria generated identification of the account. This is the identification of the account on which the credit card should be registered. If present, this field takes precedence over the ariaAccountID
  • createNewBillingGroup – a flag, that if it contains TRUE, will create a new billing group based on the existing billing, but using the new payment method. If flag contains FALSE, the specified billing group is updated. 
  • ariaPaymentMethodNo - contains the Aria generated identification of the payment method to which the new credit card has been associated. The identification is returned in the URL redirect done by Direct Post if the processing was successful. 
  • ariaBillingGroupID - contains the solution defined identification of the billing group to which the payment method has been associated. The master plan instances charged and collected using the credit card is linked to this billing group. If not present, ariaBillingGroupNo must be provided. 
  • ariaBillingGroupNo - contains the Aria generated identification of the billing group. If not present, the ariaBillingGroupID must be provided. If both are provided, the ariaBillingGroupID takes precedence. 

AcctCompleteCCUpdateResponse

The acctCompleteCCUpdateResponse message is a JSON formatted message used to return the outcome of the operation.
{
"resultInfo": {
    "resultCode": 0,
    "resultText": "OK"
},
"acctCompleteCCUpdateResponseDetails": {
    "ariaAccountID": "ACCT1",
    "ariaAccountNo": 24423445,
    "ariaPaymentMethodID": "CREDITCARD-01",
    "ariaPaymentMethodNo": 1, 
    "ariaBillingGroupID": "BG-dkfjdkfjdfjkdjffdkjdkdjf",
    "ariaDunningGroupID": "DG-dkfjdkfjdfjkdjffdkjdkdjf"
}

The individual data elements are defined as follows:

  • resultCode - contains a code indicating the outcome of the operation. 0 indicates success; any other code indicates a failure. 
  • resultText - If success is returned, this element contains "OK". If a failure occurred, the element contains a description of the problem.

The individual data elements of acctPrepareCCUpdateResponseDetails are defined as follows:

  • ariaAccountID - contains the client defined identification of the customer account, for example a number from a CRM system or other customer master.  This is the identification of the account on which the credit card should be registered. 
  • ariaAccountNo - contains the Aria generated identification of the account. This is the identification of the account on which the credit card should be registered. 
  • ariaPaymentMethodID - if success is returned, this element contains the newly assigned solution defined identification of the payment method. 
  • ariaPaymentMethodNo – if success is returned, this element contains the Aria generated ID of the payment method. Is identical to the parameter provided as input. 
  • ariaBillingGroupID – on return, the field contains the solution defined identification of the billing group to which the payment method has been associated. If a new billing group has been created, it will contain the ID of the new billing group. If the billing group was updated, the attribute will contain the same ID as provided in the call. 
  • ariaDunningGroupID – on return, the field contains the solution defined identification of the dunning group associated with the billing group. If a new dunning group has been created, it will contain the ID of the new dunning group. If the dunning group was updated, the attribute will contain the same ID as provided in the call. 

 

Capture Comment (JSON API)

EndPoint

This API can be called by making a POST call to the URL: 
https://[clienthost]/PostDataToFlow/ARIAMediaSuite/AccountManagement/AcctCaptureComments

AcctCaptureCommentRequest

The acctCaptureCommentRequest message is a JSON formatted message used to capture comments on an account and store the same in Aria. The service is called after the Direct Post form has completed with an error_code of 0 (indicating success). 
{
  "msgAuthDetails": {
    "clientNo": 101,
    "authKey": "AuthKeyIsNotRequiredAndShouldNotBeProvided",
    "requestDateTime": "2019-12-31 19:42:12",
    "signatureValue": "SignatureValueGeneratedByOutsideSystem",
    "signatureVersion": "1.0",
    "ariaAccountID": "aria-client-id",
    "ariaAccountNo": 99250412,
    "userID": "KeyUser"
  },
  "acctCaptureCommentCriteria": {
    "ariaAccountID": "some-aria-client-id",
    "ariaAccountNo": 22894566,
    "acctCommentAuthor": "Mr. Author PhD",
    "acctCommentDateTime": "2019-12-31 19:44:02",
    "acctCommentText": "this is a randomly generated comment, which is commented by author named Mr. Author and this consists of some length - it can be of any length however it is recommended to keep it shorter than 450 characters, otherwise multiple comments would be generated and each comment would be splitted by 450 characters, each split should happen before the first space prior reaching to 450 characters. So far I have been able to write only 391 characters whereas I should have written 450 characters, lets check how many have I been able to do so? 583, yes, I should stop blabbering now."
    "acctApplicationID": "SomeWEBSiteID",
    "acctApplicationDateTime": "2019-12-31 19:47:43"
  }
}

The individual data elements of msgAuthDetails are defined as follows:

  • clientNo - contains the Aria specific identification of the instance in which the solution currently operates. Varies from test to production. This value is required in all API calls to Aria to authenticate the caller. 
  • authKey – this is not required when a call is made by outside system and this should not be provided.  
  • requestDateTime - contains the date and time when the message was built. 
  • signatureValue - contains the signature value calculated by the sending solution. Using the private key, the receiving solution will validate the information retrieved, and if no match is found, the call will fail. 
  • ariaAccountID - contains the client defined identification of the customer account, for example a number from a CRM system or other customer master.  Used for the signature value calculation.
  • ariaAccountNo - contains the Aria generated identification of the account. Used for the signature value calculation. 

The Individual elements of AcctRetrieveCommentsCriteria described below.

  • ariaAccountID – the client defined identification of the account to which the comment is linked.
  • ariaAccountNo – the Aria generated identification of the account to which the comment is linked.
  • dateRangeStart – contains the date after which account level comments are returned. If "null", then no start date is given.
  • dateRangeEnd – contains the date until which account level comments are returned. If "null", then no end date is given. If a date greater than the current date is provided, all comments up to the current date is returned. 

AcctCaptureCommentResponse

acctCaptureCommentResponse message is a JSON formatted message used to return the outcome of the operation.
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    }
}

The individual data elements are defined as follows:

  • resultCode - contains a code indicating the outcome of the operation. 0 indicates success; any other code indicates a failure. 
  • resultText - If success is returned, this element contains "OK". If a failure occurred, the element contains a description of the problem. 

 

Retrieve Comment (JSON API)

Endpoint

This API can be called by making a POST call to the URL:
https://[clienthost]/PostDataToFlow/ARIAMediaSuite/AccountManagement/AcctRetrieveComments

AcctRetrieveCommentRequest

The acctRetrieveCommentRequest message is a JSON formatted message request used to retrieve comments on an account in Aria. The service is called after the Direct Post form has completed with an error_code of 0 (indicating success).
{
    "msgAuthDetails": {
      "clientNo": 99,
      "authKey": "AuthorizationKeyIsNeitherNeededNorShouldBeProvided",
      "requestDateTime": "2019-05-07 21:02:25",
      "signatureValue": "signatureValueGeneratedByOutsideSystemUsingPreviouslyAgreedAlgorithmAndPrivateKey",
      "signatureVersion": 1.0,
      "ariaAccountID": "some-aria-account-id",
      "ariaAccountNo": 42434445,
      "userID": "Data Reader"
    },
    "AcctRetrieveCommentsCriteria": {
      "ariaAccountID": "some-aria-account-id-can-be-different-from-msgAuthDetails",
      "ariaAccountNo": 41424344,
      "dateRangeStart": "2019-05-01 21:04:40",
      "dateRangeEnd": "2019-05-07 21:05:01"
    }
  }

The individual data elements of msgAuthDetails are defined as follows:

  • clientNo - contains the Aria specific identification of the instance in which the solution currently operates. Varies from test to production. This value is required in all API calls to Aria to authenticate the caller. 
  • authKey – this is not required when a call is made by outside system and this should not be provided.  
  • requestDateTime - contains the date and time when the message was built. 
  • signatureValue - contains the signature value calculated by the sending solution. Using the private key, the receiving solution will validate the information retrieved, and if no match is found, the call will fail. 
  • ariaAccountID - contains the client defined identification of the customer account, for example a number from a CRM system or other customer master.  Used for the signature value calculation.
  • ariaAccountNo - contains the Aria generated identification of the account. Used for the signature value calculation. 

The individual data elements of  AcctRetrieveCommentsCriteria are defined below:

  • ariaAccountID – the client defined identification of the account to which the comment is linked.
  • ariaAccountNo – the Aria generated identification of the account to which the comment is linked.
  • dateRangeStart – contains the date after which account level comments are returned. If "null", then no start date is given.
  • dateRangeEnd – contains the date until which account level comments are returned. If "null", then no end date is given. If a date greater than the current date is provided, all comments up to the current date is returned. 

AcctRetrieveCommentResponse

The acctRetrieveCommentResponse message is a JSON formatted message used to return the outcome of the operation.

{
    "resultInfo": {
      "resultCode": 0,
      "resultText": "OK"
    },
    "acctRetrieveCommentsList": [
      {
        "acctCommentAuthor": "Mr. Author PhD DSc",
        "acctCommentDateTime": "2019-05-01 18:00:00",
        "acctCommentText": "(1/3): This is the first of the 3 comments which have been splitted - consider that length of first 2 comments is 450 characters",
        "acctApplicationID": "SOME-Application-ID",
        "acctApplicationDateTime": "2019-05-01 17:00:00",
        "acctCommentNo": 42000001
      },
      {
        "acctCommentAuthor": "Mr. Author PhD DSc",
        "acctCommentDateTime": "2019-05-01 18:00:00",
        "acctCommentText": "(2/3): This is the second of the 3 comments which have been splitted - consider that length of first 2 comments is 450 characters",
        "acctApplicationID": "SOME-Application-ID",
        "acctApplicationDateTime": "2019-05-01 17:00:00",
        "acctCommentNo": 42000002
      },
      {
        "acctCommentAuthor": "Mr. Author PhD DSc",
        "acctCommentDateTime": "2019-05-01 18:00:00",
        "acctCommentText": "(3/3): This is the third and last of the 3 comments which have been splitted - consider that length of first 2 comments is 450 characters",
        "acctApplicationID": "SOME-Application-ID",
        "acctApplicationDateTime": "2019-05-01 17:00:00",
        "acctCommentNo": 42000003
      }
    ]
  }

The individual data elements are defined as follows:

  • resultCode - contains a code indicating the outcome of the operation. 0 indicates success; any other code indicates a failure. 
  • resultText - If success is returned, this element contains "OK". If a failure occurred, the element contains a description of the problem.
  • acctRetrieveCommentsList – an array containing the account level comments retrieved from the database and returned to the caller. If no comments exist, the array will be empty. 
    • acctCommentAuthor – an attribute holding the name of the author of the account level comments. Note this may be a system or service within the solution. 
    • acctCommentDateTime – contains the date and time the comment was registered in Aria. The format of the date following normal JSON schema rules. 
    • acctCommentText – the actual account level comment.
    • acctApplicationID – the identification of the application that generated the comment. May contain "null". 
    • acctApplicationDateTime – the date and time the comment was registered by the application. The format of the date following normal JSON schema rules. May contain "null".
    • acctCommentNo – A unique number associated with the account level comment. 

 

Change Permanent Account Address

Endpoint

This API can be called by making a POST call to the URL: 
https://[clienthost]/PostDataToFlow/ARIAMediaSuite/AccountManagement/AcctChangePermAddress

AcctChangePermAddressRequest

The AcctChangePermAddressRequest message is a JSON formatted message request used to trigger the change of permanent address for an account in Aria. The service is called after the Direct Post form has completed with an error_code of 0 (indicating success).
{
    "msgAuthDetails": {
      "clientNo": 99,
      "authKey": "AuthorizationKeyIsNeitherNeededNorShouldBeProvided",
      "requestDateTime": "2019-05-07 21:02:25",
      "signatureValue": "signatureValueGeneratedByOutsideSystemUsingPreviouslyAgreedAlgorithmAndPrivateKey",
      "signatureVersion": 1.0,
      "ariaAccountID": "some-aria-account-id",
      "ariaAccountNo": 42434445,
      "userID": "Data Reader"
    },
"AcctChangePermAddressRequestDetails": {
    "ariaAccountID": "another-aria-acct-id",
    "ariaAccountNo": 40204321,
    "ariaMPIID": "aria-Master-Plan-Instance-ID",
    "ariaMPINo": 23242526,
    "dateEffective": "2019-05-11 15:10:00",
    "distAddressNo": 1,
    "distAddressType": "AddressTypeIsProvidedOnlyIfDistAddressNoAboveIsNULL or EMPTY",
    "acctDeliveryAddress": {
      "distAddrType": "AddressTypeToBeCreated",
      "distAddrName": "SomeIntelligibleAddressName",
      "distAddrLine1": "Address Line ONE",
      "distAddrLine2": "Address Line TWO",
      "distAddrLine3": "Address Line THREE",
      "distAddrLine4": "Address Line FOUR",
      "distCoAddr": "If address is Care-of-Address that’s to be mentioned here",
      "distAddrCity": "City",
      "distAddrPostalCode": "Postal Code",
      "distAddrCountryCode": "2 characters country code e.g. DK for Denmark",
      "distAddrLocality": "Local Area Name",
      "distAddrStateProv": "State or Province depending on geographical location",
      "distStreetName": "if Street has a Name",
      "distStreetNo": 3,
      "distFlatNo": 39,
      "distFlatSpec": 1234,
      "distFlatFloor": 13,
      "distEntranceNo": 1,
      "distPublAddrNo": 2,
      "distApartmentNo": 39,
      "distDirections": "Directions to Address e.g. Right Behind 7/11 on High Street"
    }
  }
}

The individual data elements of msgAuthDetails are defined as follows:

  • clientNo - contains the Aria specific identification of the instance in which the solution currently operates. Varies from test to production. This value is required in all API calls to Aria to authenticate the caller. 
  • authKey – this is not required when a call is made by outside system and this should not be provided.  
  • requestDateTime - contains the date and time when the message was built. 
  • signatureValue - contains the signature value calculated by the sending solution. Using the private key, the receiving solution will validate the information retrieved, and if no match is found, the call will fail. 
  • ariaAccountID - contains the client defined identification of the customer account, for example a number from a CRM system or other customer master.  Used for the signature value calculation.
  • ariaAccountNo - contains the Aria generated identification of the account. Used for the signature value calculation. 

The individual data elements of AcctChangePermAddressRequestDetails are defined below:

  • ariaAccountID – the client defined identification of the account for which permanent address change needs to happen.
  • ariaAccountNo – the Aria generated identification of the account for which permanent address change needs to happen.
  • ariaMPIID –. Ariagenerated Master Plan Instance ID if permanent address change is only for a specific subscription.
  • ariaMPINo – Aria Master Plan Instance Number if permanent address change is only for a specific subscription.
  • dateEffective – Date from which address change should be effective.
  • distAddressNo – if existing delivery is to be used as Permanent Account Address, this should be provided and shall be validated against DistAddr table.
  • distAddressType – if a new address needs to be added, this field should contain a valid Address Type which is to be validated against DistAddrTypes.

The individual data elements of acctDeliveryAddress are defined below:

  • distAddrType – If distAddressNo was not provided and distAddressType was provided as previous message structure, it means that we need to add a new address& this field contains AddressType of the address to be created.
  • distAddrName –  Name of the address to be created so that it can be easily identified.
  • distAddrLine1 – Address Line 1 of the Address to be added
  • distAddrLine2 – Address Line 2 of the Address to be added – validation rules as defined in distManageAddress applies for all the address fields.
  • distAddrLine3 – Address Line 3.
  • distAddrLine4 – Address Line 4.
  • distCoAddr –Care-of-Address, if available.
  • distAddrCity – City Name to be provided in this field.
  • distAddrPostalCode – Depending upon geographical location, Postal Code or Zip Code is provided in this field.
  • distAddrCountryCode – 2-digit ISO Country Code for the Address to be created e.g. for Germany, it would be DE
  • distAddrLocality – If the address has a local area name, that’s given here.
  • distAddrStateProv – Depending on the geographical location, State or Province Name is provided here.
  • distStreetName – if the Street of the address to be created has a name, that shall be given here.
  • distStreetNo -  Street Number is to be specified in this field.
  • distFlatNo – Flat Number if available is provided here.
  • distFlatSpec –Flat Spec of type Integer are to be provided here.
  • distFlatFloor – Floor number of the Flat is to be provided as per local conventions.
  • distEntranceNo – if there are multiple entrance and a specific entrance number leads to the address, that number can be provided in this field.
  • distPublsAddrNo – if
  • distApartmentNo –If delivery address is that of an apartment, apartment number is provided here.
  • distDirections – If there are directions available to the delivery address, those can be provided here, e.g. Take first left from Fanshawe Avenue and building is right behind the 7/11.

AcctChangePermAddressResponse

The AcctChangePermAddressResponse message is a JSON formatted message used to return the outcome of the operation.
{
  "resultInfo": {
    "resultCode": 0,
    "resultText": "OK"
  },
  "AcctChangePermAddressResponseDetails": {
    "ariaAccountID": "Aria-Account-ID-Provided-In-Request",
    "ariaAccountNo": 40414243,
    "distAddressNo": 3
  }
}
The individual data elements of resultInfo are defined as follows:

  • resultCode - contains a code indicating the outcome of the operation. 0 indicates success; any other code indicates a failure. 
  • resultText - If success is returned, this element contains "OK". If a failure occurred, the element contains a description of the problem. 

The individual data elements of AcctChangePermAddressResponseDetails are defined as follows:

  • ariaAccountID – it contains the ariaAccountID as that of the request
  • ariaAccountNo – this contains AriaAccountNo for which permanent address change has been performed.
  • distAddressNo – It contains the Address No which has been used to update permanent address of the account and/or subscriptions – if distAddressNo was provided in the request, it will be the same, however, if request didn’t contain distAddressNo  therefore a new distAddressNo was created and that is returned here.

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.