java.lang.Object
- com.adyen.model.balanceplatform.SweepCounterparty

public class SweepCounterparty
extends Object

SweepCounterparty

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_BALANCE_ACCOUNT_ID`
`static String`	`JSON_PROPERTY_MERCHANT_ACCOUNT`
`static String`	`JSON_PROPERTY_TRANSFER_INSTRUMENT_ID`

Constructor Summary

Constructors
Constructor Description

SweepCounterparty()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SweepCounterparty`	`balanceAccountId(String balanceAccountId)`	The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).
`boolean`	`equals(Object o)`	Return true if this SweepCounterparty object is equal to o.
`static SweepCounterparty`	`fromJson(String jsonString)`	Create an instance of SweepCounterparty given an JSON string
`String`	`getBalanceAccountId()`	The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).
`Map<String,Object>`	`getExplicitNulls()`	Returns a map of properties to be merged into the JSON payload as explicit null values.
`String`	`getMerchantAccount()`	The merchant account that will be the source of funds.
`String`	`getTransferInstrumentId()`	The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id) depending on the sweep `type` .
`int`	`hashCode()`
`SweepCounterparty`	`includeNullValues(boolean includeNullValues)`	Configures whether null values are explicitly serialized in the JSON payload.
`boolean`	`isIncludeNullValues()`	Returns whether null values are explicitly serialized in the JSON payload.
`SweepCounterparty`	`merchantAccount(String merchantAccount)`	The merchant account that will be the source of funds.
`void`	`setBalanceAccountId(String balanceAccountId)`	The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).
`void`	`setIncludeNullValues(boolean includeNullValues)`	Sets whether null values should be explicitly serialized in the JSON payload.
`void`	`setMerchantAccount(String merchantAccount)`	The merchant account that will be the source of funds.
`void`	`setTransferInstrumentId(String transferInstrumentId)`	The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id) depending on the sweep `type` .
`String`	`toJson()`	Convert an instance of SweepCounterparty to an JSON string
`String`	`toString()`
`SweepCounterparty`	`transferInstrumentId(String transferInstrumentId)`	The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id) depending on the sweep `type` .

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JSON_PROPERTY_BALANCE_ACCOUNT_ID
```
public static final String JSON_PROPERTY_BALANCE_ACCOUNT_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MERCHANT_ACCOUNT
```
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TRANSFER_INSTRUMENT_ID
```
public static final String JSON_PROPERTY_TRANSFER_INSTRUMENT_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SweepCounterparty
```
public SweepCounterparty()
```
- Method Detail
  - balanceAccountId
```
public SweepCounterparty balanceAccountId(String balanceAccountId)
```
    The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). > If you are updating the counterparty from a transfer instrument to a balance account, set `transferInstrumentId` to **null**.
    
    Parameters:
    
    balanceAccountId - The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). > If you are updating the counterparty from a transfer instrument to a balance account, set `transferInstrumentId` to **null**.
    
    Returns:
    
    the current SweepCounterparty instance, allowing for method chaining
  - getBalanceAccountId
```
public String getBalanceAccountId()
```
    The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). > If you are updating the counterparty from a transfer instrument to a balance account, set `transferInstrumentId` to **null**.
    
    Returns:
    
    balanceAccountId The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). > If you are updating the counterparty from a transfer instrument to a balance account, set `transferInstrumentId` to **null**.
  - setBalanceAccountId
```
public void setBalanceAccountId(String balanceAccountId)
```
    The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). > If you are updating the counterparty from a transfer instrument to a balance account, set `transferInstrumentId` to **null**.
    
    Parameters:
    
    balanceAccountId - The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). > If you are updating the counterparty from a transfer instrument to a balance account, set `transferInstrumentId` to **null**.
  - merchantAccount
```
public SweepCounterparty merchantAccount(String merchantAccount)
```
    The merchant account that will be the source of funds. You can only use this parameter with sweeps of `type` **pull** and if you are processing payments with Adyen.
    
    Parameters:
    
    merchantAccount - The merchant account that will be the source of funds. You can only use this parameter with sweeps of `type` **pull** and if you are processing payments with Adyen.
    
    Returns:
    
    the current SweepCounterparty instance, allowing for method chaining
  - getMerchantAccount
```
public String getMerchantAccount()
```
    The merchant account that will be the source of funds. You can only use this parameter with sweeps of `type` **pull** and if you are processing payments with Adyen.
    
    Returns:
    
    merchantAccount The merchant account that will be the source of funds. You can only use this parameter with sweeps of `type` **pull** and if you are processing payments with Adyen.
  - setMerchantAccount
```
public void setMerchantAccount(String merchantAccount)
```
    The merchant account that will be the source of funds. You can only use this parameter with sweeps of `type` **pull** and if you are processing payments with Adyen.
    
    Parameters:
    
    merchantAccount - The merchant account that will be the source of funds. You can only use this parameter with sweeps of `type` **pull** and if you are processing payments with Adyen.
  - transferInstrumentId
```
public SweepCounterparty transferInstrumentId(String transferInstrumentId)
```
    The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id) depending on the sweep `type` . To set up automated top-up sweeps to balance accounts in your [marketplace](https://docs.adyen.com/marketplaces/top-up-balance-account/#before-you-begin) or [platform](https://docs.adyen.com/platforms/top-up-balance-account/#before-you-begin), use this parameter in combination with a `merchantAccount` and a sweep `type` of **pull**. Top-up sweeps start a direct debit request from the source transfer instrument. Contact Adyen Support to enable this feature.> If you are updating the counterparty from a balance account to a transfer instrument, set `balanceAccountId` to **null**.
    
    Parameters:
    
    transferInstrumentId - The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id) depending on the sweep `type` . To set up automated top-up sweeps to balance accounts in your [marketplace](https://docs.adyen.com/marketplaces/top-up-balance-account/#before-you-begin) or [platform](https://docs.adyen.com/platforms/top-up-balance-account/#before-you-begin), use this parameter in combination with a `merchantAccount` and a sweep `type` of **pull**. Top-up sweeps start a direct debit request from the source transfer instrument. Contact Adyen Support to enable this feature.> If you are updating the counterparty from a balance account to a transfer instrument, set `balanceAccountId` to **null**.
    
    Returns:
    
    the current SweepCounterparty instance, allowing for method chaining
  - getTransferInstrumentId
```
public String getTransferInstrumentId()
```
    The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id) depending on the sweep `type` . To set up automated top-up sweeps to balance accounts in your [marketplace](https://docs.adyen.com/marketplaces/top-up-balance-account/#before-you-begin) or [platform](https://docs.adyen.com/platforms/top-up-balance-account/#before-you-begin), use this parameter in combination with a `merchantAccount` and a sweep `type` of **pull**. Top-up sweeps start a direct debit request from the source transfer instrument. Contact Adyen Support to enable this feature.> If you are updating the counterparty from a balance account to a transfer instrument, set `balanceAccountId` to **null**.
    
    Returns:
    
    transferInstrumentId The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id) depending on the sweep `type` . To set up automated top-up sweeps to balance accounts in your [marketplace](https://docs.adyen.com/marketplaces/top-up-balance-account/#before-you-begin) or [platform](https://docs.adyen.com/platforms/top-up-balance-account/#before-you-begin), use this parameter in combination with a `merchantAccount` and a sweep `type` of **pull**. Top-up sweeps start a direct debit request from the source transfer instrument. Contact Adyen Support to enable this feature.> If you are updating the counterparty from a balance account to a transfer instrument, set `balanceAccountId` to **null**.
  - setTransferInstrumentId
```
public void setTransferInstrumentId(String transferInstrumentId)
```
    The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id) depending on the sweep `type` . To set up automated top-up sweeps to balance accounts in your [marketplace](https://docs.adyen.com/marketplaces/top-up-balance-account/#before-you-begin) or [platform](https://docs.adyen.com/platforms/top-up-balance-account/#before-you-begin), use this parameter in combination with a `merchantAccount` and a sweep `type` of **pull**. Top-up sweeps start a direct debit request from the source transfer instrument. Contact Adyen Support to enable this feature.> If you are updating the counterparty from a balance account to a transfer instrument, set `balanceAccountId` to **null**.
    
    Parameters:
    
    transferInstrumentId - The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id) depending on the sweep `type` . To set up automated top-up sweeps to balance accounts in your [marketplace](https://docs.adyen.com/marketplaces/top-up-balance-account/#before-you-begin) or [platform](https://docs.adyen.com/platforms/top-up-balance-account/#before-you-begin), use this parameter in combination with a `merchantAccount` and a sweep `type` of **pull**. Top-up sweeps start a direct debit request from the source transfer instrument. Contact Adyen Support to enable this feature.> If you are updating the counterparty from a balance account to a transfer instrument, set `balanceAccountId` to **null**.
  - includeNullValues
```
public SweepCounterparty includeNullValues(boolean includeNullValues)
```
    Configures whether null values are explicitly serialized in the JSON payload. Default is false.
  - isIncludeNullValues
```
public boolean isIncludeNullValues()
```
    Returns whether null values are explicitly serialized in the JSON payload.
  - setIncludeNullValues
```
public void setIncludeNullValues(boolean includeNullValues)
```
    Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
  - equals
```
public boolean equals(Object o)
```
    Return true if this SweepCounterparty object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getExplicitNulls
```
public Map<String,Object> getExplicitNulls()
```
    Returns a map of properties to be merged into the JSON payload as explicit null values.
  - fromJson
```
public static SweepCounterparty fromJson(String jsonString)
                                  throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of SweepCounterparty given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of SweepCounterparty
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to SweepCounterparty
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of SweepCounterparty to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class SweepCounterparty

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_BALANCE_ACCOUNT_ID

JSON_PROPERTY_MERCHANT_ACCOUNT

JSON_PROPERTY_TRANSFER_INSTRUMENT_ID

Constructor Detail

SweepCounterparty

Method Detail

balanceAccountId

getBalanceAccountId

setBalanceAccountId

merchantAccount

getMerchantAccount

setMerchantAccount

transferInstrumentId

getTransferInstrumentId

setTransferInstrumentId

includeNullValues

isIncludeNullValues

setIncludeNullValues

equals

hashCode

toString

getExplicitNulls

fromJson

toJson