Skip to main content

Audience:

Developers

Disable member

You might need to disable an account member from accessing the account. Disabling a membership doesn't require consent. You can use either a user access token or a project access token.

You can also suspend account memberships and resume access for suspended account memberships.

Prerequisites

You can't disable the legal representative's account membership. If needed, change the account's legal representative before disabling the membership.

Web Banking

Your users can disable account memberships from Swan's Web Banking interface.

Guide

  1. Call the disableAccountMembership mutation.
  2. Add the account membership ID.
  3. Add the success payload with the status.
  4. Add any rejections you'd like.

Mutation

Open in API Explorer
mutation DisableMembership {
disableAccountMembership(
input: { accountMembershipId: "$ACCOUNT_MEMBERSHIP_ID" }
) {
... on DisableAccountMembershipSuccessPayload {
__typename
accountMembership {
statusInfo {
status
}
updatedAt
}
}
... on AccountMembershipCannotBeDisabledRejection {
__typename
accountMembershipId
message
}
... on AccountMembershipNotFoundRejection {
id
message
}
... on ForbiddenRejection {
__typename
message
}
... on InternalErrorRejection {
__typename
message
}
... on LegalRepresentativeAccountMembershipCannotBeDisabledRejection {
__typename
accountMembershipId
message
}
... on UserNotAllowedToDisableItsOwnAccountMembershipRejection {
__typename
accountMembershipId
message
}
... on ValidationRejection {
__typename
message
fields {
code
message
path
}
}
}
}

Payload

The payload shows that the account membership is Disabled.

{
"data": {
"disableAccountMembership": {
"__typename": "DisableAccountMembershipSuccessPayload",
"accountMembership": {
"statusInfo": {
"status": "Disabled"
},
"updatedAt": "2023-06-01T12:59:12.763Z"
}
}
}
}
Impact on recurring SingleUseVirtualCards

When you disable an account member, any recurring single-use virtual cards associated with that member are automatically reassigned to the account's legal representative. The legal representative can reassign the cards to another active member.

The cards remain active to prevent disruption of ongoing expenses or subscriptions. This automatic reassignment maintains business continuity and proper account control.