Skip to main content
POST
/
api
/
transactions
Create a transaction
curl --request POST \
  --url http://localhost/api/api/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "transaction_currency_id": "<string>",
  "client_transaction_id": "<string>",
  "transaction_type": "<string>",
  "transaction_timestamp": "2023-11-07T05:31:56Z",
  "amount": 123,
  "populate_buckets": [],
  "cp_a_id": "<string>",
  "cp_b_id": "<string>",
  "alt_currency_id": "<string>",
  "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>"
}
'
{
  "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>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cynopsis.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Body

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

​
transaction_currency_id
string
required
write-only
Minimum string length: 1
​
client_transaction_id
string
required
Required string length: 1 - 255
​
transaction_type
string
required
Required string length: 1 - 255
​
transaction_timestamp
string<date-time>
required
​
amount
number<double>
required
​
populate_buckets
string[]
write-only
Minimum string length: 1
​
cp_a_id
string
write-only
Minimum string length: 1
​
cp_b_id
string
write-only
Minimum string length: 1
​
alt_currency_id
string
write-only
Minimum string length: 1
​
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

Response

201 - 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
​
cp_b
object
required
​
transaction_currency
object
required
​
alt_currency
object
required
​
modified_by
object
required
​
created_by
object
required
​
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