Yapily · JSON Structure

Yapily Payment Structure

Operational structure of a Yapily Payment request/response as used across PIS endpoints.

Type: object Properties: 0
Open BankingAISPPISPPaymentsAccount InformationVariable Recurring PaymentsFinancial-ServicesPSD2FCABerlin GroupUKEuropeFintech

Yapily Payment Structure is a JSON Structure definition published by Yapily.

Meta-schema:

JSON Structure

Raw ↑ 
{
  "type": "object",
  "title": "Yapily Payment Structure",
  "description": "Operational structure of a Yapily Payment request/response as used across PIS endpoints.",
  "fields": [
    {"name": "paymentIdempotencyId", "type": "uuid", "required": true},
    {"name": "type", "type": "enum", "values": ["DOMESTIC_PAYMENT", "DOMESTIC_SCHEDULED_PAYMENT", "DOMESTIC_PERIODIC_PAYMENT", "INTERNATIONAL_PAYMENT", "BULK_PAYMENT", "SWEEPING_VRP"]},
    {"name": "amount", "type": "Amount", "required": true},
    {"name": "reference", "type": "string"},
    {"name": "payee", "type": "Payee", "required": true},
    {"name": "payer", "type": "Payer"},
    {"name": "contextType", "type": "enum", "values": ["BILL", "ECOMMERCE_GOODS", "ECOMMERCE_SERVICES", "OTHER", "PARTY_TO_PARTY"]}
  ],
  "lifecycle": ["INITIATED", "AWAITING_AUTHORIZATION", "PENDING", "COMPLETED", "FAILED", "REJECTED", "REVOKED"],
  "relationships": {
    "requires": "Consent (single-use for payments)",
    "executedAgainst": "Institution",
    "settles": "Account"
  }
}

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/yapily-payment-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.

GitHub Google LinkedIn

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