Skip to main content
GET
/
api
/
transactions
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 123,
      "bucket_loading_status": "Transaction loaded into [ORDINARY] and requested buckets",
      "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_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
      },
      "transaction_currency": {
        "currency": "<string>",
        "alphabetic_code": "<string>",
        "numeric_code": "<string>",
        "active_indicator": true
      },
      "alt_currency": {
        "currency": "<string>",
        "alphabetic_code": "<string>",
        "numeric_code": "<string>",
        "active_indicator": true
      },
      "modified_by": {
        "id": 123
      },
      "created_by": {
        "id": 123
      },
      "client_transaction_id": "<string>",
      "transaction_type": "<string>",
      "cp_a_country": "<string>",
      "cp_b_country": "<string>",
      "transaction_timestamp": "2023-11-07T05:31:56Z",
      "amount": 123,
      "cp_a_bank": "<string>",
      "cp_b_bank": "<string>",
      "amount_in_alt_currency": 123,
      "payment_mode": "<string>",
      "purpose_of_transfer": "<string>",
      "notes": "<string>"
    }
  ]
}
By calling this API, you will be able to retrieve all the transitions that were uploaded into Athena. If there are more than 10 transactions available, the records provided in the response will be paginated by 10 transactions per page.

Authorizations

Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Query Parameters

client_subject_id
string
client_transaction_id
string
country
string
limit
integer

Number of results to return per page.

max_date
string<date-time>
min_date
string<date-time>
offset
integer

The initial index from which to return the results.

transaction_type
string

Response

200 - application/json
count
integer
required
Example:

123

results
object[]
required
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"