Adyen · Schema

BalanceTransferResponse

PaymentsFinancial ServicesFintech

Properties

Name Type Description
amount object The amount of the transfer in [minor units](https://docs.adyen.com/development-resources/currency-codes).
createdAt string The date when the balance transfer was requested.
description string A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description may be truncated.
fromMerchant string The unique identifier of the source merchant account from which funds are deducted.
pspReference string Adyen's 16-character string reference associated with the balance transfer.
reference string A reference for the balance transfer. If you don't provide this in the request, Adyen generates a unique reference. Maximum length: 80 characters.
status string The status of the balance transfer. Possible values: **transferred**, **failed**, **error**, and **notEnoughBalance**.
toMerchant string The unique identifier of the destination merchant account from which funds are transferred.
type string The type of balance transfer. Possible values: **tax**, **fee**, **terminalSale**, **credit**, **debit**, and **adjustment**.
View JSON Schema on GitHub

JSON Schema

adyen-balancetransferresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BalanceTransferResponse",
  "title": "BalanceTransferResponse",
  "properties": {
    "amount": {
      "description": "The amount of the transfer in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
      "$ref": "#/components/schemas/Amount"
    },
    "createdAt": {
      "description": "The date when the balance transfer was requested.",
      "format": "date-time",
      "type": "string"
    },
    "description": {
      "description": "A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description may be truncated.",
      "maxLength": 140,
      "type": "string"
    },
    "fromMerchant": {
      "description": "The unique identifier of the source merchant account from which funds are deducted.",
      "type": "string"
    },
    "pspReference": {
      "description": "Adyen's 16-character string reference associated with the balance transfer.",
      "type": "string"
    },
    "reference": {
      "description": "A reference for the balance transfer. If you don't provide this in the request, Adyen generates a unique reference.\nMaximum length: 80 characters.",
      "maxLength": 80,
      "type": "string"
    },
    "status": {
      "description": "The status of the balance transfer. Possible values: **transferred**, **failed**, **error**, and **notEnoughBalance**.",
      "enum": [
        "error",
        "failed",
        "notEnoughBalance",
        "transferred"
      ],
      "type": "string"
    },
    "toMerchant": {
      "description": "The unique identifier of the destination merchant account from which funds are transferred.",
      "type": "string"
    },
    "type": {
      "description": "The type of balance transfer. Possible values: **tax**, **fee**, **terminalSale**, **credit**, **debit**, and **adjustment**.",
      "enum": [
        "tax",
        "fee",
        "terminalSale",
        "credit",
        "debit",
        "adjustment"
      ],
      "type": "string"
    }
  },
  "required": [
    "amount",
    "fromMerchant",
    "toMerchant",
    "type",
    "pspReference",
    "status",
    "createdAt"
  ],
  "type": "object"
}