Skip to content
Rails
Get startedWebsite
API Reference
Accounts

Transfer between accounts

AccountTransferResponse accounts().transfer(AccountTransferParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/api/v1/accounts/{id}/transfer

Transfer between accounts

ParametersExpand Collapse
AccountTransferParams params
Optional<String> id
formatuuid
String amount
String toAccountId
formatuuid
Optional<String> description
ReturnsExpand Collapse
class AccountTransferResponse:
Account fromAccount
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
Account toAccount
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
Transaction transaction
String id
formatuuid
String accountId
formatuuid
String amount
String balanceAfter
LocalDateTime createdAt
formatdate-time
String currency
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")
LocalDateTime updatedAt
formatdate-time
Optional<String> description
Optional<String> externalRecipientId
Optional<String> recipientAccountId
formatuuid
Optional<String> referenceId
formatuuid

Transfer between accounts

package com.rails.api.example;

import com.rails.api.client.RailsClient;
import com.rails.api.client.okhttp.RailsOkHttpClient;
import com.rails.api.models.accounts.AccountTransferParams;
import com.rails.api.models.accounts.AccountTransferResponse;

public final class Main {
    private Main() {}

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

        AccountTransferParams params = AccountTransferParams.builder()
            .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .amount("amount")
            .toAccountId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .build();
        AccountTransferResponse response = client.accounts().transfer(params);
    }
}
{
  "from_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"
  },
  "to_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
{
  "from_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"
  },
  "to_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"
  }
}