Payouts Submit Request Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/payouts-submit-request-structure.json",
  "description": "SubmitRequest schema from Adyen API",
  "type": "object",
  "properties": {
    "additionalData": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "This field contains additional data, which may be required for a particular request.",
      "type": "object"
    },
    "amount": {
      "description": "A container object for the payable amount information of the transaction.",
      "$ref": "#/components/schemas/Amount"
    },
    "dateOfBirth": {
      "x-addedInVersion": "24",
      "description": "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n\n> This field is mandatory for natural persons. \n> This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.",
      "type": "date"
    },
    "entityType": {
      "x-addedInVersion": "24",
      "description": "The type of the entity the payout is processed for.\n\nAllowed values:\n* NaturalPerson\n* Company\n> This field is required to update the existing `entityType` that is associated with this recurring contract.",
      "enum": [
        "NaturalPerson",
        "Company"
      ],
      "type": "string"
    },
    "fraudOffset": {
      "description": "An integer value that is added to the normal fraud score. The value can be either positive or negative.",
      "type": "int32"
    },
    "merchantAccount": {
      "description": "The merchant account identifier you want to process the transaction request with.",
      "type": "string"
    },
    "nationality": {
      "x-addedInVersion": "24",
      "description": "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').\n\n> This field is required to update the existing nationality that is associated with this recurring contract.",
      "type": "string"
    },
    "recurring": {
      "description": "A container for the type of recurring contract to be retrieved.\n\nThe `recurring.contract` must be set to \"PAYOUT\".",
      "$ref": "#/components/schemas/Recurring"
    },
    "reference": {
      "description": "The merchant reference for this payout. This reference will be used in all communication to the merchant about the status of the payout. Although it is a good idea to make sure it is unique, this is not a requirement.",
      "type": "string"
    },
    "selectedRecurringDetailReference": {
      "description": "This is the `recurringDetailReference` you want to use for this payout.\n\nYou can use the value LATEST to select the most recently used recurring detail.",
      "type": "string"
    },
    "shopperEmail": {
      "description": "The shopper's email address.",
      "type": "string"
    },
    "shopperName": {
      "x-addedInVersion": "24",
      "description": "The shopper's name.\n\nIn case the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.\n\n> This field is required to update the existing `shopperName` associated with a recurring contract.",
      "$ref": "#/components/schemas/Name"
    },
    "shopperReference": {
      "description": "The shopper's reference for the payout transaction.",
      "type": "string"
    },
    "shopperStatement": {
      "x-addedInVersion": "2",
      "description": "The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method).",
      "type": "string"
    },
    "socialSecurityNumber": {
      "x-addedInVersion": "24",
      "description": "The shopper's social security number.",
      "type": "string"
    }
  },
  "required": [
    "merchantAccount",
    "reference",
    "amount",
    "shopperEmail",
    "shopperReference",
    "recurring",
    "selectedRecurringDetailReference"
  ],
  "name": "SubmitRequest"
}