Skip to navigation

Get CreditCard Transaction Details

View as Markdown

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

{
"creditCardTxnList": [
{
"id": 5882293,
"txnNumber": "74518996107001298206632",
"cardHolder": {
"id": 841676,
"code": "E0001",
"name": "karanas shrma",
"email": "testuser1@yopmail.com",
"departmentId": 38362,
"officeId": 74549
},
"creditCard": {
"id": 5880154,
"cardNumber": "XXXXXXXXXXXX0003",
"cardReference": "Credit Card from Visa feed"
},
"date": "Apr 16, 2006 6:30:00 PM",
"expenseNature": "CREDIT",
"baseCurrency": "INR",
"foreignCurrency": "INR",
"amount": 348.0,
"parentAmount": 348.0,
"foreignAmount": 348.0,
"transactionStatus": "PENDING",
"data": {
"narration": "Service Stations ( with or without ancillary services)",
"splitCount": 0,
"resubmitCount": 0,
"merchantName": "GAS STATION",
"merchantCategory": "5541",
"originalTxn": true,
"foreignBalanceAmount": 0.0
}
},
{
"id": 5882294,
"txnNumber": "abcd car",
"cardHolder": {
"id": 841676,
"code": "E0001",
"name": "karanas shrma",
"email": "testuser1@yopmail.com",
"departmentId": 38362,
"officeId": 74549
},
"creditCard": {
"id": 5880155,
"cardNumber": "HDFCMF5555871111",
"cardReference": "HDFCMF5555871111"
},
"date": "Feb 17, 2025 10:31:40 AM",
"expenseNature": "CREDIT",
"baseCurrency": "USD",
"foreignCurrency": "USD",
"amount": 100.0,
"parentAmount": 100.0,
"foreignAmount": 100.0,
"transactionStatus": "PENDING",
"data": {
"narration": "",
"splitCount": 0,
"resubmitCount": 0,
"merchantName": "abcd car",
"merchantCategory": "SHRUTI",
"originalTxn": true,
"foreignBalanceAmount": 0.0
}
},
{
"id": 5882295,
"txnNumber": "abcd",
"cardHolder": {
"id": 841676,
"code": "E0001",
"name": "karanas shrma",
"email": "testuser1@yopmail.com",
"departmentId": 38362,
"officeId": 74549
},
"creditCard": {
"id": 5880156,
"cardNumber": "HDFCMF5555871111",
"cardReference": "HDFCMF5555871111"
},
"date": "Feb 17, 2025 10:36:40 AM",
"expenseNature": "CREDIT",
"baseCurrency": "USD",
"foreignCurrency": "USD",
"amount": 150.0,
"parentAmount": 150.0,
"foreignAmount": 150.0,
"transactionStatus": "PENDING",
"data": {
"narration": "",
"splitCount": 0,
"resubmitCount": 0,
"merchantName": "abcd",
"merchantCategory": "SHRUTI",
"originalTxn": true,
"foreignBalanceAmount": 0.0
}
},
{
"id": 5882296,
"txnNumber": "abcd",
"cardHolder": {
"id": 841676,
"code": "E0001",
"name": "karanas shrma",
"email": "testuser1@yopmail.com",
"departmentId": 38362,
"officeId": 74549
},
"creditCard": {
"id": 5880155,
"cardNumber": "HDFCMF5555871111",
"cardReference": "HDFCMF5555871111"
},
"date": "Feb 17, 2025 10:41:40 AM",
"expenseNature": "CREDIT",
"baseCurrency": "USD",
"foreignCurrency": "USD",
"amount": 200.0,
"parentAmount": 200.0,
"foreignAmount": 200.0,
"transactionStatus": "PENDING",
"data": {
"narration": "",
"splitCount": 0,
"resubmitCount": 0,
"merchantName": "abcd",
"merchantCategory": "SHRUTI",
"originalTxn": true,
"foreignBalanceAmount": 0.0
}
},
{
"id": 5882297,
"txnNumber": "abcd",
"cardHolder": {
"id": 841676,
"code": "E0001",
"name": "karanas shrma",
"email": "testuser1@yopmail.com",
"departmentId": 38362,
"officeId": 74549
},
"creditCard": {
"id": 5880157,
"cardNumber": "HDFCMF5555875555",
"cardReference": "HDFCMF5555875555"
},
"date": "Feb 17, 2025 10:41:40 AM",
"expenseNature": "CREDIT",
"baseCurrency": "USD",
"foreignCurrency": "USD",
"amount": 100.0,
"parentAmount": 100.0,
"foreignAmount": 100.0,
"transactionStatus": "PENALIZED",
"data": {
"narration": "",
"splitCount": 0,
"resubmitCount": 0,
"merchantName": "abcd",
"merchantCategory": "SHRUTI",
"originalTxn": true,
"foreignBalanceAmount": 0.0
}
},
{
"id": 5882298,
"txnNumber": "abcd ab",
"cardHolder": {
"id": 841676,
"code": "E0001",
"name": "karanas shrma",
"email": "testuser1@yopmail.com",
"departmentId": 38362,
"officeId": 74549
},
"creditCard": {
"id": 5880157,
"cardNumber": "HDFCMF5555875555",
"cardReference": "HDFCMF5555875555"
},
"date": "Feb 17, 2025 10:41:40 AM",
"expenseNature": "CREDIT",
"baseCurrency": "USD",
"foreignCurrency": "USD",
"amount": 150.0,
"parentAmount": 150.0,
"foreignAmount": 150.0,
"transactionStatus": "PENDING",
"data": {
"narration": "",
"splitCount": 0,
"resubmitCount": 0,
"merchantName": "abcd",
"merchantCategory": "SHRUTI",
"originalTxn": true,
"foreignBalanceAmount": 0.0
}
}
],
"total": 0,
"currentPage": 0,
"totalPages": 0
}

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.

Headers

DICE-APP-IDstringOptional
X-CLIENT-IDstringOptional
X-CLIENT-SECRETstringOptional
statusstringOptional

Response

OK