Salesforce UX API

(0 reviews)

TMF676-ListPaymentHistoryTowardsMatrixx

/payment [GET]

This operation list all the Payment History for a specified MSISDN Number

resources/image-276ca8cd-1ed4-43c1-9ce2-1664e6a611ed.png

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

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

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. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	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 Minimum characters: 1	Y
targetSystem	string	Target system value where entity need to be created , For example "Matrixx"	Y

Query Param

name	type	description	required
accountId	string	Subscription External Id	Y
paymentItem.item.id	string	To retrieve the payment history based on MSISDN Number . Note : For Peacock Project paymentItem.item.id is required. It's mandatory if want to list all the Payment History for a specified MSISDN Number	Y*

cURL request

To list all the Payment History for a specified MSISDN Number

curl --location --request GET 'https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/sfdc-ux/v1/PR/payment?accountId=00127530_0000743647&paymentItem.item.id=228900' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b' \
--header 'targetSystem: MATRIXX' \
--header 'client_id: 784c9a6dd7ae49768816cab57fcf1fa1' \
--header 'client_secret: 187b259EB77441babbF611d2646C670d'

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

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

[ 200 ]

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

[
    {
        "correlatorId": "ksv7kspx",
        "paymentDate": "2023-06-01T07:48:58.285054-04:00",
        "description": "ILI0:1:52:5020348 | LLAPaymentAuthorizationEvent",
        "totalAmount": {
            "value": 36.8,
            "unit": "USD"
        },
        "paymentMethod": {
            "name": "CreditCard null_Visa_1881_12/2024",
            "description": "Visa",
            "@type": "PaymentMethodRef"
        },
        "account": {
            "id": "00127530_0000743647",
            "name": "SubscriberExternalId"
        },
        "channel": {
            "name": "IVR"
        },
        "paymentItem": [
            {
                "item": {
                    "id": "19394109656",
                    "@referredType": "MSISDN"
                }
            }
        ],
        "extendedCharacteristic": [
            {
                "name": "PaymentGatewayResult",
                "value": "OK"
            },
            {
                "name": "ProcessorResponseCode",
                "value": "1000"
            },
            {
                "name": "ProcessorResponseText",
                "value": "Approved"
            },
            {
                "name": "ProcessorResponseType",
                "value": "APPROVED"
            }
        ]
    },
    {
        "correlatorId": "08f461gy",
        "paymentDate": "2023-05-31T11:41:54.778333-04:00",
        "description": "ILH0:1:52:4972440 | LLAPaymentAuthorizationEvent",
        "totalAmount": {
            "value": 47.95,
            "unit": "USD"
        },
        "paymentMethod": {
            "name": "CreditCard null_Visa_1881_12/2024",
            "description": "Visa",
            "@type": "PaymentMethodRef"
        },
        "account": {
            "id": "00127530_0000743647",
            "name": "SubscriberExternalId"
        },
        "channel": {
            "name": "sfdc-b2c"
        },
        "paymentItem": [
            {
                "item": {
                    "id": "19394109656",
                    "@referredType": "MSISDN"
                }
            }
        ],
        "extendedCharacteristic": [
            {
                "name": "PaymentGatewayResult",
                "value": "OK"
            },
            {
                "name": "ProcessorResponseCode",
                "value": "1000"
            },
            {
                "name": "ProcessorResponseText",
                "value": "Approved"
            },
            {
                "name": "ProcessorResponseType",
                "value": "APPROVED"
            }
        ]
    },
    {
        "correlatorId": "844e1dd7-2a7f-18fb-b8ed-ed78c3F92c2c",
        "paymentDate": "2023-05-31T09:55:28.638162-04:00",
        "description": "ILH0:1:52:4968670 | LLARechargeEvent",
        "amount": {
            "value": -20.0,
            "unit": "USD"
        },
        "channel": {
            "name": "Evertec"
        },
        "account": {
            "id": "00127530_0000743647",
            "name": "SubscriberExternalId"
        },
        "paymentItem": [
            {
                "item": {
                    "id": "19394109656",
                    "@referredType": "MSISDN"
                }
            }
        ]
    },
    {
        "correlatorId": "844e1dd7-2a7f-18fb-b8ed-ed78c3F92c2c",
        "paymentDate": "2023-05-31T09:55:28.638162-04:00",
        "description": "ILH0:1:52:4968670 | LLAPurchasedOfferExtension",
        "amount": {
            "value": -20.0,
            "unit": "USD"
        },
        "channel": {
            "name": "Incomm"
        },
        "account": {
            "id": "S-77780",
            "name": "SubscriberExternalId"
        },
        "paymentItem": [
            {
                "item": {
                    "id": "19394109656",
                    "@referredType": "MSISDN"
                }
            }
        ],
        "payer": {
            "id": "9077200",
            "role": "LogicalResource"
        },
        "statusDate": "2023-05-31T11:41:54",
        "@type": "revvalins"
    },
    {
        "correlatorId": "644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b",
        "paymentDate": "2023-11-27T20:00:00.000000-04:00",
        "description": "ILIQ40:1:52:414910085 | LLAPaymentAuthorizationEvent",
        "totalAmount": {
            "value": 50.18,
            "unit": "USD"
        },
        "paymentMethod": {
            "name": "___/",
            "description": "Credit Card",
            "@type": "PaymentMethodRef"
        },
        "channel": {
            "name": "sfdc-b2c"
        },
        "account": {
            "id": "00127530_0000743647",
            "name": "SubscriberExternalId"
        },
        "paymentItem": [
            {
                "item": {
                    "id": "19394109656",
                    "@referredType": "MSISDN"
                }
            }
        ],
        "extendedCharacteristic": [
            {
                "name": "PaymentGatewayResult",
                "value": "No Account. Failed with transaction. tatus=PROCESSOR_DECLINED"
            },
            {
                "name": "ProcessorResponseCode",
                "value": "2007"
            },
            {
                "name": "ProcessorResponseText",
                "value": "No Account"
            },
            {
                "name": "ProcessorResponseType",
                "value": "HARD_DECLINED"
            }
        ]
    }
]

Definitions

Each of the request parameters is detailed.

name	type	description	required
correlatorId	string	Payment transaction ID	N
description	string	Text describing the contents of the payment	N
paymentDate	datetime	Date when the payment was performed	N
account	object	Account reference. A account may be a party account or a financial account.	N
account.id	string	External ID of subscriber or group that owns the wallet.	N
account.name	string	Name of the account	N
totalAmount	object	Amount to be paid/paid (net of taxes)	N
totalAmount.value	number, float	Amount authorized	N
totalAmount.unit	string	Currency (ISO4217 norm uses 3 letters to define the currency)	N
channel	object	The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..	N
channel.name	string	Name of the source who initiated payment.	N
paymentItem	object array	The paymentItem is the result of lettering process. It enables to assign automatically or manually part of incoming payment amount to a bill	N
paymentItem.item	channel	Entity reference schema to be use for all entityRef class.	N
paymentItem.item.id	string	unique identifier.	N
paymentItem.item.@referredType	string	paymentItem referredType	N
paymentMethod	object	link to the resource that holds information about the payment mean used to complete the operation	N
paymentMethod.description	string	Descriptive name of payment method type used to authorize payment	N
paymentMethod.name	string	Descriptive name for payment method used to authorize payment.	N
paymentMethod.@type	string	When sub-classing, this defines the sub-class entity name	N
extendedCharacteristic	array	Describes the characteristic of a payment	N
extendedCharacteristic.value		The value of the characteristic.	N
extendedCharacteristic.name		Name of the characteristic.	N

extendedCharacteristic

name	type	description	required
PaymentGatewayResult	string	Result returned from payment gateway	N
ProcessorResponseCode	string	Processor Response Code	N
ProcessorResponseText	string	Processor Response Text	N
ProcessorResponseType	string	Processor Response Type	N

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400 ,
      "message" : "The request is invalid or not properly formed.",
      "description" : "Badrequest"
    }
  ]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401 ,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }
  ]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{

      "code" : 404,
       "message" : "The request is invalid or not properly formed.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }
  ]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method post not allowed for : /{businessId}/payment"
        }]
}

[ 429 ]

Too Many Requests - client has sent too many requests in a space of time (rate limiting). When a server is under attack or just receiving a very large number of requests from a single party, responding to each with a 429 status code will consume resources. Therefore, servers may drop connections or take other steps instead of responding with the 429 status code, when limiting resource usage.

{
  "errors" : [{

      "code" : 429,
       "message" : "The request is invalid or not properly formed.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }
  ]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "The request failed due to an internal error.",
      "description": ""
    }
  ]
}

[ 501]

{
   "errors":[
      {
         "code":501,
         "message":"Not implemented",
         "description":"Operation GET /payment for Business Id: XXXX not implemented"
      }
   ]
}

[ 503 ]

Service Unavailable - temporary maintenance of service, try again later. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay will be indicated in a Retry-After header. If no Retry-After is given, the client SHOULD handle the response as it would for a 500 response. Note: The existence of the 503 status code does not imply that a server will use it when becoming overloaded. Servers may simply refuse the connection.

Administration and data management

In this section you define all the transformations, temporary and final repositories of the data within the method flow.

Transformation Request

In this section the matrix of all the data transformations that is carried out within the service is defined.

Original Payload	Mulesoft	transformation
payload		payload

Transformation Response