Skip to content
Rails
Get startedWebsite
API Reference
Accounts

Transfer between accounts

AccountTransferResponse Accounts.Transfer(AccountTransferParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/accounts/{id}/transfer

Transfer between accounts

ParametersExpand Collapse
AccountTransferParams parameters
required string id
formatuuid
required string amount
required string toAccountID
formatuuid
string? description
ReturnsExpand Collapse
class AccountTransferResponse:
required Account FromAccount
required string ID
formatuuid
required string AccountNumber
required AccountType AccountType
One of the following:
"checking"Checking
"saving"Saving
required string Balance
required string Currency
required string Environment
required Status Status
One of the following:
"active"Active
"suspended"Suspended
"closed"Closed
required string UserID
formatuuid
string? AdminUserID
formatuuid
DateTimeOffset? CreatedAt
formatdate-time
string? OrganizationID
formatuuid
DateTimeOffset? UpdatedAt
formatdate-time
string? UserRole
required Account ToAccount
required string ID
formatuuid
required string AccountNumber
required AccountType AccountType
One of the following:
"checking"Checking
"saving"Saving
required string Balance
required string Currency
required string Environment
required Status Status
One of the following:
"active"Active
"suspended"Suspended
"closed"Closed
required string UserID
formatuuid
string? AdminUserID
formatuuid
DateTimeOffset? CreatedAt
formatdate-time
string? OrganizationID
formatuuid
DateTimeOffset? UpdatedAt
formatdate-time
string? UserRole
required Transaction Transaction
required string ID
formatuuid
required string AccountID
formatuuid
required string Amount
required string BalanceAfter
required DateTimeOffset CreatedAt
formatdate-time
required string Currency
required Status Status
One of the following:
"pending"Pending
"completed"Completed
"failed"Failed
"cancelled"Cancelled
required TransactionType TransactionType
One of the following:
"deposit"Deposit
"withdrawal"Withdrawal
"transfer"Transfer
"recurring_payment"RecurringPayment
"savings_withdraw"SavingsWithdraw
required DateTimeOffset UpdatedAt
formatdate-time
string? Description
string? ExternalRecipientID
string? RecipientAccountID
formatuuid
string? ReferenceID
formatuuid

Transfer between accounts

AccountTransferParams parameters = new()
{
    ID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    Amount = "amount",
    ToAccountID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
};

var response = await client.Accounts.Transfer(parameters);

Console.WriteLine(response);
{
  "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"
  }
}