Update a shareholder's capital deposit amount

Update the capital deposit amount associated with a shareholder on a case with the API.

Prerequisites

All of the following conditions must be met:

1. The capital deposit case status is WaitingForInitialRequirements, PendingInternalReview, or WaitingForAdditionalInformation.
2. The shareholder status is PendingOnboarding, WaitingForVerification, or WaitingForTransfer.

Guide

1. Call the updateCapitalDepositShareholderAmount mutation (line 2).
2. Add the shareholder ID (line 4).
3. Add the updated amount in the shareholderAmount field (line 5).
4. Add the UpdateCapitalDepositShareholderAmountSuccessPayload and any information you'd like to receive.
5. Add rejections.

Automatic recalculation

Updating a shareholder's deposit amount automatically triggers a recalculation of the total capital deposit amount for the case.

Mutation

Open in API Explorer

mutation UpdateShareholderAmount {
  updateCapitalDepositShareholderAmount(
    input: {
      shareholderId: "$SHAREHOLDER_ID"
      shareholderAmount: { currency: "EUR", value: "1000" }
    }
  ) {
    ... on UpdateCapitalDepositShareholderAmountSuccessPayload {
      __typename
      shareholder {
        id
        capitalDepositAmount {
          currency
          value
        }
      }
    }
    ... on CapitalDepositCaseCanNotBeFoundRejection {
      __typename
      message
    }
    ... on CapitalDepositShareholderCannotBeFoundRejection {
      __typename
      message
    }
    ... on CapitalDepositShareholderCanNotBeUpdatedRejection {
      __typename
      message
    }
    ... on ValidationRejection {
      __typename
      message
    }
    ... on ForbiddenRejection {
      __typename
      message
    }
    ... on InternalErrorRejection {
      __typename
      message
    }
  }
}

Payload

{
  "data": {
    "updateCapitalDepositShareholderAmount": {
      "__typename": "UpdateCapitalDepositShareholderAmountSuccessPayload",
      "shareholder": {
        "id": "fc995f3f-09aa-42e4-9e2f-c4e1185e6b57",
        "capitalDepositAmount": {
          "currency": "EUR",
          "value": "1000.00"
        }
      }
    }
  }
}