API Reference

Transactions

Transactions

List transactions by organization

client.transactions.list(TransactionListParams { organization_id, page, per_page } query, RequestOptionsoptions?): TransactionListResponse { data, pagination }

GET/api/v1/transactions

List account transactions

client.transactions.listByAccount(stringaccountID, TransactionListByAccountParams { limit } query?, RequestOptionsoptions?): TransactionListByAccountResponse { id, account_id, amount, 10 more }

GET/api/v1/accounts/{account_id}/transactions

Retrieve transaction

client.transactions.retrieve(stringid, RequestOptionsoptions?): Transaction { id, account_id, amount, 10 more }

GET/api/v1/transactions/{id}

ModelsExpand 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

TransactionListByAccountResponse = Array<Transaction { id, account_id, amount, 10 more } >

id: string

formatuuid

account_id: string

formatuuid

amount: string

balance_after: string

created_at: string

formatdate-time

currency: string

status: "pending" | "completed" | "failed" | "cancelled"

One of the following:

"pending"

"completed"

"failed"

"cancelled"

transaction_type: "deposit" | "withdrawal" | "transfer" | 2 more

One of the following:

"deposit"

"withdrawal"

"transfer"

"recurring_payment"

"savings_withdraw"

updated_at: string

formatdate-time

description?: string | null

external_recipient_id?: string | null

recipient_account_id?: string | null

formatuuid

reference_id?: string | null

formatuuid