List transactions by organization

client.transactions.list(, ?): TransactionListResponse { data, pagination }

GET/api/v1/transactions

ParametersExpand Collapse

query: TransactionListParams { organization_id, page, per_page }

organization_id: string

formatuuid

page?: number

minimum1

per_page?: number

minimum1

maximum100

ReturnsExpand Collapse

TransactionListResponse { data, pagination }

data: Array<Data>

id: string

formatuuid

amount: number

Amount in minor units

created_at: string

formatdate-time

currency: string

from_account_id: string

formatuuid

organization_id: string

formatuuid

status: "pending" | "posted" | "failed"

One of the following:

"pending"

"posted"

"failed"

to_account_id: string

formatuuid

transaction_kind: "deposit" | "withdraw" | "transfer"

One of the following:

"deposit"

"withdraw"

"transfer"

updated_at: string

formatdate-time

environment?: string | null

failure_reason?: string | null

idempotency_key?: string

pagination: Pagination { page, per_page, total_count, total_pages }

page: number

minimum1

per_page: number

minimum1

total_count: number

total_pages: number

minimum0

List transactions by organization

import Rails from 'railsinfra';

const client = new Rails({
  apiKey: process.env['RAILS_API_KEY'], // This is the default and can be omitted
});

const transactions = await client.transactions.list({
  organization_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});

console.log(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
  }
}