List all transaction in buckets

Retrieve a list of all transaction buckets with optional filtering.

GET /api/bucketcontent

List all transaction in buckets

cURL

curl --request GET \
  --url http://localhost/api/api/bucketcontent \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://localhost/api/api/bucketcontent"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost/api/api/bucketcontent', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://localhost/api/api/bucketcontent",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "http://localhost/api/api/bucketcontent"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://localhost/api/api/bucketcontent")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost/api/api/bucketcontent")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "count": 123,
  "results": [
    {
      "bucket": {
        "id": 123,
        "name": "<string>"
      },
      "client_transaction_id": "<string>",
      "transaction_type": "<string>",
      "cp_a": {
        "client_subject_id": "<string>",
        "subject_name": "<string>",
        "unique_identification_number": "<string>",
        "account_holder": true,
        "address": "<string>",
        "customer_segment": "<string>",
        "date_and_place_of_birth": "<string>",
        "country_of_birth_or_incorporation": "<string>",
        "nationality": "<string>",
        "account_type": "<string>",
        "account_type_ii": "<string>",
        "account_opening_date": "<string>",
        "account_opening_date_ii": "<string>",
        "customer_aml_risk_rating": "<string>",
        "customer_account": "<string>",
        "customer_account_ii": "<string>",
        "customer_opening_date": "<string>",
        "source_of_funds": "<string>",
        "average_monthly_income": "<string>",
        "cif_status": "<string>",
        "occupation": "<string>",
        "industry": "<string>",
        "purpose_of_account": "<string>",
        "contact_number": "<string>",
        "email_address": "<string>",
        "risk_assessment_score": "<string>",
        "created_by": 123,
        "modified_by": 123
      },
      "cp_a_country": "<string>",
      "cp_a_bank": "<string>",
      "cp_b": {
        "client_subject_id": "<string>",
        "subject_name": "<string>",
        "unique_identification_number": "<string>",
        "account_holder": true,
        "address": "<string>",
        "customer_segment": "<string>",
        "date_and_place_of_birth": "<string>",
        "country_of_birth_or_incorporation": "<string>",
        "nationality": "<string>",
        "account_type": "<string>",
        "account_type_ii": "<string>",
        "account_opening_date": "<string>",
        "account_opening_date_ii": "<string>",
        "customer_aml_risk_rating": "<string>",
        "customer_account": "<string>",
        "customer_account_ii": "<string>",
        "customer_opening_date": "<string>",
        "source_of_funds": "<string>",
        "average_monthly_income": "<string>",
        "cif_status": "<string>",
        "occupation": "<string>",
        "industry": "<string>",
        "purpose_of_account": "<string>",
        "contact_number": "<string>",
        "email_address": "<string>",
        "risk_assessment_score": "<string>",
        "created_by": 123,
        "modified_by": 123
      },
      "cp_b_country": "<string>",
      "cp_b_bank": "<string>",
      "transaction_timestamp": "2023-11-07T05:31:56Z",
      "transaction_currency": {
        "currency": "<string>",
        "alphabetic_code": "<string>",
        "active_indicator": true,
        "numeric_code": "<string>"
      },
      "amount": 123,
      "alt_currency": {
        "currency": "<string>",
        "alphabetic_code": "<string>",
        "active_indicator": true,
        "numeric_code": "<string>"
      },
      "amount_in_alt_currency": 123,
      "payment_mode": "<string>",
      "purpose_of_transfer": "<string>",
      "notes": "<string>",
      "created_by": 123,
      "modified_by": 123
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

CustomAuthenticationcookieAuth

Authorization · string · header · required

JWT token obtained from AWS Cognito or custom authentication service

Query Parameters

bucket_id · integer

Filter by bucket ID

client_transaction_id · string

Filter by client transaction ID

limit · integer

Number of results to return per page.

max_date · string

Filter by maximum transaction timestamp

min_date · string

Filter by minimum transaction timestamp

offset · integer

The initial index from which to return the results.

Response

200 - application/json

count · integer · required

Example:

123

results · object[] · required

Show child attributes

next · string<uri> | null

Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous · string<uri> | null

Example:

"http://api.example.org/accounts/?offset=200&limit=100"