API Reference

Accounts

Withdraw from account

client.Accounts.Withdraw(ctx, id, body) (*AccountWithdrawResponse, error)

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

Withdraw from account

ParametersExpand Collapse

id string

formatuuid

body AccountWithdrawParams

Amount param.Field[string]

Description param.Field[string]Optional

ReturnsExpand Collapse

type AccountWithdrawResponse struct{…}

Account Account

ID string

formatuuid

AccountNumber string

AccountType AccountAccountType

One of the following:

const AccountAccountTypeChecking AccountAccountType = "checking"

const AccountAccountTypeSaving AccountAccountType = "saving"

Balance string

Currency string

Environment string

Status AccountStatus

One of the following:

const AccountStatusActive AccountStatus = "active"

const AccountStatusSuspended AccountStatus = "suspended"

const AccountStatusClosed AccountStatus = "closed"

UserID string

formatuuid

AdminUserID stringOptional

formatuuid

CreatedAt TimeOptional

formatdate-time

OrganizationID stringOptional

formatuuid

UpdatedAt TimeOptional

formatdate-time

UserRole stringOptional

Transaction Transaction

ID string

formatuuid

AccountID string

formatuuid

Amount string

BalanceAfter string

CreatedAt Time

formatdate-time

Currency string

Status TransactionStatus

One of the following:

const TransactionStatusPending TransactionStatus = "pending"

const TransactionStatusCompleted TransactionStatus = "completed"

const TransactionStatusFailed TransactionStatus = "failed"

const TransactionStatusCancelled TransactionStatus = "cancelled"

TransactionType TransactionTransactionType

One of the following:

const TransactionTransactionTypeDeposit TransactionTransactionType = "deposit"

const TransactionTransactionTypeWithdrawal TransactionTransactionType = "withdrawal"

const TransactionTransactionTypeTransfer TransactionTransactionType = "transfer"

const TransactionTransactionTypeRecurringPayment TransactionTransactionType = "recurring_payment"

const TransactionTransactionTypeSavingsWithdraw TransactionTransactionType = "savings_withdraw"

UpdatedAt Time

formatdate-time

Description stringOptional

ExternalRecipientID stringOptional

RecipientAccountID stringOptional

formatuuid

ReferenceID stringOptional

formatuuid

Withdraw from account

Go

unfold_more

TypeScript

Java

Kotlin

Go

C#

package main

import (
  "context"
  "fmt"

  "github.com/railsinfra/rails-go"
  "github.com/railsinfra/rails-go/option"
)

func main() {
  client := rails.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Accounts.Withdraw(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    rails.AccountWithdrawParams{
      Amount: "amount",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Account)
}

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