Qualpay · Schema

InvoicePaymentRequest

PaymentsPayment ProcessingMerchant ServicesB2B PaymentsReportingTokenization

Properties

Name Type Description
amt_paid number Format: Variable length, up to 10, 2 N
Description: The amount paid. The payment currency should be the same as the invoice currency.
date_payment string Format: Variable length, up to 10 AN, in YYYY-MM-DD format
Description: The date the payment was made.
description string Format: Variable length
Description: A short description of the payment.
transaction_id string Format: Fixed length, 32 AN
Description: The Payment Gateway ID of the applied card payment. This is found as the `pg_id` value in the 'Authorize Transaction' resp
type string Format: Variable length, up to 16 AN
Description: The mode of payment. Select from the following:
  • `CASH` - A cash payment.
  • `CHECK` - A check pa
View JSON Schema on GitHub

JSON Schema

qualpay-invoice-payment-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-invoice-payment-request-schema.json",
  "title": "InvoicePaymentRequest",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/qualpay-invoicing-api-openapi.yml#/components/schemas/InvoicePaymentRequest",
  "required": [
    "amt_paid",
    "date_payment",
    "type"
  ],
  "type": "object",
  "properties": {
    "amt_paid": {
      "type": "number",
      "description": "<strong>Format: </strong>Variable length, up to 10, 2 N<br><strong>Description: </strong>The amount paid. The payment currency should be the same as the invoice currency. ",
      "format": "double"
    },
    "date_payment": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, up to 10 AN, in YYYY-MM-DD format<br><strong>Description: </strong>The date the payment was made."
    },
    "description": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>A short description of the payment."
    },
    "transaction_id": {
      "type": "string",
      "description": "<strong>Format: </strong>Fixed length, 32 AN<br><strong>Description: </strong>The Payment Gateway ID of the applied card payment. This is found as the `pg_id` value in the 'Authorize Transaction' response. Applicable only to a `CREDIT`-type transaction."
    },
    "type": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, up to 16 AN<br><strong>Description: </strong>The mode of payment. Select from the following: <br><ul><li>`CASH` - A cash payment.</li><li>`CHECK` - A check payment.</li><li>`CREDIT` - A credit card payment.</li><li>`OTHER` - Another mode of payment.</li></ul>",
      "enum": [
        "CASH",
        "CHECK",
        "CREDIT",
        "OTHER"
      ]
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/qualpay-invoice-payment-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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