Skip to main content
GET
/
api
/
cases
/
{id}
/
transactions
List transactions for a specific case
curl --request GET \
  --url http://localhost/api/api/cases/{id}/transactions \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "transactions": [
        {
          "id": 123,
          "client_transaction_id": "<string>",
          "transaction_type": "<string>",
          "cp_a": {
            "id": 123,
            "name": "<string>",
            "client_subject_id": "<string>"
          },
          "cp_a_country": "<string>",
          "cp_a_bank": "<string>",
          "cp_b": {
            "id": 123,
            "name": "<string>",
            "client_subject_id": "<string>"
          },
          "cp_b_country": "<string>",
          "cp_b_bank": "<string>",
          "transaction_timestamp": "2023-11-07T05:31:56Z",
          "transaction_currency": {
            "id": 123,
            "code": "<string>",
            "name": "<string>"
          },
          "amount": 123,
          "alt_currency": {
            "id": 123,
            "code": "<string>",
            "name": "<string>"
          },
          "amount_in_alt_currency": 123,
          "payment_mode": "<string>",
          "purpose_of_transfer": "<string>"
        }
      ],
      "transaction_count": 123,
      "next_token": "<string>",
      "prev_token": "<string>"
    }
  ],
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"
}

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.

transaction_id is where the page_direction will begin from
Note: Retrieving Transactions by Case Id API Endpoint uses cursor pagination. The default behaviour returns 10 transactions in a response which can be changed by using argument page_limit, with further transactions stored in offsets. Optional Queries
  • page_limit
  • page_direction
  • transaction_id
page_direction· must conform to one of the following options
  • NEXT
  • PREV

Authorizations

​
Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Path Parameters

​
id
integer
required

Query Parameters

​
cursor
string

Cursor for pagination

​
page_limit
integer

Number of results to return per page.

Response

Transactions retrieved successfully.

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?cursor=cD00ODY%3D\""

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"