Skip to content
Rails
Get startedWebsite
API Reference
Transactions

List transactions by organization

client.Transactions.List(ctx, query) (*TransactionListResponse, error)
GET/api/v1/transactions

List transactions by organization

ParametersExpand Collapse
query TransactionListParams
OrganizationID param.Field[string]
formatuuid
Page param.Field[int64]Optional
minimum1
PerPage param.Field[int64]Optional
minimum1
maximum100
ReturnsExpand Collapse
type TransactionListResponse struct{…}
Data []TransactionListResponseData
ID string
formatuuid
Amount int64

Amount in minor units

CreatedAt Time
formatdate-time
Currency string
FromAccountID string
formatuuid
OrganizationID string
formatuuid
Status string
One of the following:
const TransactionListResponseDataStatusPending TransactionListResponseDataStatus = "pending"
const TransactionListResponseDataStatusPosted TransactionListResponseDataStatus = "posted"
const TransactionListResponseDataStatusFailed TransactionListResponseDataStatus = "failed"
ToAccountID string
formatuuid
TransactionKind string
One of the following:
const TransactionListResponseDataTransactionKindDeposit TransactionListResponseDataTransactionKind = "deposit"
const TransactionListResponseDataTransactionKindWithdraw TransactionListResponseDataTransactionKind = "withdraw"
const TransactionListResponseDataTransactionKindTransfer TransactionListResponseDataTransactionKind = "transfer"
UpdatedAt Time
formatdate-time
Environment stringOptional
FailureReason stringOptional
IdempotencyKey stringOptional

List transactions by organization

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.List(context.TODO(), rails.TransactionListParams{
    OrganizationID: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", transactions.Data)
}

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "amount": 0,
      "created_at": "2019-12-27T18:11:19.117Z",
      "currency": "currency",
      "from_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "status": "pending",
      "to_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "transaction_kind": "deposit",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "environment": "environment",
      "failure_reason": "failure_reason",
      "idempotency_key": "idempotency_key"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total_count": 0,
    "total_pages": 0
  }
}
Returns Examples
{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "amount": 0,
      "created_at": "2019-12-27T18:11:19.117Z",
      "currency": "currency",
      "from_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "status": "pending",
      "to_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "transaction_kind": "deposit",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "environment": "environment",
      "failure_reason": "failure_reason",
      "idempotency_key": "idempotency_key"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total_count": 0,
    "total_pages": 0
  }
}