API Reference

Transactions

Retrieve transaction

Transaction transactions().retrieve(TransactionRetrieveParamsparams = TransactionRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/transactions/{id}

Retrieve transaction

ParametersExpand Collapse

TransactionRetrieveParams params

Optional<String> id

formatuuid

ReturnsExpand Collapse

class Transaction:

String id

formatuuid

String accountId

formatuuid

String amount

String balanceAfter

LocalDateTime createdAt

formatdate-time

String currency

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

LocalDateTime updatedAt

formatdate-time

Optional<String> description

Optional<String> externalRecipientId

Optional<String> recipientAccountId

formatuuid

Optional<String> referenceId

formatuuid

Retrieve transaction

Java

unfold_more

TypeScript

Java

Kotlin

Go

C#

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;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        RailsClient client = RailsOkHttpClient.fromEnv();

        Transaction transaction = client.transactions().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
    }
}

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