Avaloq · JSON Structure

Payments Payment Request Structure

Payment instruction request

Type: object Properties: 8 Required: 4

BankingDigital BankingFinancial-ServicesFintechPaymentsWealth Management

PaymentRequest is a JSON Structure definition published by Avaloq, describing 8 properties, of which 4 are required. It conforms to the https://json-schema.org/draft/2020-12/schema meta-schema.

Properties

debtorAccountId creditorIban creditorName amount currency remittanceInfo paymentType executionDate

Meta-schema: https://json-schema.org/draft/2020-12/schema

JSON Structure

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/avaloq/refs/heads/main/json-schema/payments-payment-request-schema.json",
  "description": "Payment instruction request",
  "type": "object",
  "required": [
    "debtorAccountId",
    "creditorIban",
    "amount",
    "currency"
  ],
  "properties": {
    "debtorAccountId": {
      "type": "string",
      "description": "Source account ID",
      "example": "ACC-001234"
    },
    "creditorIban": {
      "type": "string",
      "description": "Destination IBAN",
      "example": "DE89370400440532013000"
    },
    "creditorName": {
      "type": "string",
      "description": "Beneficiary name",
      "example": "Jane Smith"
    },
    "amount": {
      "type": "double",
      "description": "Payment amount",
      "example": 5000.0
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code",
      "example": "EUR"
    },
    "remittanceInfo": {
      "type": "string",
      "description": "Payment reference",
      "example": "Invoice 2025-001"
    },
    "paymentType": {
      "type": "string",
      "enum": [
        "SEPA_CREDIT",
        "SWIFT",
        "DOMESTIC",
        "INSTANT"
      ],
      "example": "SEPA_CREDIT"
    },
    "executionDate": {
      "type": "date",
      "example": "2025-04-20"
    }
  },
  "name": "PaymentRequest"
}

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/payments-payment-request-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.