Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

rails

package module

Go to main page

Versions in this module

v0

v0.3.0

May 11, 2026

Changes in this version

+ type AuditEventListParams struct

+ Action param.Opt[string]

+ Environment AuditEventListParamsEnvironment

+ From param.Opt[time.Time]

+ Outcome AuditEventListParamsOutcome

+ Page param.Opt[int64]

+ PerPage param.Opt[int64]

+ TargetID param.Opt[string]

+ TargetType param.Opt[string]

+ To param.Opt[time.Time]

+ func (r AuditEventListParams) URLQuery() (v url.Values, err error)

+ type AuditEventListParamsEnvironment string

+ const AuditEventListParamsEnvironmentProduction

+ const AuditEventListParamsEnvironmentSandbox

+ type AuditEventListParamsOutcome string

+ const AuditEventListParamsOutcomeClientError

+ const AuditEventListParamsOutcomeServerError

+ const AuditEventListParamsOutcomeSuccess

+ type AuditEventListResponse struct

+ Data []AuditEventListResponseData

+ JSON struct{ ... }

+ Pagination AuditEventListResponsePagination

+ func (r *AuditEventListResponse) UnmarshalJSON(data []byte) error

+ func (r AuditEventListResponse) RawJSON() string

+ type AuditEventListResponseData struct

+ Action string

+ Actor AuditEventListResponseDataActor

+ CorrelationID string

+ CreatedAt time.Time

+ Environment string

+ ID string

+ JSON struct{ ... }

+ Metadata map[string]string

+ OccurredAt time.Time

+ OrganizationID string

+ Outcome string

+ Reason string

+ Request AuditEventListResponseDataRequest

+ SchemaVersion int64

+ SourceService string

+ Target AuditEventListResponseDataTarget

+ func (r *AuditEventListResponseData) UnmarshalJSON(data []byte) error

+ func (r AuditEventListResponseData) RawJSON() string

+ type AuditEventListResponseDataActor struct

+ ID string

+ JSON struct{ ... }

+ Roles []string

+ Type string

+ func (r *AuditEventListResponseDataActor) UnmarshalJSON(data []byte) error

+ func (r AuditEventListResponseDataActor) RawJSON() string

+ type AuditEventListResponseDataRequest struct

+ ID string

+ IP string

+ JSON struct{ ... }

+ Method string

+ Path string

+ UserAgent string

+ func (r *AuditEventListResponseDataRequest) UnmarshalJSON(data []byte) error

+ func (r AuditEventListResponseDataRequest) RawJSON() string

+ type AuditEventListResponseDataTarget struct

+ ID string

+ JSON struct{ ... }

+ Type string

+ func (r *AuditEventListResponseDataTarget) UnmarshalJSON(data []byte) error

+ func (r AuditEventListResponseDataTarget) RawJSON() string

+ type AuditEventListResponsePagination struct

+ JSON struct{ ... }

+ Page int64

+ PerPage int64

+ TotalCount int64

+ TotalPages int64

+ func (r *AuditEventListResponsePagination) UnmarshalJSON(data []byte) error

+ func (r AuditEventListResponsePagination) RawJSON() string

+ type AuditEventService struct

+ Options []option.RequestOption

+ func NewAuditEventService(opts ...option.RequestOption) (r AuditEventService)

+ func (r *AuditEventService) List(ctx context.Context, query AuditEventListParams, opts ...option.RequestOption) (res *AuditEventListResponse, err error)

type Client

+ AuditEvents AuditEventService

v0.2.0

Apr 22, 2026

Changes in this version

+ const TransactionStatusCancelled

+ const TransactionStatusCompleted

+ const TransactionStatusFailed

+ const TransactionStatusPending

+ const TransactionTransactionTypeDeposit

+ const TransactionTransactionTypeRecurringPayment

+ const TransactionTransactionTypeSavingsWithdraw

+ const TransactionTransactionTypeTransfer

+ const TransactionTransactionTypeWithdrawal

+ func Bool(b bool) param.Opt[bool]

+ func BoolPtr(v bool) *bool

+ func DefaultClientOptions() []option.RequestOption

+ func File(rdr io.Reader, filename string, contentType string) file

+ func Float(f float64) param.Opt[float64]

+ func FloatPtr(v float64) *float64

+ func Int(i int64) param.Opt[int64]

+ func IntPtr(v int64) *int64

+ func Opt[T comparable](v T) param.Opt[T]

+ func Ptr[T any](v T) *T

+ func String(s string) param.Opt[string]

+ func StringPtr(v string) *string

+ func Time(t time.Time) param.Opt[time.Time]

+ func TimePtr(v time.Time) *time.Time

+ type Account struct

+ AccountNumber string

+ AccountType AccountAccountType

+ AdminUserID string

+ Balance string

+ CreatedAt time.Time

+ Currency string

+ Environment string

+ ID string

+ JSON struct{ ... }

+ OrganizationID string

+ Status AccountStatus

+ UpdatedAt time.Time

+ UserID string

+ UserRole string

+ func (r *Account) UnmarshalJSON(data []byte) error

+ func (r Account) RawJSON() string

+ type AccountAccountType string

+ const AccountAccountTypeChecking

+ const AccountAccountTypeSaving

+ type AccountDepositParams struct

+ Amount string

+ Description param.Opt[string]

+ func (r *AccountDepositParams) UnmarshalJSON(data []byte) error

+ func (r AccountDepositParams) MarshalJSON() (data []byte, err error)

+ type AccountDepositResponse struct

+ Account Account

+ JSON struct{ ... }

+ Transaction shared.Transaction

+ func (r *AccountDepositResponse) UnmarshalJSON(data []byte) error

+ func (r AccountDepositResponse) RawJSON() string

+ type AccountListParams struct

+ UserID string

+ func (r AccountListParams) URLQuery() (v url.Values, err error)

+ type AccountNewParams struct

+ AccountType AccountNewParamsAccountType

+ Currency param.Opt[string]

+ Environment param.Opt[string]

+ OrganizationID param.Opt[string]

+ UserID string

+ func (r *AccountNewParams) UnmarshalJSON(data []byte) error

+ func (r AccountNewParams) MarshalJSON() (data []byte, err error)

+ type AccountNewParamsAccountType string

+ const AccountNewParamsAccountTypeChecking

+ const AccountNewParamsAccountTypeSaving

+ type AccountService struct

+ Options []option.RequestOption

+ func NewAccountService(opts ...option.RequestOption) (r AccountService)

+ func (r *AccountService) Close(ctx context.Context, id string, opts ...option.RequestOption) (res *Account, err error)

+ func (r *AccountService) Deposit(ctx context.Context, id string, body AccountDepositParams, ...) (res *AccountDepositResponse, err error)

+ func (r *AccountService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *Account, err error)

+ func (r *AccountService) List(ctx context.Context, query AccountListParams, opts ...option.RequestOption) (res *[]Account, err error)

+ func (r *AccountService) New(ctx context.Context, body AccountNewParams, opts ...option.RequestOption) (res *Account, err error)

+ func (r *AccountService) Transfer(ctx context.Context, id string, body AccountTransferParams, ...) (res *AccountTransferResponse, err error)

+ func (r *AccountService) UpdateStatus(ctx context.Context, id string, body AccountUpdateStatusParams, ...) (res *Account, err error)

+ func (r *AccountService) Withdraw(ctx context.Context, id string, body AccountWithdrawParams, ...) (res *AccountWithdrawResponse, err error)

+ type AccountStatus string

+ const AccountStatusActive

+ const AccountStatusClosed

+ const AccountStatusSuspended

+ type AccountTransferParams struct

+ Amount string

+ Description param.Opt[string]

+ ToAccountID string

+ func (r *AccountTransferParams) UnmarshalJSON(data []byte) error

+ func (r AccountTransferParams) MarshalJSON() (data []byte, err error)

+ type AccountTransferResponse struct

+ FromAccount Account

+ JSON struct{ ... }

+ ToAccount Account

+ Transaction shared.Transaction

+ func (r *AccountTransferResponse) UnmarshalJSON(data []byte) error

+ func (r AccountTransferResponse) RawJSON() string

+ type AccountUpdateStatusParams struct

+ Status AccountUpdateStatusParamsStatus

+ func (r *AccountUpdateStatusParams) UnmarshalJSON(data []byte) error

+ func (r AccountUpdateStatusParams) MarshalJSON() (data []byte, err error)

+ type AccountUpdateStatusParamsStatus string

+ const AccountUpdateStatusParamsStatusActive

+ const AccountUpdateStatusParamsStatusClosed

+ const AccountUpdateStatusParamsStatusSuspended

+ type AccountWithdrawParams struct

+ Amount string

+ Description param.Opt[string]

+ func (r *AccountWithdrawParams) UnmarshalJSON(data []byte) error

+ func (r AccountWithdrawParams) MarshalJSON() (data []byte, err error)

+ type AccountWithdrawResponse struct

+ Account Account

+ JSON struct{ ... }

+ Transaction shared.Transaction

+ func (r *AccountWithdrawResponse) UnmarshalJSON(data []byte) error

+ func (r AccountWithdrawResponse) RawJSON() string

+ type Client struct

+ Accounts AccountService

+ Options []option.RequestOption

+ Transactions TransactionService

+ Users UserService

+ func NewClient(opts ...option.RequestOption) (r Client)

+ func (r *Client) Delete(ctx context.Context, path string, params any, res any, ...) error

+ func (r *Client) Execute(ctx context.Context, method string, path string, params any, res any, ...) error

+ func (r *Client) Get(ctx context.Context, path string, params any, res any, ...) error

+ func (r *Client) Patch(ctx context.Context, path string, params any, res any, ...) error

+ func (r *Client) Post(ctx context.Context, path string, params any, res any, ...) error

+ func (r *Client) Put(ctx context.Context, path string, params any, res any, ...) error

+ type Error = apierror.Error

+ type Transaction = shared.Transaction

+ type TransactionListByAccountParams struct

+ Limit param.Opt[int64]

+ func (r TransactionListByAccountParams) URLQuery() (v url.Values, err error)

+ type TransactionListParams struct

+ OrganizationID string

+ Page param.Opt[int64]

+ PerPage param.Opt[int64]

+ func (r TransactionListParams) URLQuery() (v url.Values, err error)

+ type TransactionListResponse struct

+ Data []TransactionListResponseData

+ JSON struct{ ... }

+ Pagination TransactionListResponsePagination

+ func (r *TransactionListResponse) UnmarshalJSON(data []byte) error

+ func (r TransactionListResponse) RawJSON() string

+ type TransactionListResponseData struct

+ Amount int64

+ CreatedAt time.Time

+ Currency string

+ Environment string

+ FailureReason string

+ FromAccountID string

+ ID string

+ IdempotencyKey string

+ JSON struct{ ... }

+ OrganizationID string

+ Status string

+ ToAccountID string

+ TransactionKind string

+ UpdatedAt time.Time

+ func (r *TransactionListResponseData) UnmarshalJSON(data []byte) error

+ func (r TransactionListResponseData) RawJSON() string

+ type TransactionListResponsePagination struct

+ JSON struct{ ... }

+ Page int64

+ PerPage int64

+ TotalCount int64

+ TotalPages int64

+ func (r *TransactionListResponsePagination) UnmarshalJSON(data []byte) error

+ func (r TransactionListResponsePagination) RawJSON() string

+ type TransactionService struct

+ Options []option.RequestOption

+ func NewTransactionService(opts ...option.RequestOption) (r TransactionService)

+ func (r *TransactionService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *shared.Transaction, err error)

+ func (r *TransactionService) List(ctx context.Context, query TransactionListParams, opts ...option.RequestOption) (res *TransactionListResponse, err error)

+ func (r *TransactionService) ListByAccount(ctx context.Context, accountID string, query TransactionListByAccountParams, ...) (res *[]shared.Transaction, err error)

+ type TransactionStatus = shared.TransactionStatus

+ type TransactionTransactionType = shared.TransactionTransactionType

+ type UserNewParams struct

+ Email string

+ FirstName string

+ LastName string

+ Password string

+ XEnvironment UserNewParamsXEnvironment

+ func (r *UserNewParams) UnmarshalJSON(data []byte) error

+ func (r UserNewParams) MarshalJSON() (data []byte, err error)

+ type UserNewParamsXEnvironment string

+ const UserNewParamsXEnvironmentProduction

+ const UserNewParamsXEnvironmentSandbox

+ type UserNewResponse struct

+ JSON struct{ ... }

+ Status string

+ UserID string

+ func (r *UserNewResponse) UnmarshalJSON(data []byte) error

+ func (r UserNewResponse) RawJSON() string

+ type UserService struct

+ Options []option.RequestOption

+ func NewUserService(opts ...option.RequestOption) (r UserService)

+ func (r *UserService) New(ctx context.Context, params UserNewParams, opts ...option.RequestOption) (res *UserNewResponse, err error)