Calculate Forex Fee Summary
Calculates and returns a detailed fee breakdown for forex card operations. Use this API to preview all applicable fees, taxes, and the total payable amount before initiating an issuance, load, or reload transaction.
How It Works
- Specify which fee types to include (issuance, load, reload, etc.) using boolean flags
- Provide the hierarchy ID (your corporate/branch identifier) and product details
- The API calculates all applicable fees based on your configured fee structure
- Returns a comprehensive breakdown including net value, fees, taxes, TCS, and total amount
Key Business Rules
- Fee structures are configured per hierarchy (corporate/branch level)
- Product type and load amount affect the fee calculation
- Promotional codes can modify fee structures if configured
- Fee waiver flag allows authorized users to waive fees for specific transactions
- Conversion GST is calculated on the forex markup and returned separately
Common Use Cases
| Scenario | Flags to Set |
|---|---|
| New card issuance with initial load | issuanceFeeApplied=true, loadFeeApplied=true, conversionGstApplied=true |
| Subsequent reload | reLoadFeeApplied=true, conversionGstApplied=true |
| Card replacement | cardReplacementFeeApplied=true |
| Card closure with pullback | cardClosureFeeApplied=true, pullbackFeeApplied=true |
Authorization
bearerAuth tenantId JWT Bearer token obtained from the Authentication API. Include in the
Authorization header as: Bearer <your-token>
In: header
Your unique tenant identifier assigned during onboarding
In: header
Header Parameters
Your unique tenant identifier assigned during partner onboarding. This determines your fee configuration, product catalog, and hierarchy structure.
Request Body
application/json
Fee calculation request specifying which fee components to include and the product/hierarchy details for fee lookup.
Set to true to include the one-time card issuance fee in the calculation.
Applicable when issuing a new forex card.
Set to true to include the initial load fee. Applicable when loading currency
onto a newly issued card for the first time.
Set to true to include the reload fee. Applicable for subsequent currency loads
after the initial issuance load.
Set to true to include the backup card fee. Applicable when issuing a secondary
backup card alongside the primary forex card.
Set to true to include the pullback fee. Applicable when reversing a load transaction
or pulling back remaining balance from the card (e.g., during card surrender).
Set to true to include the card replacement fee. Applicable when replacing a
lost, stolen, or damaged forex card with a new one.
Set to true to include the GST on currency conversion markup. This is the tax
charged on the forex conversion spread/margin. Typically set to true for all
transactions involving currency conversion.
Set to true to include the card closure fee. Applicable when the cardholder
surrenders/closes the forex card permanently.
Contains the hierarchy (corporate/branch) and product details used to look up the applicable fee structure. Fee structures are configured at the hierarchy level during partner onboarding.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://sandbox-api.m2pprepaid.com/prepaid/corporate/v1/forex/summary/fee" \ -H "X-TENANT-ID: ACME_FOREX" \ -H "Content-Type: application/json" \ -d '{ "issuanceFeeApplied": true, "loadFeeApplied": true, "reLoadFeeApplied": false, "backupCardFeeApplied": false, "pullbackFeeApplied": false, "cardReplacementFeeApplied": false, "conversionGstApplied": true, "cardClosureFeeApplied": false, "feeDto": { "hierarchyId": "CORP_001", "type": "Corporate", "feeWaiver": false, "products": [ { "productId": "FOREX_USD_CARD", "loadAmount": 85000, "type": "Forex" } ] } }'Complete fee breakdown for a new forex card issuance with initial load of 85,000 in local currency
{
"result": {
"issuanceFeeResponseDto": {
"netValue": 85000,
"totalFees": 200,
"taxAmount": 36,
"totalAmount": 85236,
"totalTaxAndFees": 236,
"gstPercentage": 18
},
"loadFeeResponseDto": {
"netValue": 85000,
"totalFees": 150,
"taxAmount": 27,
"totalAmount": 85177,
"totalTaxAndFees": 177,
"gstPercentage": 18
},
"reLoadFeeResponseDto": null,
"backupCardFeeResponseDto": null,
"pullbackFeeResponseDto": null,
"cardReplacementFeeResponseDto": null,
"cardClosureFeeResponseDto": null,
"conversionGst": 45,
"netValue": 85000,
"totalFees": 350,
"taxAmount": 108,
"totalAmount": 85458,
"totalTaxAndFees": 458,
"tcsAmount": 4250
},
"pagination": null
}{
"type": "https://www.m2pfintech.com/problem/problem-with-message",
"title": "Bad Request",
"status": 400,
"detail": "hierarchyId: must not be blank",
"message": "error.http.400"
}The hierarchy ID provided does not exist in the system
{
"type": "https://www.m2pfintech.com/problem/problem-with-message",
"title": "Corporate/Branch does not exist for id: INVALID_123",
"status": 409,
"detail": "Corporate/Branch does not exist for id: INVALID_123",
"message": "error.business",
"businessCode": "PP_CORP_002"
}{
"type": "https://www.m2pfintech.com/problem/problem-with-message",
"title": "Internal Server Error",
"status": 500,
"detail": "An unexpected error occurred while calculating fees",
"message": "error.http.500"
}Upload Dispute Document POST
Uploads a supporting document for an existing dispute. Accepts file uploads via multipart form data. ### Supported File Types - PDF, JPEG, PNG - Maximum file size: 10 MB
Fetch Multi FX Rates POST
Retrieves conversion rates for multiple wallet currencies in a single call. Use this when loading a forex card with multiple currencies (e.g., USD + EUR + GBP) to get all rates at once. ### Request - Provide a list of wallet names in `walletList` - Specify `amount` for rate calculation - Use `fundMode` to indicate LOAD, RELOAD, or REFUND ### Response Returns an array of conversion rate objects, one per wallet currency.