Skip to content
Rails
Get startedWebsite
API Reference
Transactions

List transactions by organization

TransactionListResponse Transactions.List(TransactionListParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/transactions

List transactions by organization

ParametersExpand Collapse
TransactionListParams parameters
required string organizationID
formatuuid
Long page
minimum1
Long perPage
minimum1
maximum100
ReturnsExpand Collapse
class TransactionListResponse:
required IReadOnlyList<Data> Data
required string ID
formatuuid
required Long Amount

Amount in minor units

required DateTimeOffset CreatedAt
formatdate-time
required string Currency
required string FromAccountID
formatuuid
required string OrganizationID
formatuuid
required Status Status
One of the following:
"pending"Pending
"posted"Posted
"failed"Failed
required string ToAccountID
formatuuid
required TransactionKind TransactionKind
One of the following:
"deposit"Deposit
"withdraw"Withdraw
"transfer"Transfer
required DateTimeOffset UpdatedAt
formatdate-time
string? Environment
string? FailureReason
string IdempotencyKey

List transactions by organization

TransactionListParams parameters = new()
{
    OrganizationID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
};

var transactions = await client.Transactions.List(parameters);

Console.WriteLine(transactions);
{
  "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
  }
}