Below are the action codes to manage transactions and statements.
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.
Payload Response
{
'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"
}
}
Parameters Data Type Mandatory/Optional Description accountIdstring Mandatory The unique identifier of an account. userIdstring Mandatory The unique identifier of a user. statementReferenceNumberstring Mandatory The statement reference number.
Parameters Data Type Description accountIdstring The unique identifier of the account. transactionDetailsobject The transaction details. transactionDetails[].transactionIdstring The transaction ID. transactionDetails[].transactionDatestring The transaction date. transactionDetails[].transactionTypestring The transaction type. transactionDetails[].transactionStatusstring The transaction status. transactionDetails[].cardIdstring The card ID. transactionDetails[].merchantNamestring The merchant's name. transactionDetails[].channelstring The transaction channel. transactionDetails[].mccstring The merchant category code. transactionDetails[].midstring The merchant's MID. transactionDetails[].externalReferenceIdstring The external reference ID. transactionDetails[].totalAmountstring The total amount. transactionDetails[].transactionAmountstring The transaction amount. transactionDetails[].transactionFeestring The transaction fee. transactionDetails[].transactionTaxstring The transaction tax. transactionDetails[].narrationstring The transaction narration.
Use this action code to fetch billed transactions of an account.
Payload Response
{
'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
}
Header Data Type Mandatory/Optional Description statementIdstring Mandatory The unique identifier of a statement.
Parameters Data Type Description statementIdstring The unique identifier of the statement. accountIdstring The unique identifier of the account. outstandingAmountstring The outstanding amount. minimumAmountDuestring The minimum amount due. totalAmountDuestring The total amount due. statementStartDatestring The statement start date. statementEndDatestring The statement end date. dueDatestring The due date. transactionDetailsobject The transaction details. transactionDetails[].transactionIdstring The transaction ID. transactionDetails[].transactionDatestring The transaction date. transactionDetails[].transactionTypestring The transaction type. transactionDetails[].transactionStatusstring The transaction status. transactionDetails[].cardIdstring The card ID. transactionDetails[].merchantNamestring The merchant's name. transactionDetails[].channelstring The transaction channel. transactionDetails[].mccstring The merchant category code. transactionDetails[].midstring The merchant's MID. transactionDetails[].externalReferenceIdstring The external reference ID. transactionDetails[].totalAmountstring The total amount. transactionDetails[].transactionAmountstring The transaction amount. transactionDetails[].transactionFeestring The transaction fee. transactionDetails[].transactionTaxstring The transaction tax. transactionDetails[].narrationstring The transaction narration.
Use this action code to fetch a month’s credit card statement.
Payload Response
{
'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"
}
]
}
Parameters Data Type Mandatory/Optional Description accountIdstring Mandatory The unique identifier of an account. UserIdstring Mandatory The unique identifier of an account.
Parameters Data Type Description openingbalancestring The opening balance. closingbalancestring The closing balance. statementdatestring The statement date. statementdatestring The statement date. dueDatestring The due date. creditlimitobject The credit limit. availablecreditstring The available credit. pastdueamountstring The past due amount. purchasesstring The purchases. intereststring The interest. feesstring The fees. openingdatestring The opening date. closingdatestring The closing date. createdtimestring The statement creation time. transactions_arrayobject The transaction array details. transactions_array[].transactions_arraystring The transaction array. transactions_array[].transactiontype_arraystring The transaction type. transactions_array[].transactiondescription_arraystring The transaction description.
