{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/fincore/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Private Account Lifecycle","siteUrl":"https://docs.monato.com","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"private-account-lifecycle","__idx":0},"children":["Private Account Lifecycle"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide describes the customer-facing lifecycle actions supported for ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["private accounts"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Private accounts support three lifecycle actions through the API:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Cancel"]}," — permanently disables a private account"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Block"]}," — temporarily disables a private account"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Activate"]}," — restores a previously blocked private account to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACTIVE"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"public-lifecycle-states-covered-in-this-guide","__idx":2},"children":["Public lifecycle states covered in this guide"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide covers the following customer-facing states for private accounts:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACTIVE"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BLOCKED"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CANCELLED"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"supported-transitions","__idx":3},"children":["Supported transitions"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACTIVE"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BLOCKED"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BLOCKED"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACTIVE"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACTIVE"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CANCELLED"]}]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"stateDiagram-v2\n [*] --> ACTIVE\n ACTIVE --> BLOCKED : block\n BLOCKED --> ACTIVE : activate\n ACTIVE --> CANCELLED : cancel\n CANCELLED --> [*]\n","diagramHtml":"

block

activate

cancel

ACTIVE

BLOCKED

CANCELLED

","diagramHtmlDark":"

block

activate

cancel

ACTIVE

BLOCKED

CANCELLED

"},"children":["stateDiagram-v2\n [*] --> ACTIVE\n ACTIVE --> BLOCKED : block\n BLOCKED --> ACTIVE : activate\n ACTIVE --> CANCELLED : cancel\n CANCELLED --> [*]\n"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"cancel-a-private-account","__idx":4},"children":["Cancel a private account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this action when you want to permanently disable a private account."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"endpoint","__idx":5},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /v1/clients/{clientId}/accounts/{accountId}/cancel"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"behavior","__idx":6},"children":["Behavior"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Changes the account status to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CANCELLED"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The operation is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["permanent"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The operation is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["irreversible"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"path-parameters","__idx":7},"children":["Path parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UUID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the client that owns the account"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UUID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the private account to cancel"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-body","__idx":8},"children":["Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint does not require a request body."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"validations","__idx":9},"children":["Validations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before cancelling the account, the API validates the following conditions:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The account must belong to the specified client"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Only private accounts can be cancelled"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The account must not already be cancelled"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The available balance must be equal to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"successful-response","__idx":10},"children":["Successful response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Status Code:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API returns the updated account object with:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"account_status\": \"CANCELLED\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example","__idx":11},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X PUT \"{{base_url}}/v1/clients/{{clientId}}/accounts/{{accountId}}/cancel\" \\\n -H \"Authorization: Bearer {{access_token}}\" \\\n -H \"Content-Type: application/json\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"notes","__idx":12},"children":["Notes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Cancellation is immediate after a successful API response"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Cancellation is irreversible"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Only private accounts can be cancelled"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Accounts with non-zero balance cannot be cancelled"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"possible-errors","__idx":13},"children":["Possible errors"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"account-already-cancelled","__idx":14},"children":["Account already cancelled"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HTTP Code:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"code\": 9,\n \"message\": \"API Error\",\n \"details\": [\n {\n \"@type\": \"type.googleapis.com/google.rpc.ErrorInfo\",\n \"reason\": \"FAILED_PRECONDITION\",\n \"domain\": \"CORE\",\n \"metadata\": {\n \"error_detail\": \"Account is already cancelled\",\n \"http_code\": \"400\",\n \"module\": \"Account\",\n \"method_name\": \"Cancel\"\n }\n }\n ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"only-private-accounts-can-be-cancelled","__idx":15},"children":["Only private accounts can be cancelled"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HTTP Code:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"code\": 9,\n \"message\": \"API Error\",\n \"details\": [\n {\n \"@type\": \"type.googleapis.com/google.rpc.ErrorInfo\",\n \"reason\": \"FAILED_PRECONDITION\",\n \"domain\": \"CORE\",\n \"metadata\": {\n \"error_detail\": \"Only Private Accounts can be cancelled\",\n \"http_code\": \"400\",\n \"module\": \"Account\",\n \"method_name\": \"Cancel\",\n \"error_code\": \"10-E4120\"\n }\n }\n ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"invalid-balance","__idx":16},"children":["Invalid balance"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HTTP Code:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"code\": 9,\n \"message\": \"API Error\",\n \"details\": [\n {\n \"@type\": \"type.googleapis.com/google.rpc.ErrorInfo\",\n \"reason\": \"FAILED_PRECONDITION\",\n \"domain\": \"CORE\",\n \"metadata\": {\n \"error_detail\": \"Invalid account balance, account balance must be equal to 0\",\n \"http_code\": \"400\",\n \"module\": \"Account\",\n \"method_name\": \"Cancel\"\n }\n }\n ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"account-does-not-belong-to-the-specified-client","__idx":17},"children":["Account does not belong to the specified client"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HTTP Code:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"code\": 7,\n \"message\": \"API Error\",\n \"details\": [\n {\n \"@type\": \"type.googleapis.com/google.rpc.ErrorInfo\",\n \"reason\": \"FORBIDDEN\",\n \"domain\": \"CORE\",\n \"metadata\": {\n \"error_detail\": \"Account does not belong to the specified client\",\n \"http_code\": \"403\",\n \"module\": \"Account\",\n \"method_name\": \"Cancel\"\n }\n }\n ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"block-a-private-account","__idx":18},"children":["Block a private account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this action when you want to temporarily disable a private account."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"endpoint-1","__idx":19},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /v1/clients/{clientId}/accounts/{accountId}/block"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"behavior-1","__idx":20},"children":["Behavior"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Changes the account status to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BLOCKED"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The operation is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["temporary"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The account can later be restored to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACTIVE"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"path-parameters-1","__idx":21},"children":["Path parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UUID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the client that owns the account"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UUID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the private account to block"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-body-1","__idx":22},"children":["Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint does not require a request body."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"validations-1","__idx":23},"children":["Validations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before blocking the account, the API validates the following conditions:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The account must belong to the specified client"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Only private accounts can be blocked"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"successful-response-1","__idx":24},"children":["Successful response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Status Code:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API returns the updated account object with:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"account_status\": \"BLOCKED\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-1","__idx":25},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X PUT \"{{base_url}}/v1/clients/{{clientId}}/accounts/{{accountId}}/block\" \\\n -H \"Authorization: Bearer {{access_token}}\" \\\n -H \"Content-Type: application/json\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"notes-1","__idx":26},"children":["Notes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Blocking is temporary"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A blocked account can later be restored through the activation endpoint"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"activate-a-private-account","__idx":27},"children":["Activate a private account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this action when you want to restore a previously blocked private account."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"endpoint-2","__idx":28},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /v1/clients/{clientId}/accounts/{accountId}/activate"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"behavior-2","__idx":29},"children":["Behavior"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Changes the account status to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACTIVE"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["This action is intended to reverse a previous block"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"path-parameters-2","__idx":30},"children":["Path parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UUID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the client that owns the account"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UUID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the private account to activate"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-body-2","__idx":31},"children":["Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint does not require a request body."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"validations-2","__idx":32},"children":["Validations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before activating the account, the API validates the following conditions:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The account must belong to the specified client"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The account must currently be blocked"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"successful-response-2","__idx":33},"children":["Successful response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Status Code:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API returns the updated account object with:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"account_status\": \"ACTIVE\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-2","__idx":34},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X PATCH \"{{base_url}}/v1/clients/{{clientId}}/accounts/{{accountId}}/activate\" \\\n -H \"Authorization: Bearer {{access_token}}\" \\\n -H \"Content-Type: application/json\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"notes-2","__idx":35},"children":["Notes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Activation is used to restore a previously blocked private account"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Once activation succeeds, the account remains in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACTIVE"]}," status"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-reference","__idx":36},"children":["API reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following customer-facing endpoints are available for private account lifecycle management:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /v1/clients/{clientId}/accounts/{accountId}/cancel"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /v1/clients/{clientId}/accounts/{accountId}/block"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /v1/clients/{clientId}/accounts/{accountId}/activate"]}]}]}]},"headings":[{"value":"Private Account Lifecycle","id":"private-account-lifecycle","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Public lifecycle states covered in this guide","id":"public-lifecycle-states-covered-in-this-guide","depth":2},{"value":"Supported transitions","id":"supported-transitions","depth":2},{"value":"Cancel a private account","id":"cancel-a-private-account","depth":2},{"value":"Endpoint","id":"endpoint","depth":3},{"value":"Behavior","id":"behavior","depth":3},{"value":"Path parameters","id":"path-parameters","depth":3},{"value":"Request body","id":"request-body","depth":3},{"value":"Validations","id":"validations","depth":3},{"value":"Successful response","id":"successful-response","depth":3},{"value":"Example","id":"example","depth":3},{"value":"Notes","id":"notes","depth":3},{"value":"Possible errors","id":"possible-errors","depth":3},{"value":"Account already cancelled","id":"account-already-cancelled","depth":4},{"value":"Only private accounts can be cancelled","id":"only-private-accounts-can-be-cancelled","depth":4},{"value":"Invalid balance","id":"invalid-balance","depth":4},{"value":"Account does not belong to the specified client","id":"account-does-not-belong-to-the-specified-client","depth":4},{"value":"Block a private account","id":"block-a-private-account","depth":2},{"value":"Endpoint","id":"endpoint-1","depth":3},{"value":"Behavior","id":"behavior-1","depth":3},{"value":"Path parameters","id":"path-parameters-1","depth":3},{"value":"Request body","id":"request-body-1","depth":3},{"value":"Validations","id":"validations-1","depth":3},{"value":"Successful response","id":"successful-response-1","depth":3},{"value":"Example","id":"example-1","depth":3},{"value":"Notes","id":"notes-1","depth":3},{"value":"Activate a private account","id":"activate-a-private-account","depth":2},{"value":"Endpoint","id":"endpoint-2","depth":3},{"value":"Behavior","id":"behavior-2","depth":3},{"value":"Path parameters","id":"path-parameters-2","depth":3},{"value":"Request body","id":"request-body-2","depth":3},{"value":"Validations","id":"validations-2","depth":3},{"value":"Successful response","id":"successful-response-2","depth":3},{"value":"Example","id":"example-2","depth":3},{"value":"Notes","id":"notes-2","depth":3},{"value":"API reference","id":"api-reference","depth":2}],"frontmatter":{"seo":{"title":"Private Account Lifecycle"}},"lastModified":"2026-03-13T19:35:21.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/fincore/guides/private-account-lifecycle","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}