Skip to content
Rails
Get startedWebsite
API Reference
Transactions

Retrieve transaction

transactions().retrieve(TransactionRetrieveParamsparams = TransactionRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none()) : Transaction
GET/api/v1/transactions/{id}

Retrieve transaction

ParametersExpand Collapse
params: TransactionRetrieveParams
id: Optional<String>
formatuuid
ReturnsExpand Collapse
class Transaction:
id: String
formatuuid
accountId: String
formatuuid
amount: String
balanceAfter: String
createdAt: LocalDateTime
formatdate-time
currency: String
status: Status
One of the following:
PENDING("pending")
COMPLETED("completed")
FAILED("failed")
CANCELLED("cancelled")
transactionType: TransactionType
One of the following:
DEPOSIT("deposit")
WITHDRAWAL("withdrawal")
TRANSFER("transfer")
RECURRING_PAYMENT("recurring_payment")
SAVINGS_WITHDRAW("savings_withdraw")
updatedAt: LocalDateTime
formatdate-time
description: Optional<String>
externalRecipientId: Optional<String>
recipientAccountId: Optional<String>
formatuuid
referenceId: Optional<String>
formatuuid

Retrieve transaction

package com.rails.api.example

import com.rails.api.client.RailsClient
import com.rails.api.client.okhttp.RailsOkHttpClient
import com.rails.api.models.Transaction
import com.rails.api.models.transactions.TransactionRetrieveParams

fun main() {
    val client: RailsClient = RailsOkHttpClient.fromEnv()

    val transaction: Transaction = client.transactions().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
}
{
  "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"
}