OneOffPaymentConnectionsResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/akahu/main/json-schema/akahu-one-off-payment-connections-response-schema.json",
  "title": "OneOffPaymentConnectionsResponse",
  "x-generated": "2026-10-27",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/akahu-one-off-payments-api-openapi.yml#/components/schemas/OneOffPaymentConnectionsResponse",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "enum": [
        true
      ]
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/OneOffPaymentConnection"
      }
    }
  },
  "required": [
    "success",
    "items"
  ],
  "$defs": {
    "ConnectionId": {
      "type": "string",
      "pattern": "^conn_[a-z0-9]{25,27}$"
    },
    "OneOffPaymentBank": {
      "type": "string",
      "enum": [
        "anz",
        "asb",
        "bnz",
        "kiwibank",
        "nzhl",
        "westpac",
        "demo_bank"
      ],
      "description": "The bank the customer must use to make this payment"
    },
    "OneOffPaymentConnection": {
      "type": "object",
      "properties": {
        "_id": {
          "$ref": "#/$defs/ConnectionId"
        },
        "bank": {
          "allOf": [
            {
              "$ref": "#/$defs/OneOffPaymentBank"
            },
            {
              "description": "The value to provide as payer.bank when creating a one-off payment."
            }
          ]
        },
        "name": {
          "type": "string",
          "description": "The name of the institution."
        },
        "logo": {
          "type": "string",
          "format": "uri",
          "description": "A URL pointing to an image of the institution's logo."
        },
        "limits": {
          "type": "object",
          "properties": {
            "oneoff": {
              "type": "array",
              "items": {
                "$ref": "#/$defs/OneOffPaymentLimit"
              }
            }
          },
          "required": [
            "oneoff"
          ]
        }
      },
      "required": [
        "_id",
        "bank",
        "name",
        "logo",
        "limits"
      ]
    },
    "OneOffPaymentLimit": {
      "type": "object",
      "properties": {
        "value": {
          "type": "number",
          "exclusiveMinimum": 0,
          "description": "The limit amount in dollars."
        },
        "type": {
          "$ref": "#/$defs/OneOffPaymentLimitType"
        },
        "classification": {
          "$ref": "#/$defs/PaymentLimitClassification"
        },
        "description": {
          "type": "string",
          "description": "Additional context about how the limit is applied."
        }
      },
      "required": [
        "value",
        "type",
        "classification",
        "description"
      ]
    },
    "OneOffPaymentLimitType": {
      "type": "string",
      "enum": [
        "single_payment",
        "daily",
        "weekly"
      ],
      "description": "The payment or time period that the limit applies to."
    },
    "PaymentLimitClassification": {
      "type": "string",
      "enum": [
        "strict",
        "informational"
      ],
      "description": "How the published value should be interpreted. A `strict` value is a fixed upper bound. An `informational` value is a default or indicative amount and the customer's actual limit may differ."
    }
  }
}