Adyen · JSON Structure

Notification Webhooks Sweep Counterparty Structure

SweepCounterparty schema from Adyen API

Type: object Properties: 3
PaymentsFinancial ServicesFintech

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

Properties

balanceAccountId merchantAccount transferInstrumentId

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/notification-webhooks-sweep-counterparty-structure.json",
  "description": "SweepCounterparty schema from Adyen API",
  "properties": {
    "balanceAccountId": {
      "description": "The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).\n\n You can only use this for periodic sweep schedules such as `schedule.type` **daily** or **monthly**.",
      "type": "string"
    },
    "merchantAccount": {
      "description": "The merchant account that will be the source of funds, if you are processing payments with Adyen. You can only use this with sweeps of `type` **pull** and `schedule.type` **balance**.",
      "type": "string"
    },
    "transferInstrumentId": {
      "description": "The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/transferInstruments__resParam_id).\n\nYou can also use this in combination with a `merchantAccount` and a `type` **pull** to start a direct debit request from the source transfer instrument. To use this feature, reach out to your Adyen contact.",
      "type": "string"
    }
  },
  "type": "object",
  "name": "SweepCounterparty"
}