Adyen · Schema

BalanceCheckResponse

PaymentsFinancial ServicesFintech

Properties

Name Type Description
additionalData object Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**.
balance object The balance for the payment method.
fraudResult object The fraud result properties of the payment.
pspReference string Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
refusalReason string If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the a
resultCode string The result of the cancellation request. Possible values: * **Success** Indicates that the balance check was successful. * **NotEnoughBalance** Commonly indicates that the card did not have enough bala
transactionLimit object The maximum spendable balance for a single transaction. Applicable to some gift cards.
View JSON Schema on GitHub

JSON Schema

adyen-balancecheckresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BalanceCheckResponse",
  "title": "BalanceCheckResponse",
  "properties": {
    "additionalData": {
      "additionalProperties": {
        "type": "string"
      },
      "x-anyOf": [
        {
          "$ref": "#/components/schemas/ResponseAdditionalData3DSecure"
        },
        {
          "$ref": "#/components/schemas/ResponseAdditionalDataBillingAddress"
        },
        {
          "$ref": "#/components/schemas/ResponseAdditionalDataCard"
        },
        {
          "$ref": "#/components/schemas/ResponseAdditionalDataCommon"
        },
        {
          "$ref": "#/components/schemas/ResponseAdditionalDataDomesticError"
        },
        {
          "$ref": "#/components/schemas/ResponseAdditionalDataInstallments"
        },
        {
          "$ref": "#/components/schemas/ResponseAdditionalDataNetworkTokens"
        },
        {
          "$ref": "#/components/schemas/ResponseAdditionalDataOpi"
        },
        {
          "$ref": "#/components/schemas/ResponseAdditionalDataSepa"
        }
      ],
      "description": "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**.",
      "type": "object"
    },
    "balance": {
      "description": "The balance for the payment method.",
      "$ref": "#/components/schemas/Amount"
    },
    "fraudResult": {
      "description": "The fraud result properties of the payment.",
      "$ref": "#/components/schemas/FraudResult"
    },
    "pspReference": {
      "description": "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.",
      "type": "string"
    },
    "refusalReason": {
      "description": "If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values.\n\nFor more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).",
      "type": "string"
    },
    "resultCode": {
      "description": "The result of the cancellation request.\n\nPossible values:\n\n* **Success**  Indicates that the balance check was successful.\n* **NotEnoughBalance**  Commonly indicates that the card did not have enough balance to pay the amount in the request, or that the currency of the balance on the card did not match the currency of the requested amount.\n* **Failed**  Indicates that the balance check failed.",
      "enum": [
        "Success",
        "NotEnoughBalance",
        "Failed"
      ],
      "type": "string"
    },
    "transactionLimit": {
      "x-addedInVersion": "65",
      "description": "The maximum spendable balance for a single transaction. Applicable to some gift cards.",
      "$ref": "#/components/schemas/Amount"
    }
  },
  "required": [
    "balance",
    "resultCode"
  ],
  "type": "object"
}