API Reference

Accounts

Create account

accounts().create(AccountCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : Account

POST/api/v1/accounts

Create account

ParametersExpand Collapse

params: AccountCreateParams

accountType: AccountType

CHECKING("checking")

SAVING("saving")

userId: String

formatuuid

currency: Optional<String>

environment: Optional<String>

organizationId: Optional<String>

formatuuid

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>

Create account

Kotlin

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.AccountCreateParams

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

    val params: AccountCreateParams = AccountCreateParams.builder()
        .accountType(AccountCreateParams.AccountType.CHECKING)
        .userId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
        .build()
    val account: Account = client.accounts().create(params)
}

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