Adyen · Schema

PayoutMethod

PaymentsFinancial ServicesFintech

Properties

Name Type Description
merchantAccount string The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's c
payoutMethodCode string Adyen-generated unique alphanumeric identifier (UUID) for the payout method, returned in the response when you create a payout method. Required when updating an existing payout method in an `/updateAc
payoutMethodReference string Your reference for the payout method.
recurringDetailReference string The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) re
shopperReference string The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) you sent in the `/payments` request when you [saved the account holder's
View JSON Schema on GitHub

JSON Schema

adyen-payoutmethod-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PayoutMethod",
  "title": "PayoutMethod",
  "properties": {
    "merchantAccount": {
      "description": "The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).",
      "type": "string"
    },
    "payoutMethodCode": {
      "description": "Adyen-generated unique alphanumeric identifier (UUID) for the payout method, returned in the response when you create a payout method. Required when updating an existing payout method in an `/updateAccountHolder` request.",
      "type": "string"
    },
    "payoutMethodReference": {
      "description": "Your reference for the payout method.",
      "type": "string"
    },
    "recurringDetailReference": {
      "description": "The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference)  returned in the `/payments` response when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).",
      "type": "string"
    },
    "shopperReference": {
      "description": "The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) you sent in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).",
      "type": "string"
    }
  },
  "required": [
    "merchantAccount",
    "shopperReference",
    "recurringDetailReference"
  ],
  "type": "object"
}