Adyen · Schema

PayoutSettings

PaymentsFinancial ServicesFintech

Properties

Name Type Description
allowed boolean 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: * **true** if `verificationStatus` is **valid**. *
enabled boolean Indicates if payouts to this bank account are enabled. Default: **true**. To receive payouts into this bank account, both `enabled` and `allowed` must be **true**.
enabledFromDate string The date when Adyen starts paying out to this bank account. Format: [ISO 8601](https://www.w3.org/TR/NOTE-datetime), for example, **2019-11-23T12:25:28Z** or **2020-05-27T20:25:28+08:00**. If not spec
id string The unique identifier of the payout setting.
priority string 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 cur
transferInstrumentId string 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.
verificationStatus string The status of the verification process for the bank account. Possible values: * **valid**: the verification was successful. * **pending**: the verification is in progress. * **invalid**: the informati
View JSON Schema on GitHub

JSON Schema

adyen-payoutsettings-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PayoutSettings",
  "title": "PayoutSettings",
  "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"
  ],
  "type": "object"
}