Adyen · JSON Structure

Stored Value Stored Value Balance Check Request Structure

StoredValueBalanceCheckRequest schema from Adyen API

Type: object Properties: 8 Required: 3
PaymentsFinancial ServicesFintech

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

Properties

amount merchantAccount paymentMethod recurringDetailReference reference shopperInteraction shopperReference store

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/stored-value-stored-value-balance-check-request-structure.json",
  "description": "StoredValueBalanceCheckRequest schema from Adyen API",
  "type": "object",
  "properties": {
    "amount": {
      "description": "The amount information for the transaction.",
      "$ref": "#/components/schemas/Amount"
    },
    "merchantAccount": {
      "description": "The merchant account identifier, with which you want to process the transaction.",
      "type": "string"
    },
    "paymentMethod": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "The collection that contains the type of the payment method and its specific information if available",
      "type": "object"
    },
    "recurringDetailReference": {
      "type": "string"
    },
    "reference": {
      "description": "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.",
      "type": "string"
    },
    "shopperInteraction": {
      "description": "Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.\nFor the web service API, Adyen assumes Ecommerce shopper interaction by default.\n\nThis field has the following possible values:\n* `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.\n* `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).\n* `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.\n* `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.",
      "enum": [
        "Ecommerce",
        "ContAuth",
        "Moto",
        "POS"
      ],
      "type": "string"
    },
    "shopperReference": {
      "type": "string"
    },
    "store": {
      "description": "The physical store, for which this payment is processed.",
      "maxLength": 16,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "merchantAccount",
    "reference",
    "paymentMethod"
  ],
  "name": "StoredValueBalanceCheckRequest"
}