Tapfiliate

Tapfiliate Payments API

Manage affiliate payments

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /payments/{id}/ Retrieve an affiliate payment · Retrieve payment #
Ask an LLM
“Can I look up a single affiliate payment by its ID?”
“What details are stored on one payout payment?”
Tell an agent
Get payment {id}.
Show me the details of affiliate payment {id}.
DELETE /payments/{id}/ Cancel a pending payment · Cancel payment #
Ask an LLM
“How do I cancel an affiliate payment that hasn't gone out yet?”
“Can I stop a pending payout before it's processed?”
Tell an agent destructive · confirm first
Cancel payment {id}.
Cancel the pending affiliate payment {id}.
GET /payments/ List affiliate payments · List all payments #
Ask an LLM
“Which affiliate payments were paid out during a given period?”
“Can I filter the payment history to one affiliate?”
Tell an agent
List all payments.
Show payments paid between {paid_at_from} and {paid_at_to}.
POST /payments/ Create an affiliate payment batch · Create a payment #
Ask an LLM
“How do I pay out several affiliates in one batch?”
“Which currency does a new payment batch use?”
Tell an agent
Create a payment in {currency} for affiliates {affiliates}.
Start a new payout batch in {currency} covering {affiliates}.

Documentation

📖
Documentation
https://tapfiliate.com/docs/rest/
📖
Authentication
https://tapfiliate.com/docs/rest/#authentication

Specifications

⚙
OpenAPI
https://artifacts.apis.io/tapfiliate/openapi/tapfiliate-payments-api-openapi.yml

Other Resources

🔗
Overlay
https://artifacts.apis.io/tapfiliate/overlays/tapfiliate-payments-overlay.yaml

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/tapfiliate:tapfiliate-payments-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

tapfiliate-payments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Tapfiliate REST Payments API
  description: Tapfiliate is an affiliate tracking and management platform. This REST API allows you to create and manage affiliate programs, track conversions, manage affiliates, handle commission payouts, and record clicks. The API is versioned at V1.6 and uses API key authentication via the X-Api-Key header.
  version: '1.6'
  contact:
    name: Tapfiliate Support
    url: https://tapfiliate.com/docs/rest/
  termsOfService: https://tapfiliate.com/terms/
servers:
- url: https://api.tapfiliate.com/1.6
  description: Tapfiliate REST API v1.6
security:
- ApiKeyAuth: []
tags:
- name: Payments
  description: Manage affiliate payments
paths:
  /payments/{id}/:
    get:
      operationId: getPayment
      summary: Retrieve payment
      description: Retrieve a single payment by ID.
      tags:
      - Payments
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Payment ID
      responses:
        '200':
          description: Payment retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: cancelPayment
      summary: Cancel payment
      description: Cancel a pending payment.
      tags:
      - Payments
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Payment ID
      responses:
        '200':
          description: Payment cancelled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /payments/:
    get:
      operationId: listPayments
      summary: List all payments
      description: Retrieve a paginated list of all payments.
      tags:
      - Payments
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/limit'
      - name: affiliate_id
        in: query
        schema:
          type: string
        description: Filter by affiliate ID
      - name: paid_at_from
        in: query
        schema:
          type: string
          format: date
        description: Filter payments from this date
      - name: paid_at_to
        in: query
        schema:
          type: string
          format: date
        description: Filter payments to this date
      responses:
        '200':
          description: List of payments
          headers:
            Link:
              $ref: '#/components/headers/PaginationLink'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Payment'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createPayment
      summary: Create a payment
      description: Create a new payment batch for affiliates.
      tags:
      - Payments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - currency
              - affiliates
              properties:
                currency:
                  type: string
                  description: ISO 4217 currency code
                affiliates:
                  type: array
                  items:
                    type: object
                    required:
                    - affiliate
                    - amount
                    properties:
                      affiliate:
                        type: object
                        properties:
                          id:
                            type: string
                      amount:
                        type: number
                        format: float
                      commission_ids:
                        type: array
                        items:
                          type: string
      responses:
        '201':
          description: Payment created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
components:
  responses:
    Unauthorized:
      description: Authentication failed — missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    UnprocessableEntity:
      description: Validation error — request body is invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    limit:
      name: limit
      in: query
      schema:
        type: integer
        default: 50
        minimum: 1
        maximum: 100
      description: Number of results per page
    page:
      name: page
      in: query
      schema:
        type: integer
        default: 1
        minimum: 1
      description: Page number for pagination
  schemas:
    AffiliateRef:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
          format: email
        firstname:
          type: string
        lastname:
          type: string
    Error:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message
    Payment:
      type: object
      properties:
        id:
          type: string
        affiliate:
          $ref: '#/components/schemas/AffiliateRef'
        amount:
          type: number
          format: float
        currency:
          type: string
          description: ISO 4217 currency code
        paid_at:
          type:
          - string
          - 'null'
          format: date-time
        status:
          type: string
          enum:
          - pending
          - paid
          - cancelled
  headers:
    PaginationLink:
      description: Links to navigate between pages. Contains rel="next", rel="prev", rel="first", and rel="last" links as per RFC 5988.
      schema:
        type: string
      example: <https://api.tapfiliate.com/1.6/conversions/?page=3>; rel="next", <https://api.tapfiliate.com/1.6/conversions/?page=51>; rel="last"
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
x-provenance:
  method: harvested
  publisher: Tapfiliate
  source: https://developers.tapfiliate.com/api-reference/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)