Skip to content
Rails
Get startedWebsite
API Reference
Transactions

List transactions by organization

transactions().list(TransactionListParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : TransactionListResponse
GET/api/v1/transactions

List transactions by organization

ParametersExpand Collapse
params: TransactionListParams
organizationId: String
formatuuid
page: Optional<Long>
minimum1
perPage: Optional<Long>
minimum1
maximum100
ReturnsExpand Collapse
class TransactionListResponse:
data: List<Data>
id: String
formatuuid
amount: Long

Amount in minor units

createdAt: LocalDateTime
formatdate-time
currency: String
fromAccountId: String
formatuuid
organizationId: String
formatuuid
status: Status
One of the following:
PENDING("pending")
POSTED("posted")
FAILED("failed")
toAccountId: String
formatuuid
transactionKind: TransactionKind
One of the following:
DEPOSIT("deposit")
WITHDRAW("withdraw")
TRANSFER("transfer")
updatedAt: LocalDateTime
formatdate-time
environment: Optional<String>
failureReason: Optional<String>
idempotencyKey: Optional<String>

List transactions by organization

package com.rails.api.example

import com.rails.api.client.RailsClient
import com.rails.api.client.okhttp.RailsOkHttpClient
import com.rails.api.models.transactions.TransactionListParams
import com.rails.api.models.transactions.TransactionListResponse

fun main() {
    val client: RailsClient = RailsOkHttpClient.fromEnv()

    val params: TransactionListParams = TransactionListParams.builder()
        .organizationId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
        .build()
    val transactions: TransactionListResponse = client.transactions().list(params)
}
{
  "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
  }
}