Version: 1.0.4

List Transaction by Account

The 'List Transaction by Account' API enables to retrieve the list of transactions associated with an account number, and the transactions with their respective details are displayed in required pagination.

Method: POST

{{URL}}/TransactionService/ListTransactions

Example

Request Parameters

Parameter	Description
method Mandatory	String API method that is being called to get list of transactions through ledger service. Constant value – "TransactionService.ListTransactions"
id Mandatory	String Unique ID of API request. Sample value – "1"
params Mandatory	Object
api Mandatory	Object
credential Mandatory	String Basic (space) [(`"<Username>:<apiKey>"`) as Base64 encoded value] to be provided Sample Value: "Basic bmF2eWEubitlbXBAbmV0eGQuY29tOmY1OWIwY2NlOTU4ZTQ1YTc4MGVhZWIzYWVjOWVjZDAx"
signature Mandatory	String Sign the request payload (params.payload) using private key. Sample Value: "MEQCIAbpxHpdOyBEVlmxPYv7m4Z1OvWJJYw7g7u3GE3T9nmvAiBjKHckSvb1M6O4t7FeWsn2z9Y3dMeYn3HyX/k28ek/Dw=="
apiKey Optional	String API key is provided at the time of device registration. Sample Value : "f59b0cce958e45a780eaeb3aec9ecd01"
keyId Mandatory	String Key ID is provided at the time of device registration. Sample Value : "348076"
payload Mandatory	Object
page Optional	String Page Number of transaction list. Sample value – 1
size Optional	String Number of transactions per page. Sample value – 10
accountNumber Mandatory	String Account Number of the customer. Sample value – "200686362505215"

cURL
C#
Go
NodeJS

curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{"method":"TransactionService.ListTransactions","id":"1","params":{"api":{"signature":"{{signature}}","keyId":"{{ApplicationKeyId}}","credential":"{{Credential}}"},"payload":{"page":1,"size":10,"accountNumber":"200686362505215"}}}'

var options = new RestClientOptions("{{URL}}/jsonrpc")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"  ""method"": ""TransactionService.ListTransactions"",
" + "\n" +
@"  ""id"": ""1"",
" + "\n" +
@"  ""params"": {
" + "\n" +
@"    ""api"": {
" + "\n" +
@"      ""signature"": ""{{signature}}"",
" + "\n" +
@"      ""keyId"": ""{{ApplicationKeyId}}"",
" + "\n" +
@"      ""credential"": ""{{Credential}}""
" + "\n" +
@"    },
" + "\n" +
@"    ""payload"": {
" + "\n" +
@"      ""page"": 1,
" + "\n" +
@"      ""size"": 10,
" + "\n" +
@"      ""accountNumber"": ""200686362505215""
" + "\n" +
@"    }
" + "\n" +
@"  }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{URL}}/jsonrpc"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
  "method": "TransactionService.ListTransactions",`+"
"+`
  "id": "1",`+"
"+`
  "params": {`+"
"+`
    "api": {`+"
"+`
      "signature": "{{signature}}",`+"
"+`
      "keyId": "{{ApplicationKeyId}}",`+"
"+`
      "credential": "{{Credential}}"`+"
"+`
    },`+"
"+`
    "payload": {`+"
"+`
      "page": 1,`+"
"+`
      "size": 10,`+"
"+`
      "accountNumber": "200686362505215"`+"
"+`
    }`+"
"+`
  }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/jsonrpc',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "method": "TransactionService.ListTransactions",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "page": 1,
      "size": 10,
      "accountNumber": "200686362505215"
    }
  }
});

req.write(postData);

req.end();

Body

{
   "method": "TransactionService.ListTransactions",
   "id": "1",
   "params": {
       "payload": {
           "accountNumber": "200686362505215",
           "page": 1,
           "size": 10
       },
       "api": {
           "credential": "{{Credential}}",
           "signature": "{{signature}}",
           "apiKey": "{{ApiKey}}",
           "keyId": "{{DeviceID}}"
       }
   }
}

Response: 200

Response Parameters

Parameter	Description
id	String Unique ID of API request Sample Value : "1"
result	Object
totalDocs	Number Total Number of transactions occurred for the given account Sample Value : 2
accountTransactions	Array
type	Enum Type of transaction Valid values: REMITTANCE, CARDPAY, INTERNAL_TRANSFER, WITHDRAW, DEPOSIT, INTERNAL, EFT, BILLPAY, R2P, VOID, OPENING_BALANCE, FEE_REFUND, ISSUE_CARD, TAX_REFUND, BILLPAY_SADAD, ACH_OUT, ACH_PULL, WIRE_OUT, DISBURSEMENT, KYC_TRANSACTION, GL_TRANSFER, WIRE_DD, ACH_RETURN, RTP_OUT, RTP_REVERSAL, RTP_IN, ICS_DEPOSIT, RTP_RFR_OUT, RTP_RFR_IN, FEDNOW_RFP_OUT, FEDNOW_RFR_OUT Sample Value : "FEE"
ReferenceID	String Unique reference ID of the transaction Sample Value : "XXXSB00000000000236"
timeStamp	String Date and time of transaction initiation Sample Value : "2021-02-16T07:44:55-05:00"
instructedAmount	Object
amount	Number Amount of the transaction Sample Value : 100
currency	String Currency used for transaction Sample Value : "USD"
availableBalance	Object
amount	String Actual Balance available for the Customer to transact Sample Value : 9000
currency	String Currency Sample Value : "USD"
holdBalance	Object
amount	String Sum of Hold Amount Sample Value : 900
currency	String Currency Sample Value : "USD"
ledgerBalance	Object
amount	String Sum total of Available Balance and Hold Balance Sample Value : 9900
currency	String Currency Sample Value : "USD"
debtorAccount	Object
accountNumber	String Account Number of the debtor Sample Value : "200654772393698"
party	Object Debtor party information
name	String Name of the debtor Sample Value : "EnableForAllAccount Test"
address	Object Address of the debtor
line1	String Address line 1 Sample Value : "test"
city	String City Sample Value : "New York"
state	String State Sample Value : "NY"
country	String Country code (ISO 2-letter) Sample Value : "US"
zipCode	String Postal code Sample Value : "98786"
institutionId	String ID of the debtor's institution Sample Value : "101115399"
institutionName	String Name of the debtor's institution Sample Value : "FINWISE BANK"
customerName	String Full name of the debtor Sample Value : "Sam DIAZ"
customerID	String Unique ID of the debtor Sample Value : "100000000000137"
nickName	String Nickname for the account, if set Sample Value : "JD"
creditorAccount	Object
accountNumber	String Account Number of the creditor Sample Value : "200654772393698"
party	Object Creditor party information
name	String Name of the creditor Sample Value : "Obsten"
address	Object Address of the creditor
line1	String Address line 1 Sample Value : "98 ivory coast"
city	String City Sample Value : "Seattle"
country	String Country code (ISO 2-letter) Sample Value : "US"
zipCode	String Postal code Sample Value : "6S4025"
institutionId	String ID of the creditor's institution Sample Value : "111900659"
institutionName	String Name of the creditor's institution Sample Value : "WELLS FARGO BANK"
processID	String Unique process ID for tracking Sample Value : "PL21052500000172"
mode	Enum Mode of transfer Valid values: PG, ACH, QRCODE, EFT, TELLER, BENEFIT, CHEQUE Sample Value : "PG"
status	Enum Status of the transaction Valid values: COMPLETED, PENDING, FAILED, DECLINED, REJECTED Sample Value : "COMPLETED"
customerID	String Unique ID of the creditor customer Sample Value : "100000000000137"
transactionID	String Unique transaction identification number Sample Value : "2589"
credit	Boolean Indicates if the transaction is a credit Sample Value : true
autoFileProcess	Boolean Flag indicating whether the transaction is processed through auto file upload
tokenAppFileUpload	Boolean Indicates whether the transaction is part of a tokenized app file upload
reason	String Reason or description associated with the transaction Sample value – "Test"
transactionNumber	String reference number for the transaction Sample value – "QA00000003106003"

{
   "id": "1",
   "result": {
       "totalDocs": 45,
       "accountTransactions": [
           {
               "type": "RTP_OUT",
               "ReferenceID": "1748855871498",
               "timeStamp": "2025-06-02T09:17:51Z",
               "instructedAmount": {
                   "amount": 100,
                   "currency": "USD"
               },
               "availableBalance": {
                   "amount": 0,
                   "currency": "USD"
               },
               "holdBalance": {
                   "amount": 0,
                   "currency": "USD"
               },
               "ledgerBalance": {
                   "amount": 0,
                   "currency": "USD"
               },
               "debtorAccount": {
                   "accountNumber": "200686362505215",
                   "party": {
                       "name": "EnableForAllAccount Test",
                       "address": {
                           "line1": "test",
                           "city": "New York",
                           "state": "NY",
                           "country": "US",
                           "zipCode": "98786"
                       }
                   },
                   "institutionId": "101115399",
                   "institutionName": "FINWISE BANK",
                   "customerName": "EnableForAllAccount Test",
                   "customerID": "100000000045001",
                   "nickName": "JD"
               },
               "creditorAccount": {
                   "accountNumber": "4567368350259",
                   "party": {
                       "name": "Obsten",
                       "address": {
                           "line1": "98 ivory coast",
                           "city": "Seattle",
                           "country": "US",
                           "zipCode": "6S4025"
                       }
                   },
                   "institutionId": "111900659",
                   "institutionName": "WELLS FARGO BANK"
               },
               "processID": "20250602144751000CBPL25060203016001",
               "mode": "UI",
               "status": "PENDING",
               "customerID": "100000000045001",
               "transactionID": "19910109",
               "purpose": "Dev testing",
               "credit": false,
               "autoFileProcess": false,
               "tokenAppFileUpload": false,
               "reason": "Test",
               "transactionNumber": "QA00000003107001"
           },
           {
               "type": "RTP_OUT",
               "ReferenceID": "1748855762647",
               "timeStamp": "2025-06-02T09:16:02Z",
               "instructedAmount": {
                   "amount": 100,
                   "currency": "USD"
               },
               "availableBalance": {
                   "amount": 0,
                   "currency": "USD"
               },
               "holdBalance": {
                   "amount": 0,
                   "currency": "USD"
               },
               "ledgerBalance": {
                   "amount": 0,
                   "currency": "USD"
               },
               "debtorAccount": {
                   "accountNumber": "200686362505215",
                   "party": {
                       "name": "EnableForAllAccount Test",
                       "address": {
                           "line1": "test",
                           "city": "New York",
                           "state": "NY",
                           "country": "US",
                           "zipCode": "98786"
                       }
                   },
                   "institutionId": "101115399",
                   "institutionName": "NETXD BANK",
                   "customerName": "EnableForAllAccount Test",
                   "customerID": "100000000045001",
                   "nickName": "JD"
               },
               "creditorAccount": {
                   "accountNumber": "4567368350259",
                   "party": {
                       "name": "Obsten",
                       "address": {
                           "line1": "98 ivory coast",
                           "city": "Seattle",
                           "country": "US",
                           "zipCode": "6S4025"
                       }
                   },
                   "institutionId": "111900659",
                   "institutionName": "WELLS FARGO BANK"
               },
               "processID": "20250602144602000CBPL25060203015003",
               "mode": "UI",
               "status": "PENDING",
               "customerID": "100000000045001",
               "transactionID": "19908111",
               "credit": false,
               "autoFileProcess": false,
               "tokenAppFileUpload": false,
               "reason": "Test",
               "transactionNumber": "QA00000003106003"
           },
       ]
   },
   "jsonrpc": "2.0"
}

List Transaction by Account

Method: POST​

Example​

Body​

Response: 200​

Method: POST

Example

Body

Response: 200