Get CreditCard Transaction Details
Fetch Credit Card Transactions
This endpoint retrieves a list of credit card transactions associated with a user’s account. It returns detailed information about each transaction, including cardholder details and transaction amounts.
Request
-
Method: GET
-
Endpoint:
{{host}}/apis/external/creditCards/transactions/fetch
Response
-
Status: 200 OK
-
Content-Type: application/json
Example Response
Response Fields
-
creditCardTxnList: An array of credit card transaction objects.
-
id: Unique identifier for the transaction.
-
txnNumber: The transaction number.
-
cardHolder: Object containing details about the cardholder.
-
id: Unique identifier for the cardholder.
-
code: Code associated with the cardholder.
-
name: Name of the cardholder.
-
email: Email of the cardholder.
-
departmentId: Department identifier.
-
officeId: Office identifier.
-
-
creditCard: Object containing details about the credit card.
-
id: Unique identifier for the credit card.
-
cardNumber: The credit card number.
-
cardReference: Reference for the credit card.
-
-
date: Date of the transaction.
-
expenseNature: Nature of the expense.
-
baseCurrency: Currency used for the transaction.
-
foreignCurrency: Currency used for foreign transactions.
-
amount: Amount of the transaction in base currency.
-
parentAmount: Parent amount related to the transaction.
-
foreignAmount: Amount of the transaction in foreign currency.
-
transactionStatus: Status of the transaction.
-
data: Additional data related to the transaction.
-
narration: Description of the transaction.
-
splitCount: Number of splits for the transaction.
-
resubmitCount: Number of times the transaction has been resubmitted.
-
merchantName: Name of the merchant.
-
merchantCategory: Category of the merchant.
-
originalTxn: Indicates if this is the original transaction.
-
foreignBalanceAmount: Balance amount in foreign currency.
-
-
-
total: Total number of transactions retrieved.
-
currentPage: Current page number of the results.
-
totalPages: Total number of pages of results.
This endpoint retrieves a list of credit card transactions associated with a user’s account. It is designed to provide detailed information about each transaction, including the cardholder’s details, transaction amounts, and status.
Request
-
Method: GET
-
Endpoint:
{{host}}/apis/external/creditCards/transactions/fetch
Response
On a successful request, the API returns a JSON object with the following structure:
-
creditCardTxnList: An array of transaction objects, each containing:
-
id: Unique identifier for the transaction.
-
txnNumber: The transaction number.
-
cardHolder: An object containing details about the cardholder:
-
id: Unique identifier for the cardholder.
-
code: Code associated with the cardholder.
-
name: Name of the cardholder.
-
email: Email address of the cardholder.
-
departmentId: Identifier for the department.
-
officeId: Identifier for the office.
-
-
creditCard: An object with details about the credit card:
-
id: Unique identifier for the credit card.
-
cardNumber: The card number.
-
cardReference: Reference for the card.
-
-
date: Date of the transaction.
-
expenseNature: Nature of the expense.
-
baseCurrency: Currency used for the transaction.
-
foreignCurrency: Currency for any foreign transactions.
-
amount: Amount in the base currency.
-
parentAmount: Amount related to the parent transaction.
-
foreignAmount: Amount in foreign currency.
-
transactionStatus: Status of the transaction.
-
data: Additional details about the transaction:
-
narration: Description of the transaction.
-
splitCount: Number of splits for the transaction.
-
resubmitCount: Number of times the transaction has been resubmitted.
-
merchantName: Name of the merchant.
-
merchantCategory: Category of the merchant.
-
originalTxn: Boolean indicating if this is the original transaction.
-
foreignBalanceAmount: Balance amount in foreign currency.
-
-
-
total: Total number of transactions returned.
-
currentPage: Current page number of results.
-
totalPages: Total number of pages available.
Notes
-
Ensure proper authentication is in place to access this endpoint.
-
The response will include an empty list if there are no transactions available for the user.
