Transactions and Statements

Below are the action codes to manage transactions and statements.

FETCH_ALL_TRANSACTIONS

Use this action code to fetch transactions. To fetch billed transactions, send the statementReferenceNumber parameter in the request. Without the statementReferenceNumberIt will return all the transactions starting from the unbilled ones.

{
  'accountId': 'replace_with_account_id',
  'userId': 'a5a1c639-52ca-4146-a8e4-92fdabe304af',
  'statementReferenceNumber': 'replace_with_statement_ref'
}

{
  "accountId": "12315611010000000",
  "transactionDetails": {
    "transactionId": "11921315190000050",
    "transactionDate": "2021-11-21 00:38:11",
    "transactionType": "Spend",
    "transactionStatus": "Authorised",
    "cardId": "28598783-cba0-47e0-bdd6-9ab5368fa1d8",
    "merchantName": "Amazon India",
    "channel": "ECOM",
    "mcc": "01201",
    "mid": "201567",
    "externalReferenceId": "e6ef5e95-2bab-4ec2-a7cc-4d2bbd9840ab",
    "totalAmount": 570,
    "transactionAmount": 570,
    "transactionFee": 15,
    "transactionTax": 5,
    "narration": "Burberry cuffs"
  }
}

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`accountId`	string	Mandatory	The unique identifier of an account.
`userId`	string	Mandatory	The unique identifier of a user.
`statementReferenceNumber`	string	Mandatory	The statement reference number.

Response Parameters

Parameters	Data Type	Description
`accountId`	string	The unique identifier of the account.
`transactionDetails`	object	The transaction details.
`transactionDetails[].transactionId`	string	The transaction ID.
`transactionDetails[].transactionDate`	string	The transaction date.
`transactionDetails[].transactionType`	string	The transaction type.
`transactionDetails[].transactionStatus`	string	The transaction status.
`transactionDetails[].cardId`	string	The card ID.
`transactionDetails[].merchantName`	string	The merchant's name.
`transactionDetails[].channel`	string	The transaction channel.
`transactionDetails[].mcc`	string	The merchant category code.
`transactionDetails[].mid`	string	The merchant's MID.
`transactionDetails[].externalReferenceId`	string	The external reference ID.
`transactionDetails[].totalAmount`	string	The total amount.
`transactionDetails[].transactionAmount`	string	The transaction amount.
`transactionDetails[].transactionFee`	string	The transaction fee.
`transactionDetails[].transactionTax`	string	The transaction tax.
`transactionDetails[].narration`	string	The transaction narration.

FETCH_BILLED_TRANSACTIONS

Use this action code to fetch billed transactions of an account.

{
  'statementId': 'STAT1222'
}

{
  "statementId":"12315611010000000",
  "accountId":"12315611010000000",
  "outstandingAmount":"12315611010000000",
  "minimumAmountDue":"12315611010000000",
  "totalAmountDue":"12315611010000000",
  "statementStartDate":"12315611010000000",
  "statementEndDate":"12315611010000000",
  "dueDate":"12315611010000000",
  "transactionList":[
    {
      "transactionId":"11921315190000050",
      "transactionDate":"2021-11-21 00:38:11",
      "transactionType":"Spend",
      "transactionStatus":"Authorised",
      "cardId":"28598783-cba0-47e0-bdd6-9ab5368fa1d8",
      "merchantName":"Amazon India",
      "channel":"ECOM",
      "mcc":"01201",
      "mid":"201567",
      "externalReferenceId":"e6ef5e95-2bab-4ec2-a7cc-4d2bbd9840ab",
      "totalAmount":570,
      "transactionAmount":570,
      "transactionFee":15,
      "transactionTax":5,
      "narration":"Burberry cuffs"
    }
  ],
  "total_count":1
}

Request Parameters

Header	Data Type	Mandatory/Optional	Description
`statementId`	string	Mandatory	The unique identifier of a statement.

Response Parameters

Parameters	Data Type	Description
`statementId`	string	The unique identifier of the statement.
`accountId`	string	The unique identifier of the account.
`outstandingAmount`	string	The outstanding amount.
`minimumAmountDue`	string	The minimum amount due.
`totalAmountDue`	string	The total amount due.
`statementStartDate`	string	The statement start date.
`statementEndDate`	string	The statement end date.
`dueDate`	string	The due date.
`transactionDetails`	object	The transaction details.
`transactionDetails[].transactionId`	string	The transaction ID.
`transactionDetails[].transactionDate`	string	The transaction date.
`transactionDetails[].transactionType`	string	The transaction type.
`transactionDetails[].transactionStatus`	string	The transaction status.
`transactionDetails[].cardId`	string	The card ID.
`transactionDetails[].merchantName`	string	The merchant's name.
`transactionDetails[].channel`	string	The transaction channel.
`transactionDetails[].mcc`	string	The merchant category code.
`transactionDetails[].mid`	string	The merchant's MID.
`transactionDetails[].externalReferenceId`	string	The external reference ID.
`transactionDetails[].totalAmount`	string	The total amount.
`transactionDetails[].transactionAmount`	string	The transaction amount.
`transactionDetails[].transactionFee`	string	The transaction fee.
`transactionDetails[].transactionTax`	string	The transaction tax.
`transactionDetails[].narration`	string	The transaction narration.

FETCH_STATEMENTS

Use this action code to fetch a month’s credit card statement.

{
  'accountId': '{accountId}',
  'UserId': 'a5a1c639-52ca-4146-a8e4-92fdabe304af'
}

{
  "openingbalance":1000,
  "closingbalance":10000,
  "statementdate":"2022-11-21 00:00:00",
  "duedate":"2022-12-11 00:00:00",
  "creditlimit":100000,
  "availablecredit":90000,
  "pastdueamount":0,
  "purchases":9000,
  "interest":0,
  "fees":0,
  "openingdate":"2022-11-21 00:00:00",
  "closingdate":"2022-11-21 00:00:00",
  "createdtime":"2022-11-21 01:10:55",
  "transactions_array":[
    {
      "transactions_array":500,
      "transactiontype_array":"Dr",
      "transactiondescription_array":"Zomato"
    }
  ]
}

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`accountId`	string	Mandatory	The unique identifier of an account.
`UserId`	string	Mandatory	The unique identifier of an account.

Response Parameters

Parameters	Data Type	Description
`openingbalance`	string	The opening balance.
`closingbalance`	string	The closing balance.
`statementdate`	string	The statement date.
`statementdate`	string	The statement date.
`dueDate`	string	The due date.
`creditlimit`	object	The credit limit.
`availablecredit`	string	The available credit.
`pastdueamount`	string	The past due amount.
`purchases`	string	The purchases.
`interest`	string	The interest.
`fees`	string	The fees.
`openingdate`	string	The opening date.
`closingdate`	string	The closing date.
`createdtime`	string	The statement creation time.
`transactions_array`	object	The transaction array details.
`transactions_array[].transactions_array`	string	The transaction array.
`transactions_array[].transactiontype_array`	string	The transaction type.
`transactions_array[].transactiondescription_array`	string	The transaction description.

↑