Get 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 MethodGET
PaginationNo
Batch supportNo
Rate limit informationNone

API endpoint example

https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/vendor/36/details

Request path parameters

Parameter NameData TypeDescription
vendorId*IntegerUnique identifier of the vendor. You can get the vendorID from UI.

Response parameters

Parameter NameDescription
successIndicates if the request was successful.
codeResponse status code.
messageMessage describing the status of the response.
idUnique identifier for the vendor.
nameName of the vendor.
brandIdIdentifier for the brand associated with the vendor.
enabledIndicates whether the vendor is enabled or disabled.
vendorDetailsDetails of vendor.
vendorTypesType 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
typeType 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.
redemptionsConfiguredSpecifies the number of redemptions which has been configured.
lastUpdatedOnTimestamp of the last update in since epoch format.
encryptionRequiredIndicates 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 CodeDescription
5004Invalid Vendor ID
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!