Adyen · JSON Structure

Management Payout Settings Structure

PayoutSettings schema from Adyen API

Type: object Properties: 7 Required: 2
PaymentsFinancial ServicesFintech

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

Properties

allowed enabled enabledFromDate id priority transferInstrumentId verificationStatus

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/management-payout-settings-structure.json",
  "description": "PayoutSettings schema from Adyen API",
  "type": "object",
  "properties": {
    "allowed": {
      "description": "Indicates if payouts to the bank account are allowed. This value is set automatically based on the status of the verification process. The value is:\n\n* **true** if `verificationStatus` is **valid**.\n* **false** for all other values.",
      "type": "boolean"
    },
    "enabled": {
      "description": "Indicates if payouts to this bank account are enabled. Default: **true**.\n\nTo receive payouts into this bank account, both `enabled` and `allowed` must be **true**.",
      "type": "boolean"
    },
    "enabledFromDate": {
      "description": "The date when Adyen starts paying out to this bank account.\n\nFormat: [ISO 8601](https://www.w3.org/TR/NOTE-datetime), for example, **2019-11-23T12:25:28Z** or **2020-05-27T20:25:28+08:00**.\n\nIf not specified, the `enabled` field indicates if payouts are enabled for this bank account.\n\nIf a date is specified and:\n\n* `enabled`: **true**, payouts are enabled starting the specified date.\n* `enabled`: **false**, payouts are disabled until the specified date. On the specified date, `enabled` changes to **true** and this field is reset to **null**.",
      "type": "string"
    },
    "id": {
      "description": "The unique identifier of the payout setting.",
      "type": "string"
    },
    "priority": {
      "description": "Determines how long it takes for the funds to reach the bank account. Adyen pays out based on the [payout frequency](https://docs.adyen.com/account/getting-paid#payout-frequency). Depending on the currencies and banks involved in transferring the money, it may take up to three days for the payout funds to arrive in the bank account.\n\n Possible values:\n* **first**: same day.\n* **urgent**: the next day.\n* **normal**: between 1 and 3 days.",
      "enum": [
        "first",
        "normal",
        "urgent"
      ],
      "type": "string"
    },
    "transferInstrumentId": {
      "description": "The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the bank account.",
      "type": "string"
    },
    "verificationStatus": {
      "description": "The status of the verification process for the bank account.\n\nPossible values:\n* **valid**: the verification was successful.\n* **pending**: the verification is in progress.\n* **invalid**: the information provided is not complete.\n* **rejected**:  there are reasons to refuse working with this entity.",
      "enum": [
        "invalid",
        "pending",
        "rejected",
        "valid"
      ],
      "type": "string"
    }
  },
  "required": [
    "transferInstrumentId",
    "id"
  ],
  "name": "PayoutSettings"
}