Incentivio

Incentivio Gift Card Payment Controller API

The gift-card-payment-controller API from Incentivio — 4 operation(s) for gift-card-payment-controller.

GitHub OpenAPI

Operations 4

POST /giftcard/purchase/payment/prepare #
POST /giftcard/add-value/payment/prepare #
POST /ecard/purchase/payment/prepare #
GET /giftcard/transaction/{incentiviotxid}/payment/status #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/authentication/incentivio-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/openapi/incentivio-gift-card-payment-controller-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/conventions/incentivio-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/errors/incentivio-error-codes.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/data-model/incentivio-data-model.yml
🔗
WellKnown
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/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-gift-card-payment-controller-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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-payment-controller-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenAPI definition Gift Card Payment Controller API
  version: v0
servers:
- url: https://mobile.incentivio.com/incentivio-mobile-api
  description: Generated server url
tags:
- name: gift-card-payment-controller
paths:
  /giftcard/purchase/payment/prepare:
    post:
      tags:
      - gift-card-payment-controller
      operationId: purchaseAndEmailGiftCardPreparePayment
      parameters:
      - name: CLIENTID
        in: header
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseAndEmailGiftCardRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreparePaymentResponseDTO'
  /giftcard/add-value/payment/prepare:
    post:
      tags:
      - gift-card-payment-controller
      operationId: addValueToGiftCardPreparePayment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddValueRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreparePaymentResponseDTO'
  /ecard/purchase/payment/prepare:
    post:
      tags:
      - gift-card-payment-controller
      operationId: purchaseECardPreparePayment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseECardRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreparePaymentResponseDTO'
  /giftcard/transaction/{incentiviotxid}/payment/status:
    get:
      tags:
      - gift-card-payment-controller
      operationId: checkTxPaymentStatus
      parameters:
      - name: incentiviotxid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GiftCardTransactionResponseDTO'
components:
  schemas:
    PreparePaymentResponseDTO:
      type: object
      properties:
        attributes:
          type: object
          additionalProperties:
            type: string
    PurchaseAndEmailGiftCardRequestDTO:
      required:
      - amount
      - paymentType
      - sourceType
      type: object
      properties:
        clientId:
          type: string
        userId:
          type: string
        amount:
          type: integer
          format: int32
        locationId:
          type: string
        sourceType:
          type: string
        paymentType:
          type: string
          enum:
          - CARD_NOT_PRESENT
          - CARD_PRESENT
          - CASH
          - THIRD_PARTY
          - APPLE_PAY
          - ANDROID_PAY
          - SAMSUNG_PAY
          - NO_PAYMENT
          - GOOGLE_PAY
          - ONE_TIME_TOKEN
          - PERMANENT_TOKEN
          - GIFT_CARD
          - PAYMENT_SKIPPED
        paymentMode:
          type: string
          enum:
          - PAYMENT_MANDATORY
          - PAYMENT_OPTIONAL
          - NO_PAYMENT
        paymentToken:
          type: string
        cardType:
          type: string
        paymentMethodType:
          type: string
        zipCode:
          type: string
        additionalAttributes:
          type: object
          additionalProperties:
            type: string
        isOneTimeTransaction:
          type: boolean
        expirationYear:
          type: integer
          format: int32
        expirationMonth:
          type: integer
          format: int32
        recipient:
          $ref: '#/components/schemas/GiftCardRecipient'
        sender:
          $ref: '#/components/schemas/GiftCardSender'
        from:
          type: string
        oneTimeTransaction:
          type: boolean
    GiftCardTransactionResponseDTO:
      type: object
      properties:
        transactionType:
          type: string
        cardIdentifier:
          type: string
        securityCode:
          type: string
        cardAccountBalance:
          type: number
          format: double
        transactionValue:
          type: number
          format: double
        cardStatus:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
        paymentStatus:
          type: string
        transactionStatus:
          type: string
        rootErrors:
          type: object
          additionalProperties:
            type: string
        extendedAttributes:
          type: object
          additionalProperties:
            type: string
    GiftCardSender:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        phone:
          type: string
        customerId:
          type: string
        adminId:
          type: string
    GiftCardRecipient:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
        message:
          type: string
    AddValueRequestDTO:
      required:
      - amount
      - cardIdentifier
      - paymentType
      - sourceType
      type: object
      properties:
        clientId:
          type: string
        userId:
          type: string
        amount:
          type: integer
          format: int32
        cardIdentifier:
          type: string
        locationId:
          type: string
        sourceType:
          type: string
        paymentType:
          type: string
          enum:
          - CARD_NOT_PRESENT
          - CARD_PRESENT
          - CASH
          - THIRD_PARTY
          - APPLE_PAY
          - ANDROID_PAY
          - SAMSUNG_PAY
          - NO_PAYMENT
          - GOOGLE_PAY
          - ONE_TIME_TOKEN
          - PERMANENT_TOKEN
          - GIFT_CARD
          - PAYMENT_SKIPPED
        paymentMode:
          type: string
          enum:
          - PAYMENT_MANDATORY
          - PAYMENT_OPTIONAL
          - NO_PAYMENT
        paymentToken:
          type: string
        cardType:
          type: string
        paymentMethodType:
          type: string
        zipCode:
          type: string
        additionalAttributes:
          type: object
          additionalProperties:
            type: string
        isOneTimeTransaction:
          type: boolean
        expirationYear:
          type: integer
          format: int32
        expirationMonth:
          type: integer
          format: int32
        oneTimeTransaction:
          type: boolean
    PurchaseECardRequestDTO:
      required:
      - amount
      - paymentType
      - sourceType
      type: object
      properties:
        clientId:
          type: string
        userId:
          type: string
        amount:
          type: integer
          format: int32
        locationId:
          type: string
        sourceType:
          type: string
        paymentType:
          type: string
          enum:
          - CARD_NOT_PRESENT
          - CARD_PRESENT
          - CASH
          - THIRD_PARTY
          - APPLE_PAY
          - ANDROID_PAY
          - SAMSUNG_PAY
          - NO_PAYMENT
          - GOOGLE_PAY
          - ONE_TIME_TOKEN
          - PERMANENT_TOKEN
          - GIFT_CARD
          - PAYMENT_SKIPPED
        paymentMode:
          type: string
          enum:
          - PAYMENT_MANDATORY
          - PAYMENT_OPTIONAL
          - NO_PAYMENT
        paymentToken:
          type: string
        cardType:
          type: string
        paymentMethodType:
          type: string
        zipCode:
          type: string
        additionalAttributes:
          type: object
          additionalProperties:
            type: string
        isOneTimeTransaction:
          type: boolean
        expirationYear:
          type: integer
          format: int32
        expirationMonth:
          type: integer
          format: int32
        oneTimeTransaction:
          type: boolean