API Reference

Transactions

List account transactions

client.Transactions.ListByAccount(ctx, accountID, query) (*[]Transaction, error)

GET/api/v1/accounts/{account_id}/transactions

List account transactions

ParametersExpand Collapse

accountID string

formatuuid

query TransactionListByAccountParams

Limit param.Field[int64]Optional

formatint64

ReturnsExpand Collapse

type TransactionListByAccountResponse []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

List account transactions

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"),
  )
  transactions, err := client.Transactions.ListByAccount(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    rails.TransactionListByAccountParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", transactions)
}

200 example

[
  {
    "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

[
  {
    "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"
  }
]