Overview

There are two types of audits that can be performed to find a particular transaction. These are:

Search Account Transaction by Currency and Date.
Search Account Deposits.

1. Search Account Transaction by Currency and Date

To find transactions made in a particular currency for a given date:

Call POST - Search Account Transactions.

In the request below, a search for transactions is carried out for the month of September:

REQUEST

curl --location 'https://caxapi-integration.azurewebsites.net/api/account/transactions/search' \
--header 'Content-Type: application/json' \
--header 'authorization: Bearer <access_token>' \
--header 'userapitoken: <userapitoken>' \
--data '{
  "StartDate": "2023-09-01T01:48:43.934Z",
  "EndDate": "2023-09-30T12:48:43.934Z",
  "Currency": "GBP"
}'

RESPONSE

A successful response is shown below:

{
    "Content": {
        "Model": {
            "AccountTransaction": [
                {
                    "Id": 636767,
                    "TransactionDateTime": "2023-09-25T14:18:17.5179104",
                    "Amount": -100.00,
                    "AccountSummaryId": 186971,
                    "Status": "Debit for Currency Balance Transfer",
                    "TotalBalance": 8900.00,
                    "Currency": "GBP",
                    "BaseCurrency": "GBP",
                    "IsValid": true,
                    "ApiStatusCode": 100,
                    "ApiStatus": "IsValid",
                    "ApiStatusDescription": "Valid Operation"
                },
                {
                    "Id": 633316,
                    "TransactionDateTime": "2023-09-06T14:47:05.492575",
                    "Amount": -20.00,
                    "AccountSummaryId": 186971,
                    "Status": "Debit for trade id :280766",
                    "TotalBalance": 0.00,
                    "Currency": "GBP",
                    "BaseCurrency": "GBP",
                    "IsValid": true,
                    "ApiStatusCode": 100,
                    "ApiStatus": "IsValid",
                    "ApiStatusDescription": "Valid Operation"
                },
                {
                    "Id": 632107,
                    "TransactionDateTime": "2023-09-04T15:55:06.9099669",
                    "Amount": 10.00,
                    "AccountSummaryId": 186971,
                    "Status": "Currency deposited",
                    "TotalBalance": 10.00,
                    "Currency": "GBP",
                    "BaseCurrency": "GBP",
                    "IsValid": true,
                    "ApiStatusCode": 100,
                    "ApiStatus": "IsValid",
                    "ApiStatusDescription": "Valid Operation"
                }
    }
}

2. Search Account Deposits

To generate an audit for all deposits within a specific timeframe:

Call POST - Search Account Deposits.

In the request below, a search for deposits is made for the month of September:

REQUEST

curl --location 'https://caxapi-integration.azurewebsites.net/api/account/transactions/deposits' \
--header 'Content-Type: application/json' \
--header 'authorization: Bearer <access_token>' \
--header 'userapitoken: <userapitoken>' \
--data '{
  "StartDate": "2023-09-01",
  "EndDate": "2023-09-30",
  "Currency": "GBP"
}'

RESPONSE

{
    "Content": {
        "Model": {
            "AccountTransaction": [
                {
                    "UserId": "<userid>",
                    "Sender": null,
                    "Narrative": {
                        "Narrative1": "",
                        "Narrative2": "",
                        "Narrative3": "",
                        "Narrative4": "",
                        "Narrative5": ""
                    },
                    "Reference": null,
                    "AccountTransactionId": 637695,
                    "DepositDate": "2023-09-29T10:53:06.7153145",
                    "Currency": "GBP",
                    "Amount": 100.00,
                    "Status": "Currency deposited",
                    "ExternalSource": "RBS",
                    "IsValid": true,
                    "ApiStatusCode": 100,
                    "ApiStatus": "IsValid",
                    "ApiStatusDescription": "Valid Operation"
                }
            ],
            "Result": {
                "Result": [
                    {
                        "UserId": "<userid>",
                        "Sender": null,
                        "Narrative": {
                            "Narrative1": "",
                            "Narrative2": "",
                            "Narrative3": "",
                            "Narrative4": "",
                            "Narrative5": ""
                        },
                        "Reference": null,
                        "AccountTransactionId": 637695,
                        "DepositDate": "2023-09-29T10:53:06.7153145",
                        "Currency": "GBP",
                        "Amount": 100.00,
                        "Status": "Currency deposited",
                        "ExternalSource": "RBS",
                        "IsValid": true,
                        "ApiStatusCode": 100,
                        "ApiStatus": "IsValid",
                        "ApiStatusDescription": "Valid Operation"
                    }
                ],
                "ApiStatusCode": 100,
                "ApiStatus": "IsValid",
                "ApiStatusDescription": "Valid Operation"
            },
            "ApiStatusCode": 100,
            "ApiStatus": "IsValid",
            "ApiStatusDescription": "Valid Operation"
        },
        "ExpectedResponses": [
            "IsValid"
        ]
    },
    "AuthorisedClientModel": {
        "ClientId": "<clientid>",
        "ClientRef": "<clientref>",
        "ApiStatusCode": 100,
        "ApiStatus": "IsValid",
        "ApiStatusDescription": "Valid Operation"
    },
    "AuthorisedUserModel": {
        "UserId": "<userid>",
        "AppVersion": null,
        "TokenStartDate": "2023-12-01T00:00:00",
        "TokenEndDate": "2023-12-31T00:00:00",
        "LoginTimestamp": "2023-12-01T14:28:43.0330362",
        "ApiLoginType": 0,
        "ApiStatusCode": 100,
        "ApiStatus": "IsValid",
        "ApiStatusDescription": "Valid Operation"
    }
}

Status Codes

Status Name	Type	Description
Currency deposited XXX	Deposits/Funds In
Debit for trade id :{{Tradeid}} XXX	Trade funding
Debit for trade fee {{Tradeid}} FEE-XXX	Trade Fee taken
Debit for payaway IP-XXX	Payout	'XXX' represents the TransferId assigned when the transaction is processed.
Currency Balance Credit Pot/ccy	Movement of Funds	Funds credited to main balance and/or pots.
Currency Balance Debit pot/ccy	Movement of Funds	Funds debited from main balance and/or pots.
Debit for Currency Balance Transfer	Funds Transfer
Credit for Currency Balance Transfer	Funds Transfer