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

Raw ↑ 
{
  "$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"
}