Adyen · JSON Structure

Notifications Payout Method Structure

PayoutMethod schema from Adyen API

Type: object Properties: 5 Required: 3
PaymentsFinancial ServicesFintech

PayoutMethod is a JSON Structure definition published by Adyen, describing 5 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

merchantAccount payoutMethodCode payoutMethodReference recurringDetailReference shopperReference

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/notifications-payout-method-structure.json",
  "description": "PayoutMethod schema from Adyen API",
  "type": "object",
  "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"
  ],
  "name": "PayoutMethod"
}