Retrieve transaction

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

GET/api/v1/transactions/{id}

ParametersExpand Collapse

id: string

formatuuid

ReturnsExpand Collapse

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

Retrieve transaction

import Rails from 'railsinfra';

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

const transaction = await client.transactions.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(transaction.id);

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "amount": "amount",
  "balance_after": "balance_after",
  "created_at": "2019-12-27T18:11:19.117Z",
  "currency": "currency",
  "status": "pending",
  "transaction_type": "deposit",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "external_recipient_id": "external_recipient_id",
  "recipient_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "reference_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}

Returns Examples

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "amount": "amount",
  "balance_after": "balance_after",
  "created_at": "2019-12-27T18:11:19.117Z",
  "currency": "currency",
  "status": "pending",
  "transaction_type": "deposit",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "external_recipient_id": "external_recipient_id",
  "recipient_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "reference_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}