API LibraryForex Card Holder Load

Filter Forex Card Holder Loads by Criteria

Advanced search for forex card holder load records with complex filter criteria. Supports filtering by date range, status, hierarchy, transaction type, and custom fields.

Authorization

bearerAuth tenantId

AuthorizationBearer <token>

In: header

X-TENANT-ID<token>

In: header

Query Parameters

pageNo?integer

Default0

pageSize?integer

Default10

Header Parameters

X-TENANT-ID*string

Your unique tenant identifier

Request Body

application/json

filters?

sortField?string

Field to sort by

sortOrder?string

Value in"ASC" | "DESC"

Response Body

`application/json`

`application/json`

curl -X POST "https://sandbox-api.m2pprepaid.com/prepaid/corporate/v1/forex/card-holder-loads/filter/fetch-by-criteria" \  -H "X-TENANT-ID: ACME_CORP" \  -H "Content-Type: application/json" \  -d '{    "filters": [      {        "field": "currentStatus",        "operator": "EQUALS",        "value": "APPROVED"      },      {        "field": "transactionType",        "operator": "EQUALS",        "value": "CREDIT"      }    ],    "sortField": "createdDate",    "sortOrder": "DESC"  }'

{
  "result": {},
  "pagination": {}
}

{
  "type": "https://www.m2pfintech.com/problem/problem-with-message",
  "title": "Bad Request",
  "status": 400,
  "detail": "Unable to convert http message",
  "message": "error.http.400"
}

Fetch Forex Card Holder Loads by Status GET

Retrieves forex card holder loads filtered by processing status and hierarchy ID. Use the optional `transactionType` parameter to further filter by CREDIT or DEBIT. ### Status Values | Status | Description | |--------|-------------| | `CREATED` | Pending approval | | `APPROVED` | Approved and processed | | `REJECTED` | Rejected by checker | | `FAILED` | Processing failed |

Create Forex Card Issuance POST

Creates a new forex card issuance request with initial currency load. This is the primary endpoint for issuing forex travel cards. ### Pre-Requisite Steps (must be completed before calling this API) 1. **De-Dupe Check** — Verify no duplicate PAN/mobile exists 2. **AML Match** — Clear the customer through AML screening 3. **Limit Check** — Validate LRS limits 4. **Fetch TCS** — Get the TCS amount 5. **Conversion Rate** — Get live forex rate for each currency 6. **Fee Summary** — Get itemized fees (from Forex Rates API) ### Key Fields - `beneficiaries`: Customer details including passport, address, KYC documents - `walletAmount`: Currency loads with conversion details from rate API - `summary`: Fee breakdown from the fee summary API - `trip`: Travel details (destination, dates, purpose) - `funding`: Source of funds (bank account details) - `declarations`: Regulatory declarations (FATCA, LRS, T&C) ### Compliance Documents - **Passport**: Mandatory for all forex issuances - **Visa**: Required for travel-related issuances - **Air Ticket**: Required for travel - **A2 Form**: RBI declaration form - **Purpose Proof**: Required for education/medical purpose