Update an account

POST

/updateAccount

Updates the description or payout schedule of an account.

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 '/updateAccount' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountCode": "string",
    "bankAccountUUID": "string",
    "description": "string",
    "metadata": {
        "property1": "string",
        "property2": "string"
    },
    "payoutMethodCode": "string",
    "payoutSchedule": {
        "action": "CLOSE",
        "reason": "string",
        "schedule": "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT"
    },
    "payoutSpeed": "INSTANT"
}'

Response Example

200 - Example 1

{
    "accountCode": "string",
    "bankAccountUUID": "string",
    "description": "string",
    "invalidFields": [
        {
            "errorCode": 0,
            "errorDescription": "string",
            "fieldType": {
                "field": "string",
                "fieldName": "accountCode",
                "shareholderCode": "string"
            }
        }
    ],
    "metadata": {
        "property1": "string",
        "property2": "string"
    },
    "payoutMethodCode": "string",
    "payoutSchedule": {
        "nextScheduledPayout": "2019-08-24T14:15:22Z",
        "schedule": "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT"
    },
    "payoutSpeed": "INSTANT",
    "pspReference": "string",
    "resultCode": "string"
}

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

Create an account

Close an account holder