Unsuspend an account holder

POST

/unSuspendAccountHolder

Account holders

Changes the status of an account holder from Suspended to Inactive.
Account holders can have a Suspended status if you suspend them through the /suspendAccountHolder endpoint or if a verification deadline expires.

You can only unsuspend account holders if they do not have verification checks with a FAILED status.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/unSuspendAccountHolder' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountHolderCode": "string"
}'

Response Example

200 - Example 1

{
    "accountHolderStatus": {
        "events": [
            {
                "event": "InactivateAccount",
                "executionDate": "2019-08-24T14:15:22Z",
                "reason": "string"
            }
        ],
        "payoutState": {
            "allowPayout": true,
            "disableReason": "string",
            "disabled": true,
            "notAllowedReason": "string",
            "payoutLimit": {
                "currency": "str",
                "value": 0
            },
            "tierNumber": 0
        },
        "processingState": {
            "disableReason": "string",
            "disabled": true,
            "processedFrom": {
                "currency": "str",
                "value": 0
            },
            "processedTo": {
                "currency": "str",
                "value": 0
            },
            "tierNumber": 0
        },
        "status": "Active",
        "statusReason": "string"
    },
    "invalidFields": [
        {
            "errorCode": 0,
            "errorDescription": "string",
            "fieldType": {
                "field": "string",
                "fieldName": "accountCode",
                "shareholderCode": "string"
            }
        }
    ],
    "pspReference": "string",
    "resultCode": "string"
}

Request

Body Params application/json

accountHolderCode

string

required

The code of the account holder to be reinstated.

Examples

Responses

🟢200OK - the request has succeeded.

application/json

Body

accountHolderStatus

object (AccountHolderStatus)

optional

The new status of the Account Holder.

events

array[object (AccountEvent) {3}]

optional

A list of events scheduled for the account holder.

payoutState

object (AccountPayoutState)

optional

The payout state of the account holder.

processingState

object (AccountProcessingState)

optional

The processing state of the account holder.

status

enum<string>

required

The status of the account holder.

Permitted values: Active, Inactive, Suspended, Closed.

Allowed values:

ActiveClosedInactiveSuspended

statusReason

string

optional

The reason why the status was assigned to the account holder.

invalidFields

array[object (ErrorFieldType) {3}]

optional

Contains field validation errors that would prevent requests from being processed.

errorCode

integer <int32>

optional

The validation error code.

errorDescription

string

optional

A description of the validation error.

fieldType

object (FieldType)

optional

The type of error field.

pspReference

string

optional

The reference of a request. Can be used to uniquely identify the request.

resultCode

string

optional

The result code.

🟢202Accepted - the request has been accepted for processing, but the processing has not been completed.

🟠400Bad Request - a problem reading or understanding the request.

🟠401Unauthorized - authentication required.

🟠403Forbidden - insufficient permissions to process the request.

🟠422Unprocessable Entity - a request validation error.

🔴500Internal Server Error - the server could not process the request.

Suspend an account holder

Update an account holder