Retrieve a specific transaction

Override the method to optimise query used, while using only necessary Django/DRF’s implementation of [get_object_or_404()]

GET /api/transactions/{id}

Retrieve a specific transaction

cURL

curl --request GET \
  --url http://localhost/api/api/transactions/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "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>",
    "active_indicator": true,
    "numeric_code": "<string>"
  },
  "alt_currency": {
    "currency": "<string>",
    "alphabetic_code": "<string>",
    "active_indicator": true,
    "numeric_code": "<string>"
  },
  "modified_by": {
    "id": 123
  },
  "created_by": {
    "id": 123
  },
  "client_transaction_id": "<string>",
  "transaction_type": "<string>",
  "transaction_timestamp": "2023-11-07T05:31:56Z",
  "amount": 123,
  "cp_a_country": "<string>",
  "cp_b_country": "<string>",
  "cp_a_bank": "<string>",
  "cp_b_bank": "<string>",
  "amount_in_alt_currency": 123,
  "payment_mode": "<string>",
  "purpose_of_transfer": "<string>",
  "notes": "<string>"
}

Authorizations

CustomAuthenticationcookieAuth

Authorization · string · header · required

JWT token obtained from AWS Cognito or custom authentication service

Path Parameters

id · integer · required

A unique integer value identifying this transaction.

Response

200 - application/json

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

id · integer · required · read-only

bucket_loading_status · string · default: Transaction loaded into [ORDINARY] and requested buckets · required · read-only

cp_a · object · required

Show child attributes

cp_b · object · required

Show child attributes

transaction_currency · object · required

Show child attributes

alt_currency · object · required

Show child attributes

modified_by · object · required

Show child attributes

created_by · object · required

Show child attributes

client_transaction_id · string · required

Maximum string length: 255

transaction_type · string · required

Maximum string length: 255

transaction_timestamp · string<date-time> · required

amount · number<double> · required

cp_a_country · string

Maximum string length: 60

cp_b_country · string

Maximum string length: 60

cp_a_bank · string

Maximum string length: 255

cp_b_bank · string

Maximum string length: 255

amount_in_alt_currency · number<double> | null

payment_mode · string

Maximum string length: 255

purpose_of_transfer · string

Maximum string length: 255

notes · string

Maximum string length: 255