API Reference

Accounts

Deposit into account

accounts().deposit(AccountDepositParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : AccountDepositResponse

POST/api/v1/accounts/{id}/deposit

Deposit into account

ParametersExpand Collapse

params: AccountDepositParams

id: Optional<String>

formatuuid

amount: String

description: Optional<String>

ReturnsExpand Collapse

class AccountDepositResponse:

account: 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>

transaction: Transaction

id: String

formatuuid

accountId: String

formatuuid

amount: String

balanceAfter: String

createdAt: LocalDateTime

formatdate-time

currency: String

status: Status

One of the following:

PENDING("pending")

COMPLETED("completed")

FAILED("failed")

CANCELLED("cancelled")

transactionType: TransactionType

One of the following:

DEPOSIT("deposit")

WITHDRAWAL("withdrawal")

TRANSFER("transfer")

RECURRING_PAYMENT("recurring_payment")

SAVINGS_WITHDRAW("savings_withdraw")

updatedAt: LocalDateTime

formatdate-time

description: Optional<String>

externalRecipientId: Optional<String>

recipientAccountId: Optional<String>

formatuuid

referenceId: Optional<String>

formatuuid

Deposit into 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.AccountDepositParams
import com.rails.api.models.accounts.AccountDepositResponse

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

    val params: AccountDepositParams = AccountDepositParams.builder()
        .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
        .amount("amount")
        .build()
    val response: AccountDepositResponse = client.accounts().deposit(params)
}

200 example

{
  "account": {
    "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"
  },
  "transaction": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "amount": "amount",
    "balance_after": "balance_after",
    "created_at": "2019-12-27T18:11:19.117Z",
    "currency": "currency",
    "status": "pending",
    "transaction_type": "deposit",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "external_recipient_id": "external_recipient_id",
    "recipient_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "reference_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}

Returns Examples

200 example

{
  "account": {
    "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"
  },
  "transaction": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "amount": "amount",
    "balance_after": "balance_after",
    "created_at": "2019-12-27T18:11:19.117Z",
    "currency": "currency",
    "status": "pending",
    "transaction_type": "deposit",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "external_recipient_id": "external_recipient_id",
    "recipient_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "reference_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}