API Reference

Transactions

Retrieve transaction

Transaction Transactions.Retrieve(TransactionRetrieveParamsparameters, CancellationTokencancellationToken = default)

GET/api/v1/transactions/{id}

Retrieve transaction

ParametersExpand Collapse

TransactionRetrieveParams parameters

required string id

formatuuid

ReturnsExpand Collapse

class Transaction:

required string ID

formatuuid

required string AccountID

formatuuid

required string Amount

required string BalanceAfter

required DateTimeOffset CreatedAt

formatdate-time

required string Currency

required Status Status

One of the following:

"pending"Pending

"completed"Completed

"failed"Failed

"cancelled"Cancelled

required TransactionType TransactionType

One of the following:

"deposit"Deposit

"withdrawal"Withdrawal

"transfer"Transfer

"recurring_payment"RecurringPayment

"savings_withdraw"SavingsWithdraw

required DateTimeOffset UpdatedAt

formatdate-time

string? Description

string? ExternalRecipientID

string? RecipientAccountID

formatuuid

string? ReferenceID

formatuuid

Retrieve transaction

C#

unfold_more

TypeScript

Java

Kotlin

Go

C#

TransactionRetrieveParams parameters = new()
{
    ID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
};

var transaction = await client.Transactions.Retrieve(parameters);

Console.WriteLine(transaction);

200 example

{
  "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

200 example

{
  "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"
}