Adyen · JSON Structure

Notification Webhooks Balance Structure

Balance schema from Adyen API

Type: object Properties: 4 Required: 4
PaymentsFinancial ServicesFintech

Balance is a JSON Structure definition published by Adyen, describing 4 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

available balance currency reserved

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/notification-webhooks-balance-structure.json",
  "description": "Balance schema from Adyen API",
  "properties": {
    "available": {
      "description": "The remaining amount available for spending.",
      "type": "int64"
    },
    "balance": {
      "description": "The total amount in the balance.",
      "type": "int64"
    },
    "currency": {
      "description": "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance.",
      "type": "string"
    },
    "reserved": {
      "description": "The amount reserved for payments that have been authorised, but have not been captured yet.",
      "type": "int64"
    }
  },
  "required": [
    "currency",
    "balance",
    "reserved",
    "available"
  ],
  "type": "object",
  "name": "Balance"
}