Skip to content
Rails
Get startedWebsite
API Reference
Accounts

Update account status

accounts().updateStatus(AccountUpdateStatusParamsparams = AccountUpdateStatusParams.none(), RequestOptionsrequestOptions = RequestOptions.none()) : Account
PATCH/api/v1/accounts/{id}

Update account status

ParametersExpand Collapse
params: AccountUpdateStatusParams
id: Optional<String>
formatuuid
status: Optional<Status>
ACTIVE("active")
SUSPENDED("suspended")
CLOSED("closed")
ReturnsExpand Collapse
class Account:
id: String
formatuuid
accountNumber: String
accountType: AccountType
One of the following:
CHECKING("checking")
SAVING("saving")
balance: String
currency: String
environment: String
status: Status
One of the following:
ACTIVE("active")
SUSPENDED("suspended")
CLOSED("closed")
userId: String
formatuuid
adminUserId: Optional<String>
formatuuid
createdAt: Optional<LocalDateTime>
formatdate-time
organizationId: Optional<String>
formatuuid
updatedAt: Optional<LocalDateTime>
formatdate-time
userRole: Optional<String>

Update account status

package com.rails.api.example

import com.rails.api.client.RailsClient
import com.rails.api.client.okhttp.RailsOkHttpClient
import com.rails.api.models.accounts.Account
import com.rails.api.models.accounts.AccountUpdateStatusParams

fun main() {
    val client: RailsClient = RailsOkHttpClient.fromEnv()

    val account: Account = client.accounts().updateStatus("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
}
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "account_number": "account_number",
  "account_type": "checking",
  "balance": "balance",
  "currency": "currency",
  "environment": "environment",
  "status": "active",
  "user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "admin_user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "user_role": "user_role"
}
Returns Examples
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "account_number": "account_number",
  "account_type": "checking",
  "balance": "balance",
  "currency": "currency",
  "environment": "environment",
  "status": "active",
  "user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "admin_user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "user_role": "user_role"
}