Skip to content
Rails
Get startedWebsite
API Reference
Accounts

Transfer between accounts

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

Transfer between accounts

Path ParametersExpand Collapse
id: string
formatuuid
Body ParametersJSONExpand Collapse
amount: string
to_account_id: string
formatuuid
description: optional string
ReturnsExpand Collapse
from_account: Account { id, account_number, account_type, 10 more }
id: string
formatuuid
account_number: string
account_type: "checking" or "saving"
One of the following:
"checking"
"saving"
balance: string
currency: string
environment: string
status: "active" or "suspended" or "closed"
One of the following:
"active"
"suspended"
"closed"
user_id: string
formatuuid
admin_user_id: optional string
formatuuid
created_at: optional string
formatdate-time
organization_id: optional string
formatuuid
updated_at: optional string
formatdate-time
user_role: optional string
to_account: Account { id, account_number, account_type, 10 more }
id: string
formatuuid
account_number: string
account_type: "checking" or "saving"
One of the following:
"checking"
"saving"
balance: string
currency: string
environment: string
status: "active" or "suspended" or "closed"
One of the following:
"active"
"suspended"
"closed"
user_id: string
formatuuid
admin_user_id: optional string
formatuuid
created_at: optional string
formatdate-time
organization_id: optional string
formatuuid
updated_at: optional string
formatdate-time
user_role: optional string
transaction: Transaction { id, account_id, amount, 10 more }
id: string
formatuuid
account_id: string
formatuuid
amount: string
balance_after: string
created_at: string
formatdate-time
currency: string
status: "pending" or "completed" or "failed" or "cancelled"
One of the following:
"pending"
"completed"
"failed"
"cancelled"
transaction_type: "deposit" or "withdrawal" or "transfer" or 2 more
One of the following:
"deposit"
"withdrawal"
"transfer"
"recurring_payment"
"savings_withdraw"
updated_at: string
formatdate-time
description: optional string
external_recipient_id: optional string
recipient_account_id: optional string
formatuuid
reference_id: optional string
formatuuid

Transfer between accounts

curl https://accounts-service-staging.up.railway.app/api/v1/accounts/$ID/transfer \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $RAILS_API_KEY" \
    -d '{
          "amount": "amount",
          "to_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        }'
{
  "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"
  }
}