PayoutRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PayoutRequest",
  "title": "PayoutRequest",
  "properties": {
    "amount": {
      "description": "The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).",
      "$ref": "#/components/schemas/Amount"
    },
    "billingAddress": {
      "x-addedInVersion": "4",
      "description": "The address where to send the invoice.\n> The `billingAddress` object is required in the following scenarios. Include all of the fields within this object.\n>* For 3D Secure 2 transactions in all browser-based and mobile implementations.\n>* For cross-border payouts to and from Canada.",
      "$ref": "#/components/schemas/Address"
    },
    "card": {
      "description": "A container for card data.\n> Either `bankAccount` or `card` field must be provided in a payment request.",
      "$ref": "#/components/schemas/Card"
    },
    "fraudOffset": {
      "description": "An integer value that is added to the normal fraud score. The value can be either positive or negative.",
      "format": "int32",
      "type": "integer"
    },
    "fundSource": {
      "x-addedInVersion": "64",
      "description": "The person or entity funding the money.",
      "$ref": "#/components/schemas/FundSource"
    },
    "merchantAccount": {
      "description": "The merchant account identifier, with which you want to process the transaction.",
      "type": "string"
    },
    "recurring": {
      "description": "The recurring settings for the payment. Use this property when you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments).",
      "$ref": "#/components/schemas/Recurring"
    },
    "reference": {
      "description": "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.",
      "type": "string"
    },
    "selectedRecurringDetailReference": {
      "description": "The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.",
      "type": "string"
    },
    "shopperEmail": {
      "description": "The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.\n> For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.",
      "type": "string"
    },
    "shopperInteraction": {
      "description": "Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.\nFor the web service API, Adyen assumes Ecommerce shopper interaction by default.\n\nThis field has the following possible values:\n* `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.\n* `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).\n* `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.\n* `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.",
      "enum": [
        "Ecommerce",
        "ContAuth",
        "Moto",
        "POS"
      ],
      "type": "string"
    },
    "shopperName": {
      "x-addedInVersion": "7",
      "description": "The shopper's full name.",
      "$ref": "#/components/schemas/Name"
    },
    "shopperReference": {
      "description": "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your reference must not include personally identifiable information (PII), for example name or email address.",
      "type": "string"
    },
    "telephoneNumber": {
      "x-addedInVersion": "7",
      "description": "The shopper's telephone number.",
      "type": "string"
    }
  },
  "required": [
    "merchantAccount",
    "reference",
    "amount"
  ],
  "type": "object"
}