Adyen · Schema

SweepCounterparty

SweepCounterparty schema from Adyen API

PaymentsFinancial ServicesFintech

Properties

Name Type Description
balanceAccountId string The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). You can only use this for periodic
merchantAccount string 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**.
transferInstrumentId string The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/transferInstruments__resParam_id). You can also use this in c
View JSON Schema on GitHub

JSON Schema

notification-webhooks-sweep-counterparty-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/notification-webhooks-sweep-counterparty-schema.json",
  "title": "SweepCounterparty",
  "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"
}