get https://{host}/x/neo/pointsAllocationId/transactionId
This API retrieves the points‐award records associated with a specific transaction ID. Each record shows the category under which points were awarded, the unique award ID, the customer who earned them, and the loyalty program.
Note
This API is a private API that has been exposed through Neo and made public.
Prerequisites
- Basic or OAuth authentication credentials
- Header
x-cap-neo-dag-scopeset to a valid scope value (e.g.global) transaction_id(integer)
Resource information
| URL | /x/neo/pointsAllocationId/transactionId?transaction_id={transactionId} |
| HTTP method | GET |
| Pagination | No |
| Rate limit | N/A |
| Batch support | N/A |
API endpoint example
https://dev.api.capillarytech.com/x/neo/pointsAllocationId/transactionId?transaction_id=2151090345Request query parameters
| Parameter | Data Type | Description |
|---|---|---|
transaction_id* | Integer | Unique identifier of the transaction for which to retrieve points‐award records. |
- Mandatory parameter
Sample Request
curl --location 'https://dev.api.capillarytech.com/x/neo/pointsAllocationId/transactionId?transaction_id=2151090345' \
--header 'Content-Type: application/json' \
--header 'x-cap-neo-dag-scope: global' \
--header 'Authorization: Basic ZGV2LmRzLnRpbGwwMjoyMDJjYjk2MmFjNTkwNiOTY0YjA3MTUyZDIzNGI3MA==' \
--header 'Cookie: _cfuvid=Azq8pU.vLFQFz1dokJOcKQlnOdEJB31.pqwBHrepJ14-1747219493263-0.0.1.1-604800000'Response parameters
| Parameter | Data Type | Description |
|---|---|---|
pointsCategoryId | Integer | Identifier of the category under which these points were awarded. |
pointsAwardedId | Integer | Unique identifier for this specific points‐award record. |
customerId | Integer | Unique identifier of the customer who earned these points. |
programId | Integer | Identifier of the loyalty program in which points were awarded. |
Sample Response
[
{
"pointsCategoryId": 131,
"pointsAwardedId": 38060732,
"customerId": 381618579,
"programId": 33
},
{
"pointsCategoryId": 134,
"pointsAwardedId": 38060733,
"customerId": 381618579,
"programId": 33
}
]API Error Codes
| Error code | Message | Description |
|---|---|---|
400 | Bad Request | Missing or invalid transaction_id parameter. |
401 | Unauthorized | Missing or invalid authentication credentials. |
404 | Not Found | No points‐award records found for the given transaction. |
500 | Server Error | Unexpected server error. |