Pix Immediate Charge (Cob)

Banco Central Pix immediate charge as represented by the Efí Pay /v2/cob endpoints.

PaymentsPixBoletoSubscriptionRecurring BillingMarketplaceSplit PaymentsOpen FinanceBanking as a ServiceAccount OpeningBill PaymentsCNABBrazilFintech

Properties

Name Type Description
txid string
status string
valor object
chave string Receiver Pix key (EVP, CPF, CNPJ, email, or phone)
calendario object
devedor object
loc object
solicitacaoPagador string
infoAdicionais array
View JSON Schema on GitHub

JSON Schema

efi-pix-cob-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/gerencianet/main/json-schema/efi-pix-cob-schema.json",
  "title": "Pix Immediate Charge (Cob)",
  "description": "Banco Central Pix immediate charge as represented by the Efí Pay /v2/cob endpoints.",
  "type": "object",
  "required": ["txid", "valor", "chave"],
  "properties": {
    "txid": { "type": "string", "minLength": 26, "maxLength": 35, "pattern": "^[a-zA-Z0-9]+$" },
    "status": { "type": "string", "enum": ["ATIVA", "CONCLUIDA", "REMOVIDA_PELO_USUARIO_RECEBEDOR", "REMOVIDA_PELO_PSP"] },
    "valor": {
      "type": "object",
      "required": ["original"],
      "properties": {
        "original": { "type": "string", "pattern": "^[0-9]+\\.[0-9]{2}$" },
        "modalidadeAlteracao": { "type": "integer", "enum": [0, 1] }
      }
    },
    "chave": { "type": "string", "description": "Receiver Pix key (EVP, CPF, CNPJ, email, or phone)" },
    "calendario": {
      "type": "object",
      "properties": {
        "criacao": { "type": "string", "format": "date-time" },
        "expiracao": { "type": "integer", "description": "Seconds from creation to expiration", "default": 3600 }
      }
    },
    "devedor": {
      "type": "object",
      "properties": {
        "cpf": { "type": "string", "pattern": "^[0-9]{11}$" },
        "cnpj": { "type": "string", "pattern": "^[0-9]{14}$" },
        "nome": { "type": "string" }
      }
    },
    "loc": {
      "type": "object",
      "properties": {
        "id": { "type": "integer" },
        "location": { "type": "string", "format": "uri" },
        "tipoCob": { "type": "string", "enum": ["cob", "cobv"] }
      }
    },
    "solicitacaoPagador": { "type": "string", "maxLength": 140 },
    "infoAdicionais": {
      "type": "array",
      "items": {
        "type": "object",
        "required": ["nome", "valor"],
        "properties": {
          "nome": { "type": "string", "maxLength": 50 },
          "valor": { "type": "string", "maxLength": 200 }
        }
      }
    }
  }
}

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/efi-pix-cob"
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.

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