get https://{host}/api_gateway/rewards/core/v1/vendor//details
This API enables you retrieve vendor details using Vendor ID
Note
For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .
Prerequisites
- Authentication: Basic or OAuth authentication
- Default access group
API Specification
| URI | /api_gateway/rewards/core/v1/vendor/{vendorId}/details |
| HTTP Method | GET |
| Pagination | No |
| Batch support | No |
| Rate limit information | None |
API endpoint example
https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/vendor/36/details
Request path parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| vendorId* | Integer | Unique identifier of the vendor. You can get the vendorID from UI. |
Response parameters
| Parameter Name | Description |
|---|---|
| success | Indicates if the request was successful. |
| code | Response status code. |
| message | Message describing the status of the response. |
| id | Unique identifier for the vendor. |
| name | Name of the vendor. |
| brandId | Identifier for the brand associated with the vendor. |
| enabled | Indicates whether the vendor is enabled or disabled. |
| vendorDetails | Details of vendor. |
| vendorTypes | Type of vendor. These are specialized vendor types for which we have implemented customized solutions in our system to handle reward issuance. Supported types: LINKAJA/AIRSPRING/OVO/BONUSLINK |
| type | Type of vendor. Supported Values: REWARDS/POINTS. REWARDS: If the type is set to REWARDS, it refers to a generic vendor used for issuing rewards. POINTS: It is a vendor type that manages the external points system, where each brand can have only one POINTS type vendor. |
| redemptionsConfigured | Specifies the number of redemptions which has been configured. |
| lastUpdatedOn | Timestamp of the last update in since epoch format. |
| encryptionRequired | Indicates if encryption is required for transactions with the vendor. |
{
"status": {
"success": true,
"code": 5001,
"message": "Vendor fetched successfully"
},
"vendor": {
"id": 4,
"name": "OVO",
"brandId": 1,
"enabled": false,
"vendorTypes": "LINKAJA",
"vendorDetails": {},
"type": "REWARDS",
"redemptionsConfigured": 2,
"lastUpdatedOn": 1717759204000,
"encryptionRequired": true
}
}
{
"status": {
"success": false,
"code": 5004,
"message": "Vendor not found"
},
"vendor": null
}
API-specific error codes
| Error Code | Description |
|---|---|
| 5004 | Invalid Vendor ID |