Adyen · Schema

PayoutSettingsRequest

PaymentsFinancial ServicesFintech

Properties

Name Type Description
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
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.
View JSON Schema on GitHub

JSON Schema

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