API Reference

Accounts

Close account

Account accounts().close(AccountCloseParamsparams = AccountCloseParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

DELETE/api/v1/accounts/{id}

Close account

ParametersExpand Collapse

AccountCloseParams params

Optional<String> id

formatuuid

ReturnsExpand Collapse

class Account:

String id

formatuuid

String accountNumber

AccountType accountType

One of the following:

CHECKING("checking")

SAVING("saving")

String balance

String currency

String environment

Status status

One of the following:

ACTIVE("active")

SUSPENDED("suspended")

CLOSED("closed")

String userId

formatuuid

Optional<String> adminUserId

formatuuid

Optional<LocalDateTime> createdAt

formatdate-time

Optional<String> organizationId

formatuuid

Optional<LocalDateTime> updatedAt

formatdate-time

Optional<String> userRole

Close account

Java

unfold_more

TypeScript

Java

Kotlin

Go

C#

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.AccountCloseParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        RailsClient client = RailsOkHttpClient.fromEnv();

        Account account = client.accounts().close("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
    }
}

200 example

{
  "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

200 example

{
  "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"
}