Otter · JSON Structure

Public Api Payment Record Structure

Represents the details and metadata of a payment method used in transactions.

Type: object Properties: 7
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

PaymentRecord is a JSON Structure definition published by Otter, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

otterPaymentRecordId recordProviderType recordPaymentType paymentRecordId payerId balanceTransactionId paymentDetails

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-structure/public-api-payment-record-structure.json",
  "name": "PaymentRecord",
  "description": "Represents the details and metadata of a payment method used in transactions.",
  "type": "object",
  "properties": {
    "otterPaymentRecordId": {
      "type": "string",
      "description": "The identifier for the payment record in the Otter system, for reference.",
      "example": "otter_123456789"
    },
    "recordProviderType": {
      "description": "The type of payment provider.",
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-record-provider-type-schema.json"
    },
    "recordPaymentType": {
      "description": "The type of payment method.",
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-record-payment-type-schema.json"
    },
    "paymentRecordId": {
      "type": "string",
      "description": "The identifier for the payment record from the payment provider.",
      "example": "pm_123456789"
    },
    "payerId": {
      "type": "string",
      "description": "The identifier for the payer from the payment provider.",
      "example": "payer_123456789"
    },
    "balanceTransactionId": {
      "type": "string",
      "description": "The balance transaction ID from the payment provider.",
      "example": "ext_bt_123456789"
    },
    "paymentDetails": {
      "description": "One of the possible payment method details, depending on the payment method type.",
      "oneOf": [
        {
          "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-payment-details-card-schema.json"
        },
        {
          "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-payment-details-bacs-schema.json"
        },
        {
          "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-payment-details-acss-schema.json"
        },
        {
          "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-payment-details-becs-schema.json"
        },
        {
          "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-payment-details-sepa-schema.json"
        },
        {
          "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-payment-details-ach-schema.json"
        }
      ]
    }
  }
}

Work with this as data

Every JSON Structure 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 json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure 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 Structure
curl "https://apis.io/api/v1/json-structures/public-api-payment-record-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?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.