AccountHolderUpdateRequest class abstract

AccountHolderUpdateRequest

Properties:

  • balancePlatform - The unique identifier of the balance platform to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms.
  • capabilities - Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, issueCard for Issuing. The value is an object containing the settings for the capability.
  • contactDetails - Contact details of the account holder.
  • description - Your description for the account holder.
  • metadata - A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.
  • migratedAccountHolderCode - The unique identifier of the migrated account holder in the classic integration.
  • primaryBalanceAccount - The ID of the account holder's primary balance account. By default, this is set to the first balance account that you create for the account holder. To assign a different balance account, send a PATCH request.
  • reference - Your reference for the account holder.
  • status - The status of the account holder. Possible values: * active: The account holder is active and allowed to use its capabilities. This is the initial status for account holders and balance accounts. You can change this status to suspended or closed. * suspended: The account holder is temporarily disabled and payouts are blocked. You can change this status to active or closed. * closed: The account holder and all of its capabilities are permanently disabled. This is a final status and cannot be changed.
  • timeZone - The time zone of the account holder. For example, Europe/Amsterdam. Defaults to the time zone of the balance platform if no time zone is set. For possible values, see the list of time zone codes.
  • verificationDeadlines - List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.
Annotations
  • @BuiltValue.new()

Constructors

AccountHolderUpdateRequest([void updates(AccountHolderUpdateRequestBuilder b)])
factory

Properties

balancePlatform → String?
The unique identifier of the balance platform to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms.
no setter
capabilities → BuiltMap<String, AccountHolderCapability>?
Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, issueCard for Issuing. The value is an object containing the settings for the capability.
no setter
contactDetails → ContactDetails?
Contact details of the account holder.
no setter
description → String?
Your description for the account holder.
no setter
hashCode → int
The hash code for this object.
no setterinherited
metadata → BuiltMap<String, String>?
A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.
no setter
migratedAccountHolderCode → String?
The unique identifier of the migrated account holder in the classic integration.
no setter
primaryBalanceAccount → String?
The ID of the account holder's primary balance account. By default, this is set to the first balance account that you create for the account holder. To assign a different balance account, send a PATCH request.
no setter
reference → String?
Your reference for the account holder.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status → AccountHolderUpdateRequestStatusEnum?
The status of the account holder. Possible values: * active: The account holder is active and allowed to use its capabilities. This is the initial status for account holders and balance accounts. You can change this status to suspended or closed. * suspended: The account holder is temporarily disabled and payouts are blocked. You can change this status to active or closed. * closed: The account holder and all of its capabilities are permanently disabled. This is a final status and cannot be changed.
no setter
timeZone → String?
The time zone of the account holder. For example, Europe/Amsterdam. Defaults to the time zone of the balance platform if no time zone is set. For possible values, see the list of time zone codes.
no setter
verificationDeadlines → BuiltList<VerificationDeadline>?
List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(AccountHolderUpdateRequestBuilder)) → AccountHolderUpdateRequest
Rebuilds the instance.
inherited
toBuilder() → AccountHolderUpdateRequestBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<AccountHolderUpdateRequest>
no setter