Lokki

Lokki Payment API

The Payment API from Lokki — 9 operation(s) for payment.

GitHub OpenAPI

Operations 9

GET /v2/payment/adyen/payment-methods #
GET /v2/payment/admin/exportAllLokkiPaymentTransactionsCsv #
GET /v2/payment/lokkiPayment/stripeExpress/status #
GET /v2/payment/lokkiPayment/dashboard/infos #
GET /v2/payment/lokkiPayment/balance #
GET /v2/payment/lokkiPayment/transactions #
GET /v2/payment/lokkiPayment/payouts #
POST /v2/payment/checkout/stripe/initiate #

Documentation

📖
Documentation
https://docs.getlokki.com/
📖
APIReference
https://docs.getlokki.com/api-reference/getting-started
📖
GettingStarted
https://docs.getlokki.com/api-reference/getting-started
📖
Authentication
https://docs.getlokki.com/api-reference/authentication
📖
Documentation
https://prod.api.eu-west-3.lokki.rent/v2/api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lokki/refs/heads/main/openapi/lokki-payment-api-openapi.yml

Other Resources

🔗
Deprecation
https://docs.getlokki.com/api-reference/stores/deprecations
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/lokki/refs/heads/main/data-model/lokki-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/lokki/refs/heads/main/errors/lokki-problem-types.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/lokki-payment-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

lokki-payment-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Lokki Payment API
  description: The main API powering the Lokki Dashboard and Online Store
  version: '2.0'
  contact: {}
servers: []
security:
- x-access-token: []
tags:
- name: Payment
paths:
  /v2/payment/adyen/payment-methods:
    get:
      operationId: getAdyenPaymentMethods
      parameters:
      - name: companyId
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Payment
  /v2/payment/admin/exportAllLokkiPaymentTransactionsCsv:
    get:
      operationId: exportAllLokkiPaymentTransactionCSV
      parameters:
      - name: companyIds
        required: true
        in: query
        schema:
          type: array
          items:
            type: string
      - name: startDate
        required: true
        in: query
        schema:
          format: date-time
          type: string
      - name: endDate
        required: true
        in: query
        schema:
          format: date-time
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LokkiPaymentTransactionsCSVResponse'
      tags:
      - Payment
  /v2/payment/lokkiPayment/stripeExpress/status:
    get:
      operationId: getLokkiPaymentStripeExpressStatus
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStripeExpressAcountStatusRespDto'
      tags:
      - Payment
  /v2/payment/lokkiPayment/dashboard/infos:
    get:
      operationId: getLokkiPaymentDashboardInfos
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LokkiPaymentDashboardInfoResponseDto'
      tags:
      - Payment
  /v2/payment/lokkiPayment/balance:
    get:
      operationId: getLokkiPaymentBalance
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LokkiPaymentBalanceResponseDto'
      tags:
      - Payment
  /v2/payment/lokkiPayment/transactions:
    get:
      operationId: getLokkiPaymentTransactions
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LokkiPaymentTransactionsDto'
      tags:
      - Payment
  /v2/payment/lokkiPayment/payouts:
    get:
      operationId: getLokkiPaymentPayouts
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LokkiPaymentPayoutsDto'
      tags:
      - Payment
  /v2/payment/lokkiPayment/payouts/stripe-login-link:
    get:
      operationId: getStripeLoginLink
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StripeLoginLinkDto'
      tags:
      - Payment
  /v2/payment/checkout/stripe/initiate:
    post:
      operationId: initiateInternalStripeCheckout
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitiateInternalStripeCheckoutDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StripeCheckoutResultDto'
      tags:
      - Payment
components:
  schemas:
    LokkiPaymentTransactionsCSVResponse:
      type: object
      properties:
        csv:
          type: array
          items:
            type: array
            items:
              type: string
      required:
      - csv
    LastPayoutDashboardInfo:
      type: object
      properties:
        date:
          format: date-time
          type: string
        amount:
          type: number
        refundAmount:
          type: number
        fees:
          type: number
      required:
      - date
      - amount
      - refundAmount
      - fees
    LokkiPaymentTransactionsDto:
      type: object
      properties:
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/StripeTransaction'
      required:
      - transactions
    StripePayout:
      type: object
      properties:
        payoutId:
          type: string
        date:
          format: date-time
          type: string
        amount:
          type: number
        fee:
          type: number
        amountHT:
          type: number
        amountRefund:
          type: number
        relatedRefunds:
          type: array
          items:
            $ref: '#/components/schemas/PayoutRelatedRefund'
      required:
      - payoutId
      - date
      - amount
      - fee
      - amountHT
      - amountRefund
    StripePendingPayoutItem:
      type: object
      properties:
        amount:
          type: number
        arrivalDate:
          format: date-time
          type: string
      required:
      - amount
      - arrivalDate
    PayoutRelatedRefund:
      type: object
      properties:
        paymentIntentId:
          type: string
        amount:
          type: number
        date:
          format: date-time
          type: string
      required:
      - paymentIntentId
      - amount
      - date
    GetStripeExpressAcountStatusRespDto:
      type: object
      properties:
        status:
          type: string
          enum:
          - RESTRICTED
          - COMPLETED
      required:
      - status
    StripePendingPayoutDashboardInfo:
      type: object
      properties:
        payouts:
          type: array
          items:
            $ref: '#/components/schemas/StripePendingPayoutItem'
      required:
      - payouts
    LokkiPaymentPayoutsDto:
      type: object
      properties:
        payouts:
          type: array
          items:
            $ref: '#/components/schemas/StripePayout'
      required:
      - payouts
    StripeCheckoutResultDto:
      type: object
      properties:
        paymentClientSecret:
          type: string
      required:
      - paymentClientSecret
    LokkiPaymentBalanceResponseDto:
      type: object
      properties:
        available:
          type: number
        pending:
          type: number
      required:
      - available
      - pending
    InitiateInternalStripeCheckoutDto:
      type: object
      properties:
        amount:
          type: number
        orderId:
          type: string
        isEvent:
          type: boolean
        paymentCheckoutType:
          type: string
          enum:
          - PAYMENT
          - BAIL
      required:
      - amount
      - orderId
      - isEvent
      - paymentCheckoutType
    StripeLoginLinkDto:
      type: object
      properties:
        url:
          type: string
      required:
      - url
    NextPayoutDashboardInfo:
      type: object
      properties:
        amount:
          type: number
        refundAmount:
          type: number
        fees:
          type: number
        pendingAmount:
          type: number
        pendingFees:
          type: number
      required:
      - amount
      - fees
    StripeTransaction:
      type: object
      properties:
        status:
          type: string
        date:
          format: date-time
          type: string
        amount:
          type: number
        fee:
          type: number
        amountHT:
          type: number
      required:
      - status
      - date
      - amount
      - fee
      - amountHT
    LokkiPaymentDashboardInfoResponseDto:
      type: object
      properties:
        monthAmount:
          type: number
        monthFees:
          type: number
        lastPayout:
          $ref: '#/components/schemas/LastPayoutDashboardInfo'
        nextPayout:
          $ref: '#/components/schemas/NextPayoutDashboardInfo'
        stripePendingPayout:
          $ref: '#/components/schemas/StripePendingPayoutDashboardInfo'
      required:
      - monthAmount
      - monthFees
      - nextPayout
  securitySchemes:
    x-access-token:
      scheme: bearer
      bearerFormat: JWT
      type: apiKey
      in: header
      name: x-access-token