Suspend an account holder

POST

/suspendAccountHolder

Changes the status of an account holder to Suspended.

Request

Body Params application/json

Examples

Responses

🟢200OK - the request has succeeded.

application/json

Body

🟢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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/suspendAccountHolder' \
--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"
}

Modified at 2023-08-15 06:33:33

Get a tax form

Unsuspend an account holder