Adyen for Platforms: Account API
  1. Account holders
Adyen for Platforms: Account API
  • Verification
    • Trigger verification
      POST
    • Delete bank accounts
      POST
    • Delete legal arrangements
      POST
    • Delete payout methods
      POST
    • Delete shareholders
      POST
    • Delete signatories
      POST
    • Get documents
      POST
    • Upload a document
      POST
  • Accounts
    • Close an account
      POST
    • Create an account
      POST
    • Update an account
      POST
  • Account holders
    • Close an account holder
      POST
    • Close stores
      POST
    • Create an account holder
      POST
    • Get an account holder
      POST
    • Get a tax form
      POST
    • Suspend an account holder
      POST
    • Unsuspend an account holder
      POST
    • Update an account holder
      POST
    • Update payout or processing state
      POST
  1. Account holders

Update payout or processing state

POST
/updateAccountHolderState
Account holders
Disables or enables the processing or payout state of an account holder.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/updateAccountHolderState' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountHolderCode": "string",
    "disable": true,
    "reason": "string",
    "stateType": "LimitedPayout"
}'
Response Response Example
200 - Example 1
{
    "accountHolderCode": "string",
    "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 on which to update the state.
disable
boolean 
required
If true, disable the requested state. If false, enable the requested state.
reason
string 
optional
The reason that the state is being updated.
Required if the state is being disabled.
stateType
enum<string> 
required
The state to be updated.
Permitted values are: Processing, Payout
Allowed values:
LimitedPayoutLimitedProcessingLimitlessPayoutLimitlessProcessingPayoutProcessing
Examples

Responses

🟢200OK - the request has succeeded.
application/json
Body
accountHolderCode
string 
optional
The code of the Account Holder.
accountHolderStatus
object (AccountHolderStatus) 
optional
The 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.
Previous
Update an account holder
Built with