v1

latestOpenAPI 3.1.02026-07-24680631.6 KB

Generate Quote

The Generate Quote API allows the user to Generate a quote for a transaction based on the Student and Beneficiary selected

post/v1/client/transaction/generate-quote

Headers

api-keystring required

API Key

auth-keystring required

The Auth Key via the Generate Auth Key API

userIdstring required

User Id as generated via the "Create Account (sign-Up) API". Identifier of an individual user, you can map this to the User identification at your end.

Request body

inputCurrencystring required

The currency in which the amount is collected from the application user.

amountstring required

The amount in the inputCurrency

fromCurrencystring required

Currency in which remittence is sent (Will always be INR, for LRS transactions)

toCurrencystring required

Currency in which remittence is received by the Beneficiary (Beneficiary's Currency)

bankIdstring required

Remitter's bank ID

beneBankIdstring required

Beneficiary's Bank ID

studentIdstring required

ID of the student the remittence is being made for

purposeIdstring required

Purpose Id from GET Purpose List API, as appropriate for the transaction quote is generated for

haveEducationLoanboolean

Flag to indicate the source of funds are from an Education loan (This impacts the docs to be collected and TCS on the transaction)

Response

200

statusinteger

messagestring

Example response

{
  "status": 200,
  "message": "Success",
  "data": {
    "transactionId": "ER3973402",
    "amount": 10000,
    "exType": "source",
    "fromCurrency": "INR",
    "toCurreny": "USD",
    "exRate": 0.011705,
    "expiry": "2024-03-17T04:58:23Z",
    "gstAmt": 45,
    "totalAdditionalAmount": 45,
    "finalFromAmount": 10045
  }
}