Huuray Search API

The Search API from Huuray — 1 operation(s) for search.

Operations 1

POST /v4/Search Used to search through giftcards from previous orders

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/huuray-search-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.

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

OpenAPI Specification

huuray-search-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Huuray Balance Search API
  description: Huuray API for B2B customers (last updated april 2025)
  contact:
    name: Support
    email: tech@huuray.com
  version: v4
servers:
- url: https://api.huuray.com
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Search
paths:
  /v4/Search:
    post:
      tags:
      - Search
      summary: Used to search through giftcards from previous orders
      description: n/a
      parameters:
      - name: X-API-NONCE
        in: header
        description: A random value that can only be used once every 60 days. (max 50 characters)<br /><small>(this prevents your message from being re-transmitted, and thereby also replay attacks)</small>
        required: true
      - name: X-API-HASH
        in: header
        description: 'The SHA512 hash of a concatenated string containing the following: ( API-SECRET + NONCE ).<br /><small>(this is used to authenticate you)</small>'
        required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
      security:
      - ApiToken: []
components:
  schemas:
    Response:
      type: object
      properties:
        Status:
          type: integer
          description: HttpStatus code for the response
          format: int32
        Message:
          type:
          - string
          - 'null'
          description: Deprecated, use StatusMessage instead. Error message describing an error that occurred during the processing of the request
          deprecated: true
        StatusMessage:
          type:
          - string
          - 'null'
          description: Status message describing an error that occurred during the processing of the request
      additionalProperties: false
      description: The minimal possible response for any request
    SearchResponse:
      title: Search Response
      type: object
      properties:
        OrderUID:
          type:
          - string
          - 'null'
          description: The unique identifier of the matched order
        RefID:
          type:
          - string
          - 'null'
          description: The internal reference to the corresponding order in your own system
        Vouchers:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SearchVoucher'
          description: The list of the matching vouchers
        Status:
          type: integer
          description: HttpStatus code for the response
          format: int32
        Message:
          type:
          - string
          - 'null'
          description: Deprecated, use StatusMessage instead. Error message describing an error that occurred during the processing of the request
          deprecated: true
        StatusMessage:
          type:
          - string
          - 'null'
          description: Status message describing an error that occurred during the processing of the request
      additionalProperties: false
      description: The response from a search
    SearchRequest:
      title: Search Request
      type: object
      properties:
        OrderUID:
          type:
          - string
          - 'null'
          description: The unique identifier of the order
        VoucherID:
          type:
          - integer
          - 'null'
          description: The unique identifier of the voucher (required to show code in output)
          format: int32
        ProductToken:
          type:
          - string
          - 'null'
          description: The token that identifies the product to be sent out
        RefID:
          type:
          - string
          - 'null'
          description: The internal reference to an order in your own system
        SMSTemplateID:
          type:
          - integer
          - 'null'
          description: The unique identifier of the SMS template (Required if sending via SMS)
          format: int32
        EmailTemplateID:
          type:
          - integer
          - 'null'
          description: The unique identifier of the e-mail template (Required if sending via e-mail)
          format: int32
        DeliveryDatetime:
          type:
          - string
          - 'null'
          description: The future date for delivery to take place
          format: date-time
        RecipientName:
          type:
          - string
          - 'null'
          description: The name of the recipient (either person or company)
        RecipientEmail:
          type:
          - string
          - 'null'
          description: The e-mail address of the recipient (Required if sending via e-mail)
        RecipientPhone:
          type:
          - string
          - 'null'
          description: The phone number of the recipient (Required if sending via SMS)
        RecipientRefID:
          type:
          - string
          - 'null'
          description: The internal reference to an recipient in your own system
      additionalProperties: false
      description: An object containing all the informations you can search for
    SearchVoucher:
      title: Voucher (Search)
      type: object
      properties:
        ID:
          type:
          - integer
          - 'null'
          description: The unique identifier of the voucher (required to show code in output)
          format: int32
        Code:
          type:
          - string
          - 'null'
          description: The redeemable code of the voucher
        CVV:
          type:
          - string
          - 'null'
          description: A value used to verify the authenticity of the voucher (if applicable)
        RedeemLink:
          type:
          - string
          - 'null'
          description: The URL to redeem the voucher
        Expires:
          type: string
          description: The time and date for when the voucher expires
          format: date-time
        Recipient:
          $ref: '#/components/schemas/SearchRecipient'
      additionalProperties: false
      description: An object containing information about a voucher
    SearchRecipient:
      title: Recipient (Search)
      type: object
      properties:
        Name:
          type:
          - string
          - 'null'
          description: The name of the recipient (either person or company)
        Email:
          type:
          - string
          - 'null'
          description: The e-mail address of the recipient
        Phone:
          type:
          - string
          - 'null'
          description: The phone number of the recipient
        RefID:
          type:
          - string
          - 'null'
          description: The internal reference to an recipient in your own system
      additionalProperties: false
      description: An object containing information about a recipient
  securitySchemes:
    ApiToken:
      type: apiKey
      description: The API-Token provided to you by Huuray.
      name: X-API-TOKEN
      in: header