Skip to content
Rails
Get startedWebsite
API Reference
Transactions

List transactions by organization

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

List transactions by organization

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

Amount in minor units

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

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;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        RailsClient client = RailsOkHttpClient.fromEnv();

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