Avaloq · Schema

PaymentRequest

Payment instruction request

BankingDigital BankingFinancial ServicesFintechPaymentsWealth Management

Properties

Name	Type	Description
debtorAccountId	string	Source account ID
creditorIban	string	Destination IBAN
creditorName	string	Beneficiary name
amount	number	Payment amount
currency	string	ISO 4217 currency code
remittanceInfo	string	Payment reference
paymentType	string
executionDate	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentRequest",
  "title": "PaymentRequest",
  "type": "object",
  "required": [
    "debtorAccountId",
    "creditorIban",
    "amount",
    "currency"
  ],
  "description": "Payment instruction request",
  "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": "number",
      "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": "string",
      "format": "date",
      "example": "2025-04-20"
    }
  }
}