Transactions

List transactions by organization

GET/api/v1/transactions

List account transactions

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

Retrieve transaction

GET/api/v1/transactions/{id}

ModelsExpand Collapse

TransactionListResponse object { data, pagination }

data: array of object { id, amount, created_at, 10 more }

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" or "posted" or "failed"

One of the following:

"pending"

"posted"

"failed"

to_account_id: string

formatuuid

transaction_kind: "deposit" or "withdraw" or "transfer"

One of the following:

"deposit"

"withdraw"

"transfer"

updated_at: string

formatdate-time

environment: optional string

failure_reason: optional string

idempotency_key: optional string

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

page: number

minimum1

per_page: number

minimum1

total_count: number

total_pages: number

minimum0

TransactionListByAccountResponse = array of 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" or "completed" or "failed" or "cancelled"

One of the following:

"pending"

"completed"

"failed"

"cancelled"

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

One of the following:

"deposit"

"withdrawal"

"transfer"

"recurring_payment"

"savings_withdraw"

updated_at: string

formatdate-time

description: optional string

external_recipient_id: optional string

recipient_account_id: optional string

formatuuid

reference_id: optional string

formatuuid