Resume a membership

Resume, or restore, access for an account member who was temporarily blocked. Resuming a membership requires consent, while suspending one doesn't.

If you use Swan's Web Banking interface, your users can also resume account memberships from their Web Banking accounts.

Suspended only

You can only resume a membership if the account membership's status was Suspended, or temporarily blocked. You can't resume Disabled, or permanently blocked, memberships.

Prerequisites

• You have the canManageAccountMembership permission.
• Resuming a membership requires consent.
• You must use a user access token. Project access tokens can't be used to resume account memberships.

Guide

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

Mutation

Open in API Explorer

mutation ResumeMembership {
  resumeAccountMembership(
    input: {
      accountMembershipId: "$ACCOUNT_MEMBERSHIP_ID"
      consentRedirectUrl: "$YOUR_CONSENT_REDIRECT_URL"
    }
  ) {
    ... on ResumeAccountMembershipSuccessPayload {
      __typename
      consent {
        consentUrl
      }
    }
    ... on ForbiddenRejection {
      __typename
      message
    }
    ... on UserNotAllowedToManageAccountMembershipRejection {
      __typename
      message
    }
    ... on ValidationRejection {
      __typename
      message
      fields {
        code
        message
        path
      }
    }
  }
}

The account holder, legal representative of the account, or account member with canManageAccountMembership permissions must consent to resuming the membership.

Payload

Resume payload

{
  "data": {
    "resumeAccountMembership": {
      "__typename": "ResumeAccountMembershipSuccessPayload",
      "consent": {
        "consentUrl": "https://identity.swan.io/consent?consentId=$CONSENT_ID&env=Sandbox"
      }
    }
  }
}