# Get Reward Account Details ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/v0/partner/enKashCard/cardAccount/get: post: summary: Get Reward Account Details deprecated: false description: >- :::highlight orange 📌 Fetches detailed information about a user’s reward account, including current balance, reward point status, and account metadata. This API is typically used to display reward summaries in dashboards, mobile apps, or loyalty program interfaces ::: tags: - Rewards & Incentives/APIs - Reward/Reward Allocation parameters: - name: partnerId in: header description: >- A unique ID given to the integration partner of Enkash. Partner id will shared by Enkash required: true example: partnerId schema: type: string - name: Authorization in: header description: Auth Token Generated beforehand required: true example: Bearer xaYGp6Oav3I65OlSTx7SU-Rh1aM schema: type: string - name: Content-Type in: header description: '' required: true example: application/json schema: type: string requestBody: content: application/json: schema: type: object properties: cardAccountId: type: string description: Card Account Id provided after onboarding companyId: type: string description: Company Id at Enkash required: - cardAccountId - companyId x-apidog-orders: - cardAccountId - companyId example: cardAccountId: account_id companyId: company_id responses: '200': description: '' content: application/json: schema: type: object properties: availableBalance: type: number description: Available balance at account for fund allocation faker: '1000' totalCards: type: number faker: '2' description: ' Total card Available at cardAccount include active and blocked card' companyName: type: string description: ' Name of a company ' faker: ' BigBite Enterprise' companyId: type: string description: ' Company identification id (shared by enkash for all corporate) ' faker: CEKCDVT1UV cardAccountId: type: string description: ' Card Account Number (shared by enkash for all corporate) ' faker: CAF0RX8N3 activeCards: type: number description: ' Total Active Card available for cardAccount' faker: '1' totalAllocationPoint: type: number description: ' Total fund allocated from cardAccount to user card' faker: '100' ' totalRedemptionPoint': type: number description: ' Total fund redeemed from By user' faker: '200' currentMonthAllocationPoint: type: number description: ' Current Month allocation point' faker: '100' currentMonthRedemptionPoint: type: number description: Current Month Redemption point faker: '100' x-apidog-orders: - availableBalance - totalCards - companyName - companyId - cardAccountId - activeCards - totalAllocationPoint - ' totalRedemptionPoint' - currentMonthAllocationPoint - currentMonthRedemptionPoint required: - availableBalance - totalCards - companyName - companyId - cardAccountId - activeCards - totalAllocationPoint - ' totalRedemptionPoint' - currentMonthAllocationPoint - currentMonthRedemptionPoint examples: '1': summary: Success value: response_code: 0 response_message: Success payload: cardAccountId: CAVBMRFE8 companyId: CEK7T1WMC6 companyName: Vikram Singh creditLimit: 0 dynamicLimit: 0 usedCreditLimit: -990553.44 availableBalance: 898138 availableCardBalance: 92415.44 primaryEnKashCard: enKashCardId: EKCQMY9BQ0 userId: EK8IHN4B cardAccountId: CAVBMRFE8 token: 30acb157bcea5ae6d3b9 maskedNumber: 2004 01XX XXXX XX87 expiryMonth: '08' expiryYear: '2025' email: anay.nagar@enkash.com mobile: '9660686687' title: Mr firstName: Anay lastName: Nagar gender: M usedMtd: 15607.56 usedDtd: 15607.56 usedYtd: 15607.56 otbBalance: 89335.44 primaryCard: true prepaidCard: true physicalCard: false deleted: false closedLoopCard: false createdOn: '2023-08-09 22:30:07' modifiedOn: '2024-08-14 15:49:46' cardStatus: name: UL label: UnLocked kycStatus: name: VERIFIED label: Verified cardProgramme: SBM useAccountFunds: false blockCode: A partnerLogo: https://image.enkash.in/IMAGES/sbm-logo.png physicalDeliveryAddressFlag: false cardActivated: true binType: name: REWARD label: Reward Card loadAmount: 999 companyId: CEK7T1WMC6 cardKitMasterId: 11 extEntityId: EXTGY8V5YQI6X switchProvider: EK_CLOSEDLOOP_CREDIT accountBalance: 898138 physicalCardAllowed: false kitType: name: VISA label: Visa surchargeAmt: 0 panValidated: false usedLtd: 15607.56 latestTnCVersionAccepted: true latestKeyFactAccepted: true latestTnCVersionAcceptedForPrimaryCard: true latestKeyFactAcceptedCardForPrimaryCard: true virtualAccountNumber: ENKASHEDENKEKCQMY9BQ0 limitAllocatedLtd: 103694 posAllowed: false posAllowedAdmin: false atmAllowed: false atmAllowedAdmin: false onlineAllowed: false onlineAllowedAdmin: false liveImage: false unallocateFundAllowed: true useParentFundAllowed: false minKycOtpVerified: false enKashSupportEmail: support@enkash.com enKashSupportMobile: '1234567890' companyName: Vikram Singh accountType: name: EMPLOYEE_REWARDS label: Employee Rewards description: Reward lastAllocatedAmount: 10 holdBalance: 0 unAllocateHoldBalance: 0 tncUnAllocateAllowed: false tncUnAllocateAccepted: false totalRewardsReceived: 79 rewardPointsReceived: 121791.28 ckycEnabled: false vkycAllowed: false prepaidCard: true blockCode: A createdOn: '2023-08-09 11:19:46' modifiedOn: '2024-08-14 15:49:46' totalCards: 34 activeCards: 34 ctdDebit: 27759.84 ctdCredit: 8175.28 madIndicator: M planMasterId: PM1QOIQS6 totalDebits: 132086.2 totalCredits: 129081.28 currentMonthDebits: 720 currentMonthCredits: 20 partnerLogo: https://image.enkash.in/IMAGES/sbm-logo.png cardProgramme: SBM binType: REWARD autoAllocateCardKit: true kitType: name: VISA label: Visa accountType: name: EMPLOYEE_REWARDS label: Employee Rewards accountTitle: Vikram Singh - Reward closedLoopCard: false usedMtd: 11146.4 usedDtd: 11146.4 usedMtdCount: 57 usedDtdCount: 57 showBulkUpload: false physicalCardAllowed: false autoFundingDisabled: false ifscCode: KKBK0000958 bankName: Kotak Mahindra Bank virtualAccountNumber: ENKAAXECENKCAVBMRFE8 nachStatus: INACTIVE tenantSync: true subAssetClassCode: SMA 0 plan: Rewards program: SBM programFunding: PREPAID cardRelationShipId: CRSENKWQIALRW nachRestrictionOverridden: false nachRestrictionStatus: RESTRICTION_NOT_APPLICABLE totalAllocationPoint: 107900 totalRedemptionPoint: 23004.92 currentMonthAllocationPoint: 20 currentMonthRedemptionPoint: 700 planAutoLoadingEnabled: false autoAllocateFunds: false planEnableHoldAmount: false enableHoldAmount: false downloadCardData: false bulkAllocateAllowed: false virtualAccountHolderName: Nehat Tech Solutions Pvt Limited refundToSource: false totalOtherRewards: 92 totalRewards: 120 totalOccasionRewards: 9 totalPerformanceRewards: 19 creditLimitUpdate: false dpd: '0' '2': summary: Exception for invalid Card account Id/ Company ID provided value: response_code: 1 response_message: >- Card account not found for companyId: CEK7T1WMC4 and cardAccountId: CAVBMRFE8 payload: >- Card account not found for companyId: CEK7T1WMC4 and cardAccountId: CAVBMRFE8 headers: {} x-apidog-name: Success security: [] x-apidog-folder: Rewards & Incentives/APIs - Reward/Reward Allocation x-apidog-status: developing x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-9796909-run components: schemas: {} securitySchemes: {} servers: - url: https://ekpayout-uat.enkash.in description: Testing Env security: [] ```