Adyen · JSON Structure

Funds Transfer Funds Request Structure

TransferFundsRequest schema from Adyen API

Type: object Properties: 5 Required: 4
PaymentsFinancial ServicesFintech

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

Properties

amount destinationAccountCode merchantReference sourceAccountCode transferCode

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/funds-transfer-funds-request-structure.json",
  "description": "TransferFundsRequest schema from Adyen API",
  "type": "object",
  "properties": {
    "amount": {
      "description": "The amount to be transferred.",
      "$ref": "#/components/schemas/Amount"
    },
    "destinationAccountCode": {
      "description": "The code of the account to which the funds are to be credited.\n>The state of the Account Holder of this account must be Active.",
      "type": "string"
    },
    "merchantReference": {
      "x-addedInVersion": "2",
      "description": "A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.",
      "type": "string"
    },
    "sourceAccountCode": {
      "description": "The code of the account from which the funds are to be debited.\n>The state of the Account Holder of this account must be Active and allow payouts.",
      "type": "string"
    },
    "transferCode": {
      "description": "The code related to the type of transfer being performed.\n>The permitted codes differ for each platform account and are defined in their service level agreement.",
      "type": "string"
    }
  },
  "required": [
    "sourceAccountCode",
    "destinationAccountCode",
    "transferCode",
    "amount"
  ],
  "name": "TransferFundsRequest"
}