Otter · Schema

CustomerPayment

CustomerPayment schema from Public API (Otter Public API).

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name	Type	Description
value	number	The portion of the overall amount that needs to be paid.
processingStatus	string	The processing status of the payment. (PROCESSED is only valid when the payment method is CARD)
paymentMethod	string	The method of payment.
paymentAuthorizer	string	A payment system type responsible for a card transaction (containing information for payment network and payment type).
cardInfo	object
externalPaymentType	string	External payment type string. Should be only used if not mapped by any value of paymentAuthorizer, and it's value is OTHER_TYPE.
paymentRecords	array	[WIP - in development, not supported yet] List of payment records, including method and card details and ids from payment processing entities.
loyaltyInfo	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CustomerPayment",
  "description": "CustomerPayment schema from Public API (Otter Public API).",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-customer-payment-schema.json",
  "type": "object",
  "properties": {
    "value": {
      "type": "number",
      "description": "The portion of the overall amount that needs to be paid.",
      "example": 2
    },
    "processingStatus": {
      "type": "string",
      "description": "The processing status of the payment. (PROCESSED is only valid when the payment method is CARD)",
      "enum": [
        "COLLECTABLE",
        "PROCESSED"
      ],
      "example": "COLLECTABLE"
    },
    "paymentMethod": {
      "type": "string",
      "description": "The method of payment.",
      "enum": [
        "CASH",
        "CARD",
        "UNKNOWN",
        "OTHER",
        "CHEQUE",
        "GIFT_CARD"
      ],
      "example": "CASH"
    },
    "paymentAuthorizer": {
      "type": "string",
      "description": "A payment system type responsible for a card transaction (containing information for payment network and payment type).",
      "nullable": true,
      "enum": [
        "UNKNOWN_TYPE",
        "OTHER_TYPE",
        "MASTERCARD",
        "MASTERCARD_MAESTRO",
        "MASTERCARD_DEBIT",
        "VISA",
        "VISA_DEBIT",
        "AMEX",
        "VISA_ELECTORN",
        "DINERS",
        "ELO",
        "ELO_DEBIT",
        "HIPERCARD",
        "BANRICOMPRAS",
        "BANRICOMPRAS_DEBIT",
        "NUGO",
        "GOODCARD",
        "VERDECARD",
        "CARNET",
        "CHEF_CARD",
        "GER_CC_CREDITO",
        "TERMINAL_BANCARIA",
        "DEBIT",
        "QR_CODE",
        "RAPPI_PAY",
        "DISCOVER",
        "VALE_GREEN_CARD_PAPEL",
        "VALE_GREEN_CARD_CARD",
        "VALE_REFEISUL",
        "VALE_VEROCARD",
        "VALE_VR_SMART",
        "VALE_SODEXO",
        "VALE_TICKET_RESTAURANTE",
        "VALE_ALELO",
        "VALE_BEN_VIS",
        "VALE_COOPER_CARD",
        "NUTRICARD_REFEICAO_E_ALIMENTACAO",
        "APPLE_PAY_MASTERCARD",
        "APPLE_PAY_VISA",
        "APPLE_PAY_AMEX",
        "GOOGLE_PAY_ELO",
        "GOOGLE_PAY_MASTERCARD",
        "GOOGLE_PAY_VISA",
        "MOVILE_PAY",
        "MOVILE_PAY_AMEX",
        "MOVILE_PAY_DINERS",
        "MOVILE_PAY_ELO",
        "MOVILE_PAY_HIPERCARD",
        "MOVILE_PAY_MASTERCARD",
        "MOVILE_PAY_VISA",
        "IFOOD_CORP",
        "LOOP_CLUB",
        "PAYPAL",
        "PSE",
        "PIX"
      ],
      "example": "UNKNOWN_TYPE"
    },
    "cardInfo": {
      "nullable": true,
      "deprecated": true,
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-card-info-schema.json"
    },
    "externalPaymentType": {
      "type": "string",
      "description": "External payment type string. Should be only used if not mapped by any value of paymentAuthorizer, and it's value is OTHER_TYPE.",
      "nullable": true,
      "example": "string"
    },
    "paymentRecords": {
      "type": "array",
      "nullable": true,
      "description": "[WIP - in development, not supported yet] List of payment records, including method and card details and ids from payment processing entities.",
      "items": {
        "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-payment-record-schema.json"
      }
    },
    "loyaltyInfo": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-loyalty-info-schema.json"
    }
  },
  "required": [
    "paymentMethod",
    "processingStatus",
    "value"
  ]
}

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/public-api-customer-payment"

All schemas

curl "https://apis.io/api/v1/json-schemas?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.