Incentivio

Incentivio Gift Card Client Onboard Controller API

The gift-card-client-onboard-controller API from Incentivio — 6 operation(s) for gift-card-client-onboard-controller.

GitHub OpenAPI

Operations 6

POST /incentivio-giftcard-service/giftcard/location-config/update Update gift card location config #
POST /incentivio-giftcard-service/giftcard/client-config/update Update gift card client config #
GET /incentivio-giftcard-service/location/{locationid}/giftcard/location-config Get gift card location config #
GET /incentivio-giftcard-service/giftcard/providers Get gift card providers #
GET /incentivio-giftcard-service/giftcard/locations-config Get gift card locations config #
GET /incentivio-giftcard-service/client/{clientid}/giftcard/client-config Get gift card client config #

Documentation

📖
Authentication
https://artifacts.apis.io/incentivio/authentication/incentivio-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/incentivio/openapi/incentivio-gift-card-client-onboard-controller-api-openapi.yml

Other Resources

🔗
Conventions
https://artifacts.apis.io/incentivio/conventions/incentivio-conventions.yml
🔗
ErrorCatalog
https://artifacts.apis.io/incentivio/errors/incentivio-error-codes.yml
🔗
DataModel
https://artifacts.apis.io/incentivio/data-model/incentivio-data-model.yml
🔗
WellKnown
https://artifacts.apis.io/incentivio/well-known/incentivio-well-known.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/incentivio:incentivio-gift-card-client-onboard-controller-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

incentivio-gift-card-client-onboard-controller-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenAPI definition Gift Card Client Onboard Controller API
  version: v0
servers:
- url: https://adminapi.incentivio.com/incentivio-admin-api
  description: Generated server url
tags:
- name: gift-card-client-onboard-controller
paths:
  /incentivio-giftcard-service/giftcard/location-config/update:
    post:
      tags:
      - gift-card-client-onboard-controller
      operationId: updateGiftCardLocationConfig
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GiftCardLocationConfigUpdateRequest'
        required: true
      responses:
        '200':
          description: OK
      summary: Update gift card location config
      x-summary-source: derived
  /incentivio-giftcard-service/giftcard/client-config/update:
    post:
      tags:
      - gift-card-client-onboard-controller
      operationId: updateGiftCardClientConfig
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GiftCardClientConfigUpdateRequest'
        required: true
      responses:
        '200':
          description: OK
      summary: Update gift card client config
      x-summary-source: derived
  /incentivio-giftcard-service/location/{locationid}/giftcard/location-config:
    get:
      tags:
      - gift-card-client-onboard-controller
      operationId: getGiftCardLocationConfig
      parameters:
      - name: locationid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                additionalProperties:
                  type: string
      summary: Get gift card location config
      x-summary-source: derived
  /incentivio-giftcard-service/giftcard/providers:
    get:
      tags:
      - gift-card-client-onboard-controller
      operationId: getGiftCardProviders
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  type: string
      summary: Get gift card providers
      x-summary-source: derived
  /incentivio-giftcard-service/giftcard/locations-config:
    get:
      tags:
      - gift-card-client-onboard-controller
      operationId: getGiftCardLocationsConfig
      parameters:
      - name: locationFilter
        in: query
        required: false
        schema:
          type: string
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 1000
      - name: sortBy
        in: query
        required: false
        schema:
          type: string
          default: noConfiguredLocations
      - name: sortDirection
        in: query
        required: false
        schema:
          type: string
          default: ASC
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GiftCardLocationConfig'
      summary: Get gift card locations config
      x-summary-source: derived
  /incentivio-giftcard-service/client/{clientid}/giftcard/client-config:
    get:
      tags:
      - gift-card-client-onboard-controller
      operationId: getGiftCardClientConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GiftCardClientConfigResponse'
      summary: Get gift card client config
      x-summary-source: derived
components:
  schemas:
    GiftCardLocationConfig:
      type: object
      properties:
        locationId:
          type: string
        locationName:
          type: string
        locationConfig:
          type: object
          additionalProperties:
            type: string
    GiftCardClientConfigResponse:
      type: object
      properties:
        giftCardProvider:
          $ref: '#/components/schemas/GiftCardServiceProvider'
        securityCodeEnabled:
          type: boolean
        poolAccountSettings:
          type: object
          additionalProperties:
            type: string
    GiftCardClientConfigUpdateRequest:
      type: object
      properties:
        clientId:
          type: string
        giftCardProvider:
          $ref: '#/components/schemas/GiftCardServiceProvider'
        securityCodeEnabled:
          type: boolean
        poolAccountSettings:
          type: object
          additionalProperties:
            type: string
    GiftCardLocationConfigUpdateRequest:
      type: object
      properties:
        locationId:
          type: string
        locationSettings:
          type: object
          additionalProperties:
            type: string
    GiftCardServiceProvider:
      type: string
      enum:
      - INCENTIVIO_GIFTCARD_SERVICE
      - WORLDPAY
      - WORLDPAY_VALUETEC
      - GIVEX
      - SQUARE
      - VALUTEC
      - E_CARD_SYSTEMS