Salesforce UX API

(0 reviews)

NonTmf-ListRecurringCreditInfoFromAria-PR

This operation list the recurring credits associated with a specified account from Aria system, GET:/accountCredit

Note: If you are fetching data without 'crmUniqueId' ( queryParam ) then you will get all recurring credits info associated to account number.

URL

http://[localhost]:[port]/sfdc-ux/v1/{businessId}/accountCredit

url Param

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico	Y

name	value	description	required
client_id	string	The client_id identifying the channel.	Y
client_secret	string	Password associated with the client_id.	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request	Y
targetSystem	string	This describes the end system request is for Eg: “Aria”	Y

Query Param

Name	Type	Description	Required
account_no	string	The unique identifier for account	Y
crmUniqueId	string	The identifier for the specific recurring credit.	N

Request

http://[localhost]:[port]/sfdc-ux/v1/PR/accountCredit?account_no=<accountValue>&crmUniqueId=<crmUniqueId>

Response

[ 200 ]

OK - listRecurringCreditInfo request processed successfully, response body contains an entity corresponding to the requested resource.

[
    {
        "recurringCreditNo": "865817",
        "createDate": "2025-04-11",
        "updateDate": "2025-04-11",
        "firstCreditDate": "2025-04-11",
        "lastCreditDate": "2025-04-11",
        "nextCreditDate": "2025-06-11",
        "comments": "RecurringCredits|BAN1050523-CAN2023_IP_Promotion-1|credit presentation text in English invoice : credit presentation text in Spanish invoice|CRMuniqueID001",
        "creditsCompleted": "1",
        "creditsRemaining": "1",
        "creditIntervalMonths": "2",
        "creditIntervalTypeIndicator": "M",
        "creditStatusLabel": "Credits Created, Incomplete",
        "creditReasonText": "General Credit/Other",
        "amount": {
            "unit": "usd",
            "value": 1
        },
        "eligibleigiblePlanInstanceDetails": [
            {
                "clientPlanInstanceId": "BAN1050523-CAN2023_SPI_100",
                "clientPlanInstanceServiceId": "PR_B2C_ULT_Value_Plus_MB_Line"
            }
        ]
    }
]

Definitions

name	type	description	required
creditType	string	Credit Type	N
recurringCreditNo	string	The identifier for the recurring credit	N
InstallmentId	string	Installment Id for the Promotional Credit	N
createDate	datetime	The date the recurring credit record was created	N
updateDate	datetime	The date the recurring credit record was last updated	N
firstCreditDate	datetime	The first date that recurring credit was applied to the account	N
lastCreditDate	datetime	The last date that recurring credit will be applied to the account	N
nextCreditDate	datetime	The next date that a recurring credit will be applied to the account (assuming the last_credit_date has not passed)	N
creditsCompleted	string	The number of credits that have been applied to the account	N
creditsRemaining	string	The number of remaining credits to apply to the account	N
creditIntervalMonths	string	The interval (in months) between credits to the account	N
creditIntervalTypeIndicator	string	The type of the interval between credits to the account(months, weeks, or days)	N
creditStatusLabel	string	The label for the recurring credit status code.	N
creditReasonText	string	The text description of the credit reason code.	N
comments	string	Free-form comments for the credit applied to the specified account.	N
amount	object	Amount	N
amount.unit	string	The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.	N
amount.value	string	The monetary amount of the credit to be applied for each iteration of the recurring credit sequence.	N
eligibleigiblePlanInstanceDetails	array	Eligibleigible Plan Instance Details	N
eligibleigiblePlanInstanceDetails.clientPlanInstanceId	string	The client defined plan instance identifier.	N
eligibleigiblePlanInstanceDetails.clientPlanInstanceServiceId	string	The client defined identifier for the service associated with this plan instance.	N