BanQu

BanQu Payment Adjustments API

Adjustments of payments on buy/sell transactions

GitHub OpenAPI

Operations 6

GET /payment-adjustments Get payment adjustments #
POST /payment-adjustments Create payment adjustments #
GET /payment-adjustments/{paymentAdjustmentId} Get payment adjustments by payment adjustment id #
PUT /payment-adjustments/{paymentAdjustmentId} Replace payment adjustments by payment adjustment id #
POST /payment-adjustments/{paymentAdjustmentId} Create payment adjustments by payment adjustment id #
DELETE /payment-adjustments/{paymentAdjustmentId} Delete payment adjustments by payment adjustment id #

Documentation

📖
Documentation
https://api.banqu.app/openapi
📖
APIReference
https://api.banqu.app/openapi
📖
Authentication
https://artifacts.apis.io/banqu/authentication/banqu-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/banqu/openapi/banqu-payment-adjustments-api-openapi.yml

Other Resources

🔗
Conventions
https://artifacts.apis.io/banqu/conventions/banqu-conventions.yml
🔗
ErrorCatalog
https://artifacts.apis.io/banqu/errors/banqu-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/banqu/data-model/banqu-data-model.yml
🔗
Webhooks
https://artifacts.apis.io/banqu/asyncapi/banqu-webhooks.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/banqu:banqu-payment-adjustments-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

banqu-payment-adjustments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: BanQu Payment Adjustments API
  version: 3.3.4
  description: The BanQu API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP verbs, which can be understood by off-the-shelf HTTP clients, and JSON for input and output.
servers:
- url: https://banqu.app:443/api/v1
security:
- Bearer: []
tags:
- name: Payment Adjustments
  description: Adjustments of payments on buy/sell transactions
paths:
  /payment-adjustments:
    get:
      tags:
      - Payment Adjustments
      parameters:
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/SortBy'
      - in: query
        name: archived
        schema:
          type: string
          enum:
          - '1'
          - '0'
        description: a 1/0 flag to indicate archived payment adjustments. Default is '0'.
      responses:
        '200':
          description: A list of payment adjustments
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PaymentAdjustmentList'
        '401':
          $ref: '#/components/responses/401'
      summary: Get payment adjustments
      x-summary-source: derived
      operationId: getPaymentAdjustments
      x-operation-id-source: derived
    post:
      description: Register payment adjustment
      tags:
      - Payment Adjustments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentAdjustment'
      responses:
        '201':
          $ref: '#/components/responses/201'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
      summary: Create payment adjustments
      x-summary-source: derived
      operationId: postPaymentAdjustments
      x-operation-id-source: derived
  /payment-adjustments/{paymentAdjustmentId}:
    parameters:
    - name: paymentAdjustmentId
      description: Unique id of a payment adjustment
      in: path
      schema:
        type: string
      required: true
    get:
      description: Get a payment adjustment by id
      tags:
      - Payment Adjustments
      responses:
        '200':
          description: Payment adjustment model
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/PaymentAdjustment'
                - $ref: '#/components/schemas/ScimResourceMetadata'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
      summary: Get payment adjustments by payment adjustment id
      x-summary-source: derived
      operationId: getPaymentAdjustmentsByPaymentAdjustmentId
      x-operation-id-source: derived
    put:
      description: Modify a payment adjustment
      tags:
      - Payment Adjustments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentAdjustment'
      responses:
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
      summary: Replace payment adjustments by payment adjustment id
      x-summary-source: derived
      operationId: putPaymentAdjustmentsByPaymentAdjustmentId
      x-operation-id-source: derived
    post:
      description: Restore a payment adjustment
      tags:
      - Payment Adjustments
      responses:
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
      summary: Create payment adjustments by payment adjustment id
      x-summary-source: derived
      operationId: postPaymentAdjustmentsByPaymentAdjustmentId
      x-operation-id-source: derived
    delete:
      description: Archive a payment adjustment
      tags:
      - Payment Adjustments
      responses:
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
      summary: Delete payment adjustments by payment adjustment id
      x-summary-source: derived
      operationId: deletePaymentAdjustmentsByPaymentAdjustmentId
      x-operation-id-source: derived
components:
  responses:
    '400':
      description: "HTTP 400 - Bad Request \nThe request is formatted incorrectly, most likely some of the required parameters are missed"
    '204':
      description: "HTTP 204 - No Content \nThe request has been processed, but no content will be provided in response"
    '401':
      description: "HTTP 401 - Unauthorized \nUser is not authenticated or session has expired"
    '201':
      description: HTTP 201 - Created
      headers:
        Location:
          schema:
            type: string
          description: Url of the created entity
    '404':
      description: "HTTP 404 - Not Found \nRequested resource could not be found"
  schemas:
    ScimResourceMetadata:
      type: object
      readOnly: true
      properties:
        displayName:
          type: string
          readOnly: true
        meta:
          type: object
          properties:
            resourceType:
              type: string
              readOnly: true
            created:
              type: number
              readOnly: true
            lastModified:
              type: number
              readOnly: true
          required:
          - resourceType
          - created
          - lastModified
      required:
      - displayName
      - meta
    PaymentAdjustment:
      oneOf:
      - $ref: '#/components/schemas/PercentagePaymentAdjustment'
      - $ref: '#/components/schemas/CurrencyPaymentAdjustment'
    PaymentAdjustmentList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/PaymentAdjustment'
        - $ref: '#/components/schemas/ScimResourceMetadata'
    CurrencyPaymentAdjustment:
      type: object
      properties:
        title:
          type: string
        type:
          type: string
          enum:
          - charge
          - allowance
        calculationType:
          type: string
          enum:
          - currency
        amount:
          type: number
          minimum: 0
        currency:
          type: string
        flexible:
          type: boolean
        min:
          type: number
          minimum: 0
        max:
          type: number
          minimum: 0
        archived:
          type: boolean
          readOnly: true
      required:
      - title
      - type
      - flexible
      - calculationType
      - currency
    PercentagePaymentAdjustment:
      type: object
      properties:
        title:
          type: string
        type:
          type: string
          enum:
          - charge
          - allowance
        calculationType:
          type: string
          enum:
          - percentage
        percent:
          type: number
          minimum: 0
        flexible:
          type: boolean
        min:
          type: number
          minimum: 0
        max:
          type: number
          minimum: 0
        archived:
          type: boolean
          readOnly: true
      required:
      - title
      - type
      - flexible
      - calculationType
  parameters:
    Offset:
      name: offset
      in: query
      schema:
        type: number
        minimum: 0
        default: 0
      description: 0-based index of the first element
      required: false
    Limit:
      name: limit
      in: query
      schema:
        type: number
        default: 20
        minimum: 1
      description: Number or items per page
      required: false
    SortBy:
      name: sortBy
      in: query
      schema:
        type: string
      description: Comma-separated list of fields to sort the collection by (i.e. "status:asc,created:desc")
      required: false
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Your authentication token